Search and manage subscribed webhooks

Use the following endpoints to find and manage your subscribed webhooks.

Search subscribed webhooks

Use the Find all webhook subscriptions endpoint to retrieve the full list of webhooks you are subscribed to in the Tuum system.

Shell (bash)

curl 'https://notification-api.sandbox.tuumplatform.com/api/v1/notifications/subscriptions' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjBUMTE6MjE6MjQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk4NTIwODR9.1v9D9oH3iGaxnQbI12MW6rhWy9vYyrmgk3aYj5AAnPQ' \
-d ''

You can find a detailed example in the API cookbook.

Update webhook subscription

Use the Update webhook subscription endpoint to update an existing webhook subscription with a new destination URL or payload version.

Shell (bash)

curl -X PUT 'https://notification-api.sandbox.tuumplatform.com/api/v1/notifications/subscriptions/ID-1004' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjBUMTM6NTg6MTkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk4NjE0OTl9.XY-A-LL5LfDtibp_KAIEHQDu22GCTpXpLbjlqDQWPVs' \
-H 'Content-Type: application/json' \
-d '{
  "url": "https://webhook.site/b43453ab-6eda-4523-b04d-8b23b3a5d0e6",
  "version": 1,
  "notificationTypeCode": "PERSON_UPDATED"
}'

You can find a detailed example in the API cookbook.

Unsubscribe from webhook

Use the Delete existing webhook subscription endpoint to remove your current webhook subscription.

Shell (bash)

curl -X DELETE 'https://notification-api.sandbox.tuumplatform.com/api/v1/notifications/subscriptions/ID-1004https://notification-api.sandbox.tuumplatform.com/api/v1/notifications/subscriptions/ID-1004m.com/api/v1/notifications/subscriptions/ID-1004' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjBUMTM6NTg6MTkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk4NjE0OTl9.XY-A-LL5LfDtibp_KAIEHQDu22GCTpXpLbjlqDQWPVs' \
-d ''

You can find a detailed example in the API cookbook.

If you unsubscribe from a webhook and do not intend to resubscribe, and the associated notification no longer has any subscribers, you should disable notification generation for it.