subscriberIdstring(uuid)
UUID of the subscriber, for Admins only
Example:38e5d22c-d642-42d1-8064-1182dc87c4e5
Create Notification Registration
An endpoint that will create a subscriber’s notification registration details
post
https://api.pexa.co.uk/partner/api/notification/v2/notification-registrations
Query Parameters
Body
application/json
Body
application/json
Registration details
New registration details, not containing the id attribute
notificationTypestringrequired
The type of notification
Match pattern:^(WEBHOOK|EMAIL)$
Example: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. 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
Preferred Email Events
Mandatory Webhook Events
Response
application/json
Response
application/json
SUCCESS
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
post/partner/api/notification/v2/notification-registrations
Authentication
Query Parameters
Body
{
"notificationType": "EMAIL",
"attributes": {
"email": "myTeam@Company.com"
},
"eventTypes": [
"LODGEMENT_CASE_REQUISITIONED"
]
}
application/json
Get Notification Registrations
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.
get
https://api.pexa.co.uk/partner/api/notification/v2/notification-registrations
Query Parameters
registrationIdstring(uuid)
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
subscriberIdstring(uuid)
UUID of the subscriber, for Admins only
pageinteger
Determines which page of registrations to retrieve
Default:1
>= 1
limitinteger
Number of records per page
Default:10
>= 1<= 20
Response
application/json
Response
application/json
SUCCESS
A paginated list of notification registrations
pageobjectrequired
Show Child Parameters
recordsarray[object]required
New registration details response, containing id attribute
Show Child Parameters
get/partner/api/notification/v2/notification-registrations
Authentication
Query Parameters
application/json
Update Notification Registration
An endpoint that will update a subscriber’s notification registration details
put
https://api.pexa.co.uk/partner/api/notification/v2/notification-registrations/{registrationId}
Query Parameters
subscriberIdstring(uuid)
UUID of the subscriber, for Admins only
Example:38e5d22c-d642-42d1-8064-1182dc87c4e5
Path Parameters
registrationIdstring(uuid)required
UUID of the registration
Example:28e5d78c-d642-42d1-8064-0082dc87c4e5
Body
application/json
Body
application/json
Registration details
New registration details, not containing the id attribute
notificationTypestringrequired
The type of notification
Match pattern:^(WEBHOOK|EMAIL)$
Example: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. 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
Preferred Email Events
Mandatory Webhook Events
Response
application/json
Response
application/json
SUCCESS
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
put/partner/api/notification/v2/notification-registrations/{registrationId}
Authentication
Path Parameters
Query Parameters
Body
{
"notificationType": "EMAIL",
"attributes": {
"email": "myTeam@Company.com"
},
"eventTypes": [
"LODGEMENT_CASE_REQUISITIONED"
]
}
application/json
Delete Webhook or Email Registration
This API is used to delete the registration details for Webhook or Email notifications
delete
https://api.pexa.co.uk/partner/api/notification/v2/notification-registrations/{registrationId}
Path Parameters
registrationIdstring(uuid)required
UUID of the registration
Response
Response
The resource has been deleted
delete/partner/api/notification/v2/notification-registrations/{registrationId}
Authentication
Path Parameters
NotificationRegistrationRequestV2
objectNew registration details, not containing the id attribute
notificationTypestringrequired
The type of notification
Match pattern:^(WEBHOOK|EMAIL)$
Example: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. 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
Preferred Email Events
Mandatory Webhook Events
Example