---
title: "NotificationRegistrationDto"
url: "https://developer.pexa.co.uk/apis/notifications-v1-v1/versions/72a6ef34-73d4-4940-b586-d4154e57aaea/schemas/NotificationRegistrationDto"
---

> Full API specification: https://developer.pexa.co.uk/apis/notifications-v1-v1/versions/72a6ef34-73d4-4940-b586-d4154e57aaea.md

# NotificationRegistrationDto

New registration details, containing `id` attribute

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Notification Service - V1 APIs
  version: v1
servers:
  - url: https://api.pexa.co.uk
    description: API Gateway URL
components:
  schemas:
    NotificationRegistrationDto:
      description: New registration details, containing `id` attribute
      type: object
      required:
        - webhookURI
        - registrationId
      properties:
        webhookURI:
          type: string
          description: The secure URI of the webhook to be called when an event occurs
            (supports only https protocol)
          example: https://push-notifications.pexa.com.au/notifications-webhook
        registrationId:
          type: string
          description: The registration ID returned by create notification registration API
          example: a12sd23sf4f5f6f9
        subscriberId:
          type: string
          description: The ID of the subscriber
          example: "123456789"
        sharedSecret:
          type: string
          description: The shared secret used to validate the webhook request
          example: 38e5d78c-d642-42d1-8064-0082dc87c4e5
        sharedSecretExpiry:
          type: string
          description: The expiry time for current shared secret
          example: 2025-03-13 04:12:51.574000 +00:00
        eventTypes:
          type: array
          items:
            type: string
          description: The list of eventTypes that this registration will send
            notifications for
          example:
            - WORKSPACE_PARTICIPANT_ADDED
            - WORKSPACE_PREPARED
            - WORKSPACE_LODGED
            - SECRET_EXPIRY
```