Search
K
notifications v2

NotificationType

string

The type of notification

Match pattern:^(WEBHOOK|EMAIL)$

Example

Email

string

The email address of the subscriber

Example

WebhookURI

string

The webhook URL

Example

NotificationRegistrationResponseV2

object

New 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

Example

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