Search
K
notifications v1

Notification Service - V1 APIs

v1OAS 3.1

Notification Service V1 APIs for managing webhook notifications and registrations.

API Base URL
  • Server 1:https://api.pexa.co.uk

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • create:notification_registrations - Create notification registrations
  • edit:notification_registrations - Edit notification registrations
  • delete:notification_registrations - Delete notification registrations
  • create:notification_registrations_secret_rotation - Create notification registrations secret rotation
  • view:notifications - View notifications
  • create:notification_retry - Retry a notification
  • create:webhook_domains - Whitelist a webhook domain

WebhooksRegistration

This API is used to manage registration details for Webhook notifications

Create Webhooks Registration

This API is used to create the registration details for Webhook notifications

post
https://api.pexa.co.uk/partner/api/notification/v1/notification-registrations

Body

application/json

Registration details

New registration details, not containing the id attribute

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

    Response

    application/json

    SUCCESS

    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

    post/partner/api/notification/v1/notification-registrations

    Body

    { "webhookURI": "https://push-notifications.pexa.com.au/notifications-webhook", "eventTypes": [ "WORKSPACE_PARTICIPANT_ADDED", "WORKSPACE_PREPARED", "WORKSPACE_LODGED", "SECRET_EXPIRY" ] }
     
    application/json