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

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

# CreateNotificationRegistrationRequest

New registration details, not containing the `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:
    CreateNotificationRegistrationRequest:
      description: New registration details, not containing the `id` attribute
      type: object
      required:
        - webhookURI
        - eventTypes
      properties:
        webhookURI:
          type: string
          description: >
            The secure URI of the webhook to be called when an event occurs
            (supports only https protocol)


            To ensure a smoother integration, avoid using endpoints that end
            with slashes, as these trailing slashes will be automatically
            removed from the URI.
          example: https://push-notifications.pexa.com.au/notifications-webhook
        eventTypes:
          type: array
          items:
            type: string
          description: >-
            Through this field, Integrators have the ability to subscribe to a
            variety of notification types based on their preferences. <br></br>
            Note: A registration must be created with at least one preferred
            event type and all mandatory event types for successful
            registration. <br></br> Preferred Webhook
            Events  <li>WORKSPACE_PARTICIPANT_ADDED</li>
            <li>FINANCIAL_SETTLEMENT_SCHEDULE_PREPARED</li>
            <li>LODGEMENT_CASE_PREPARED</li>
            <li>LODGEMENT_CASE_PARTIALLY_REGISTERED</li>
            <li>LODGEMENT_CASE_REGISTRATION_REJECTED</li>
            <li>WORKSPACE_PREPARED</li> <li>WORKSPACE_FUNDS_AUTHORISED</li>
            <li>WORKSPACE_FUNDS_EXCHANGED</li> <li>WORKSPACE_LODGED</li>
            <li>WORKSPACE_CLOSED</li> <li>WORKSPACE_REQUISITIONED</li>
            <li>WORKSPACE_CANCELLED</li> <li>WORKSPACE_REVERTED_TO_CREATED</li>
            <li>TITLE_DATA_RECEIVED</li> <li>TITLE_SEARCH_PENDING</li>
            <li>TITLE_NOT_FOUND</li>

            Mandatory Webhook Events  <li>SECRET_EXPIRY</li>
          example:
            - WORKSPACE_PARTICIPANT_ADDED
            - WORKSPACE_PREPARED
            - WORKSPACE_LODGED
            - SECRET_EXPIRY
```