...
| Code Block | ||
|---|---|---|
| ||
{
"eventTime": "18.03.2024T09:56:17Z"
"profileType": "TRAVELLER",
"event": "UPDATE",
"uuid": "25b46ba4-0e9e-4baa-83bd-ac21a50ef998",
"company": {
"uuid": "34f277f5-2618-4c9e-aa08-affa9f02dfaa"
"name": "ACME Inc."
}
} |
| Field | Description |
|---|---|
| eventTime | UTC-Timestamp in format "dd.MM.yyyy'T'HH:mm:ss'Z'" of when the event has originally happened |
| profileType | The profile type for which this notification is sent:
|
| event | The notification type:
|
| uuid | The Umbrella Faces UUID of the affected profile |
company .uuid | For profileType TRAVELLER only: UUID + Name of the company currently associated with the traveler profile. |
...
Example: Using the above payload and secret S3cret! one would compute a hash value of bd5c6ea7cbf75262ec0f835213f213b345dd9645624945622555475592def94fof 92649059fe0fc9457cba7b4e80da4fa42ce0528583517da66826c61e75dba624
Delivery
Payloads are delivered via HTTPS POST only. Each notification will be transmitted with an individual POST request without applying any batching logic and without any guaranteed order.
...
In case of an error Umbrella Faces will attempt to re-deliver the the notification up to 5 times over the next 2 hours before silently discarding the notification.
| Note |
|---|
Depending on the number of notifications on our Webhook notification queue, individual notifications might be delayed for a longer time |
Managing Webhooks
Webhooks are managed in a self-service fashion via the following set of APIs.
...
| 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
...
Modify Webhook subscription
Parameters
...
...
...
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -v -X PATCH \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data '{
"name": "Notify myIntegrationX",
"profileTypes": [
"TRAVELLER",
"CORPORATE"
],
"eventTypes": [
"CREATE",
"UPDATE",
"DELETE"
],
"url": "https://my.example.com/webhook/notify",
"secret": {
"value": "MyNewSecret"
}
}' https://hurricane.umbrellanet.ch/uf-test/api/v1/configuration/webhook/c7c769bc-9310-4b29-b27c-f34355ec66b4 |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"uuid": "c7c769bc-9310-4b29-b27c-f34355ec66b4",
"name": "Notify myIntegrationX",
"profileTypes": [
"TRAVELLER",
"CORPORATE"
],
"eventTypes": [
"CREATE",
"DELETE"
],
"url": "https://my.example.com/webhook/notify",
"secret": {
"sensitiveValuePresent": true
}
} |
To update a Webhook, please delete and re-create it
Delete Webhook
| Endpoint | api/v1/configuration/webhook/<uuid> |
|---|---|
| Request method | DELETE |
Remove Webhook subscription
Parameters
Name | Description | Validation |
|---|---|---|
| <uuid> | The UUID of the subscription to be deleted | Required parameter |
...