Subscribe webhook

Use case

Here you can learn how to subscribe to webhooks.

Use case data	API parameters with values
Subscribing webhook: with content version 1 for PERSON_UPDATED to be received in the destination https://webhook.site/00563ca5-867d-42ab-95ee-06533378edb8	{ "url": "https://webhook.site/00563ca5-867d-42ab-95ee-06533378edb8", "version": 1, "notificationTypeCode": "PERSON_UPDATED" }

Sample API call

To subscribe to the webhook, make the API call below:

https://notification-api.sandbox.tuumplatform.com/api/v1/notifications/subscribe

Learn more about the endpoint in the Tuum developer portal.

Sample request

Here is a sample request for subscribing to the webhook:

JSON

{
  "url": "https://webhook.site/00563ca5-867d-42ab-95ee-06533378edb8",
  "version": 1,
  "notificationTypeCode": "PERSON_UPDATED"
}

cURL

curl 'https://notification-api.sandbox.tuumplatform.com/api/v1/notifications/subscribe' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjBUMTI6MzE6MzYiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk4NTYyOTZ9.5wpIHgr2S9m8AMcdNI0SlNAveV_MF3iNNpERZ5SOhcM' \
-H 'Content-Type: application/json' \
-d '{
  "url": "https://webhook.site/00563ca5-867d-42ab-95ee-06533378edb8",
  "version": 1,
  "notificationTypeCode": "PERSON_UPDATED"
}'

Sample response

Below you will find the response body to the sample request:

Response

{}

Result

We have subscribed to the webhook for notification type PERSON_UPDATED.

You can validate the API call's outcome with the request: GET api/v1/notifications/subscriptions. You should see the subscribed webhook in the list.