Search
K
notifications v1

NotificationRegistrationDto

object

New registration details, containing id attribute

webhookURIstringrequired

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

registrationIdstringrequired

The registration ID returned by create notification registration API

Example:a12sd23sf4f5f6f9

subscriberIdstring

The ID of the subscriber

Example:123456789

sharedSecretstring

The shared secret used to validate the webhook request

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

sharedSecretExpirystring

The expiry time for current shared secret

Example:2025-03-13 04:12:51.574000 +00:00

eventTypesarray[string]

The list of eventTypes that this registration will send notifications for

Example:WORKSPACE_PARTICIPANT_ADDED, WORKSPACE_PREPARED, WORKSPACE_LODGED, SECRET_EXPIRY

Example

NotificationSecretRotationDto

object

New shared secret details, containing shared_secret attribute

expirystringrequired

The time until which the shared secret is valid

Example:2024-02-28T06:12:42Z

sharedSecretstringrequired

The shared secret used to validate the webhook request

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

Example

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: A registration must be created with at least one preferred event type and all mandatory event types for successful registration.

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

    • Mandatory Webhook Events
  • SECRET_EXPIRY

    • Example:WORKSPACE_PARTICIPANT_ADDED, WORKSPACE_PREPARED, WORKSPACE_LODGED, SECRET_EXPIRY

    Example

    Error

    object

    Detailed error related to the API

    codestring

    The error code.

    • GA.LODGE.??? - Subscriber profile has been suspended or terminated

    Example:GA.LODGE.001

    Example

    NotificationEvent

    object
    notificationIdstring(uuid)

    The unique ID(UUID) for each notification message(aka ‘event’)

    subscriberIdstring

    The ID of the subscriber (can be UUID or just integer)

    Example:123456789

    attemptsarray[object]

    The array of attempts for each notification

    Show Child Parameters
    Example