registrationIdstringrequired
UUID of the registration
Update Webhooks Registration
This API is used to update the existing registration details for Webhook notifications
put
https://api.pexa.co.uk/partner/api/notification/v1/notification-registrations/{registrationId}
Path Parameters
Body
application/json
Body
application/json
Registration details
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
The list of event types should contain all mandatory events for successful registration.
Mandatory events list
Example:WORKSPACE_PARTICIPANT_ADDED, WORKSPACE_PREPARED, WORKSPACE_LODGED, SECRET_EXPIRY
Response
application/json
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
put/partner/api/notification/v1/notification-registrations/{registrationId}
Authentication
Path Parameters
Body
{
"webhookURI": "https://push-notifications.pexa.com.au/notifications-webhook",
"eventTypes": [
[
"WORKSPACE_PARTICIPANT_ADDED",
"WORKSPACE_PREPARED",
"WORKSPACE_LODGED",
"SECRET_EXPIRY"
]
]
}
application/json
Delete Webhooks Registration
This API is used to delete the registration details for Webhook notifications
delete
https://api.pexa.co.uk/partner/api/notification/v1/notification-registrations/{registrationId}
Path Parameters
registrationIdstringrequired
UUID of the registration
Response
Response
The resource has been deleted
delete/partner/api/notification/v1/notification-registrations/{registrationId}
Authentication
Path Parameters
Rotate Webhooks Shared Secret
This API is used to rotate existing shared secret with a new shared secret on the registration id provided for Webhook notifications
post
https://api.pexa.co.uk/partner/api/notification/v1/notification-registrations/{registrationId}/secret-rotation
Path Parameters
registrationIdstringrequired
UUID of the registration
Response
application/json
Response
application/json
SUCCESS
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
post/partner/api/notification/v1/notification-registrations/{registrationId}/secret-rotation
Authentication
Path Parameters
application/json
CreateNotificationRegistrationRequest
objectNew 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: Event types list should contain at least one preferred notification and all mandatory notifications for successful registration.
Allowed events list
The list of event types should contain all mandatory events for successful registration.
Mandatory events list
Example:WORKSPACE_PARTICIPANT_ADDED, WORKSPACE_PREPARED, WORKSPACE_LODGED, SECRET_EXPIRY
Example
NotificationRegistrationDto
objectNew 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