Retrieve registration details. If registrationId parameter is provided, returns specified registration details (limit and page parameters values are ignored here). If the registrationId is not provided, the response will include an array of all registrations, sorted from most recently updated to least recently updated.
Optional registration ID to filter results, If registrationId is not provided, returns an array of all registrations ordered by updated_at timestamp in descending order.
Example:28e5d78c-d642-42d1-8064-0082dc87c4e5
UUID of the subscriber, for Admins only
Determines which page of registrations to retrieve
Default:1
>= 1
Number of records per page
Default:10
>= 1<= 20
SUCCESS
A paginated list of notification registrations
New registration details response, containing id attribute
An endpoint that will update a subscriber’s notification registration details
UUID of the subscriber, for Admins only
Example:38e5d22c-d642-42d1-8064-1182dc87c4e5
UUID of the registration
Example:28e5d78c-d642-42d1-8064-0082dc87c4e5
Registration details
New registration details, not containing the id attribute
The type of notification
Match pattern:^(WEBHOOK|EMAIL)$
Example:WEBHOOK
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
SUCCESS
New registration details response, containing id attribute
The type of notification
Match pattern:^(WEBHOOK|EMAIL)$
Example:WEBHOOK
The list of eventTypes that this registration will send notifications for
Example:WORKSPACE_PARTICIPANT_ADDED, LODGEMENT_CASE_REQUISITIONED, WORKSPACE_PREPARED, WORKSPACE_LODGED
The ID of the integrator
Example:344a6eb8-1201-4b80-a279-084713e300ef
The type of the integrator
Example:BROKER
The ID of the registration
Example:28e5d78c-d642-42d1-8064-0082dc87c4e5
The ID of the subscriber
Example:28e5d22c-d642-42d1-8064-1182dc87c4e5
This API is used to delete the registration details for Webhook or Email notifications
UUID of the registration
The resource has been deleted
New registration details, not containing the id attribute
The type of notification
Match pattern:^(WEBHOOK|EMAIL)$
Example:WEBHOOK
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
The type of notification
Match pattern:^(WEBHOOK|EMAIL)$
Example:WEBHOOK
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