Search
K
notifications v1

UpdateNotificationRegistrationRequest

object

Update registration details

webhookURIstringrequired

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

eventTypesarray[string]required

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

Note: Event types list should contain at least one preferred notification and all mandatory notifications for successful registration.

Allowed events list

  • 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
  • SECRET_EXPIRY



    • The list of event types should contain all mandatory events for successful registration.

    Mandatory events list
  • SECRET_EXPIRY

    • Example:WORKSPACE_PARTICIPANT_ADDED, WORKSPACE_PREPARED, WORKSPACE_LODGED, SECRET_EXPIRY

    Example

    NotificationService500ErrorResponse

    object

    Response object of the service

    errorsarray[object]

    Default:[]

    Show Child Parameters
    Example

    NotificationService400ErrorResponse

    object

    Response object of the service

    errorsarray[object]

    Default:[]

    Show Child Parameters
    Example

    NotificationService401ErrorResponse

    object

    Response object of the service

    errorsarray[object]

    Default:[]

    Show Child Parameters
    Example

    NotificationService403ErrorResponse

    object

    Response object of the service

    errorsarray[object]

    Default:[]

    Show Child Parameters
    Example