Search
K
notifications v2

WebhookNotificationRegistrationResponse

object

New webhook registration details response, containing id attribute

notificationTypestringrequired

The type of notification

Match pattern:^(WEBHOOK|EMAIL)$

Example:WEBHOOK

eventTypesarray[string]required

The list of eventTypes that this registration will send notifications for

Example:WORKSPACE_PARTICIPANT_ADDED, LODGEMENT_CASE_REQUISITIONED, WORKSPACE_PREPARED, WORKSPACE_LODGED

integratorIdstring

The ID of the integrator

Example:344a6eb8-1201-4b80-a279-084713e300ef

integratorTypestring

The type of the integrator

Example:BROKER

registrationIdstring

The ID of the registration

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

subscriberIdstring

The ID of the subscriber

Example:28e5d22c-d642-42d1-8064-1182dc87c4e5

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

webhookURIstring(uri)

The webhook URL

Example:https://example.com/webhook

Example

EmailNotificationRegistrationResponse

object

New email registration details response, containing id attribute

notificationTypestringrequired

The type of notification

Match pattern:^(WEBHOOK|EMAIL)$

Example:WEBHOOK

eventTypesarray[string]required

The list of eventTypes that this registration will send notifications for

Example:WORKSPACE_PARTICIPANT_ADDED, LODGEMENT_CASE_REQUISITIONED, WORKSPACE_PREPARED, WORKSPACE_LODGED

integratorIdstring

The ID of the integrator

Example:344a6eb8-1201-4b80-a279-084713e300ef

integratorTypestring

The type of the integrator

Example:BROKER

registrationIdstring

The ID of the registration

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

subscriberIdstring

The ID of the subscriber

Example:28e5d22c-d642-42d1-8064-1182dc87c4e5

emailstring(email)

The email address of the subscriber

Example:subscriber@example.com

Example

ResendRegistrationResponse

object

Response from retry notification operation

notificationIdstring(uuid)required

The notification ID that was retried

Example:c673eb32-82c6-42fc-9c74-54498ce4eb4e

notificationStatusstringrequired

The status of the notification after retry

Allowed values:SENTFAILEDPENDING

Example:SENT

detailsstring

Additional details about the retry operation

Example:Retry successful

Example

PagedNotificationRegistrations

object

A paginated list of notification registrations

pageobjectrequired
Show Child Parameters
recordsarray[object]required

New registration details response, containing id attribute

Show Child Parameters
Example

Page

object
pageintegerrequired

The current page number

totalRecordsintegerrequired

The total number of records available

pageRecordsintegerrequired

The number of records on the current page

limitintegerrequired

The maximum number of records per page

Example