...
Webhooks are managed in a self-service fashion via the following set of APIs.
Note |
---|
Each create triggers an immediate "PING" notification (with no retries) to the configured endpoint, and will only be accepted if the PING is succesful |
Search / List Webhooks
Endpoint | api/v1/configuration/webhooks |
---|---|
Request method | GET |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "moreResults": false, "results": [ { "uuid": "56b19ace-1fa9-4346-a97c-f621c5138342", "name": "My Example Webhook", "profileTypes": [ "TRAVELLER", "CORPORATE" ], "eventTypes": [ "CREATE", "UPDATE", "DELETE" ], "url": "https://my.example.com/webhook/notify" } ] } |
Create new Webhook
Note |
---|
Each create triggers an immediate "PING" notification (with no retries) to the configured endpoint, and will only be accepted if the PING is succesful |
Endpoint | api/v1/configuration/webhook |
---|---|
Request method | POST |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "uuid": "c7c769bc-9310-4b29-b27c-f34355ec66b4", "name": "Notify myIntegrationX", "profileTypes": [ "TRAVELLER", "CORPORATE" ], "eventTypes": [ "CREATE", "UPDATE", "DELETE" ], "url": "https://my.example.com/webhook/notify", "secret": { "sensitiveValuePresent": true } } |
Update existing Webhook
To update a Webhook, please delete and re-create it
...