Search
K
notifications v2

Update Notification Registration

An endpoint that will update a subscriber’s notification registration details

put
https://api.pexa.co.uk/partner/api/notification/v2/notification-registrations/{registrationId}

Query Parameters

subscriberIdstring(uuid)

UUID of the subscriber, for Admins only

Example:38e5d22c-d642-42d1-8064-1182dc87c4e5

Path Parameters

registrationIdstring(uuid)required

UUID of the registration

Example:28e5d78c-d642-42d1-8064-0082dc87c4e5

Body

application/json

Registration details

New registration details, not containing the id attribute

notificationTypestringrequired

The type of notification

Match pattern:^(WEBHOOK|EMAIL)$

Example:WEBHOOK

eventTypesarray[string]required

Through this field, Integrators have the ability to subscribe to a variety of notification types based on their preferences.

Note: A registration must be created with at least one preferred event type and all mandatory event types for successful registration. An email registration can be updated to contain an empty list of event types. A webhook registration must always contain at least one preferred event type and all mandatory event types.

Preferred Webhook Events

  • WORKSPACE_PARTICIPANT_ADDED
  • FINANCIAL_SETTLEMENT_SCHEDULE_PREPARED
  • LODGEMENT_CASE_PREPARED
  • WORKSPACE_PREPARED
  • WORKSPACE_FUNDS_AUTHORISED
  • WORKSPACE_FUNDS_EXCHANGED
  • WORKSPACE_LODGED
  • WORKSPACE_CLOSED
  • WORKSPACE_REQUISITIONED
  • WORKSPACE_CANCELLED
  • WORKSPACE_REVERTED_TO_CREATED
  • TITLE_DATA_RECEIVED
  • TITLE_SEARCH_PENDING
  • TITLE_NOT_FOUND

    • Preferred Email Events
  • LODGEMENT_CASE_REQUISITIONED
  • NETTING_COMPLETED

    • Mandatory Webhook Events
  • SECRET_EXPIRY

    • Response

    application/json

    SUCCESS

    New registration details response, containing id attribute

    notificationTypestringrequired

    The type of notification

    Match pattern:^(WEBHOOK|EMAIL)$

    Example:WEBHOOK

    eventTypesarray[string]required

    The list of eventTypes that this registration will send notifications for

    Example:WORKSPACE_PARTICIPANT_ADDED, LODGEMENT_CASE_REQUISITIONED, WORKSPACE_PREPARED, WORKSPACE_LODGED

    integratorIdstring

    The ID of the integrator

    Example:344a6eb8-1201-4b80-a279-084713e300ef

    integratorTypestring

    The type of the integrator

    Example:BROKER

    registrationIdstring

    The ID of the registration

    Example:28e5d78c-d642-42d1-8064-0082dc87c4e5

    subscriberIdstring

    The ID of the subscriber

    Example:28e5d22c-d642-42d1-8064-1182dc87c4e5

    put/partner/api/notification/v2/notification-registrations/{registrationId}

    Body

    { "notificationType": "EMAIL", "attributes": { "email": "myTeam@Company.com" }, "eventTypes": [ "LODGEMENT_CASE_REQUISITIONED" ] }
     
    application/json

    Delete Webhook or Email Registration

    This API is used to delete the registration details for Webhook or Email notifications

    delete
    https://api.pexa.co.uk/partner/api/notification/v2/notification-registrations/{registrationId}

    Path Parameters

    registrationIdstring(uuid)required

    UUID of the registration

    Response

    The resource has been deleted

    delete/partner/api/notification/v2/notification-registrations/{registrationId}
     

    NotificationRegistrationRequestV2

    object

    New registration details, not containing the id attribute

    notificationTypestringrequired

    The type of notification

    Match pattern:^(WEBHOOK|EMAIL)$

    Example:WEBHOOK

    eventTypesarray[string]required

    Through this field, Integrators have the ability to subscribe to a variety of notification types based on their preferences.

    Note: A registration must be created with at least one preferred event type and all mandatory event types for successful registration. An email registration can be updated to contain an empty list of event types. A webhook registration must always contain at least one preferred event type and all mandatory event types.

    Preferred Webhook Events

  • WORKSPACE_PARTICIPANT_ADDED
  • FINANCIAL_SETTLEMENT_SCHEDULE_PREPARED
  • LODGEMENT_CASE_PREPARED
  • WORKSPACE_PREPARED
  • WORKSPACE_FUNDS_AUTHORISED
  • WORKSPACE_FUNDS_EXCHANGED
  • WORKSPACE_LODGED
  • WORKSPACE_CLOSED
  • WORKSPACE_REQUISITIONED
  • WORKSPACE_CANCELLED
  • WORKSPACE_REVERTED_TO_CREATED
  • TITLE_DATA_RECEIVED
  • TITLE_SEARCH_PENDING
  • TITLE_NOT_FOUND

    • Preferred Email Events
  • LODGEMENT_CASE_REQUISITIONED
  • NETTING_COMPLETED

    • Mandatory Webhook Events
  • SECRET_EXPIRY

    • Example

    EmailNotificationRegistrationRequest

    object
    notificationTypestringrequired

    The type of notification

    Match pattern:^(WEBHOOK|EMAIL)$

    Example:WEBHOOK

    eventTypesarray[string]required

    Through this field, Integrators have the ability to subscribe to a variety of notification types based on their preferences.

    Note: A registration must be created with at least one preferred event type and all mandatory event types for successful registration. An email registration can be updated to contain an empty list of event types. A webhook registration must always contain at least one preferred event type and all mandatory event types.

    Preferred Webhook Events

  • WORKSPACE_PARTICIPANT_ADDED
  • FINANCIAL_SETTLEMENT_SCHEDULE_PREPARED
  • LODGEMENT_CASE_PREPARED
  • WORKSPACE_PREPARED
  • WORKSPACE_FUNDS_AUTHORISED
  • WORKSPACE_FUNDS_EXCHANGED
  • WORKSPACE_LODGED
  • WORKSPACE_CLOSED
  • WORKSPACE_REQUISITIONED
  • WORKSPACE_CANCELLED
  • WORKSPACE_REVERTED_TO_CREATED
  • TITLE_DATA_RECEIVED
  • TITLE_SEARCH_PENDING
  • TITLE_NOT_FOUND

    • Preferred Email Events
  • LODGEMENT_CASE_REQUISITIONED
  • NETTING_COMPLETED

    • Mandatory Webhook Events
  • SECRET_EXPIRY

    • attributesobjectrequired
    Show Child Parameters
    Example

    EmailAttribute

    object
    emailstring(email)required

    The email address of the subscriber

    Example:subscriber@example.com

    Example