Enable and subscribe webhook

Setting up webhooks involves three steps:

1

Find available webhooks

Use the Get full list of notifications endpoint to retrieve the complete list of notifications available in the Tuum system.

Shell (bash)

curl 'https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTlUMTE6MTk6MTgiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk3NjU1NTh9.-5qHeXjRLUutCE9dRWq8GdXERBHQPZu7tVVCid_iEpQ'

You can find a detailed example in the API cookbook.

2

Enable webhook generation

To enable webhook generation, either use the Enable notification config endpoint to enable it by notification type and channel code or use the Enable notification config by ID endpoint for a specific notification ID.

Shell (bash) enable with notification type and channel code

curl -X PUT 'https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config/enable' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMjBUMDk6MTM6NDAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODk4NDQ0MjB9.kTvdBnTDfx57dgcb6tTo1w2FmfCKUaG7mj8KiHrNO18' \
-H 'Content-Type: application/json' \
-d '{
  "notificationTypeCode": "PERSON_UPDATED",
  "channelCode": "WEBHOOK"
}'

You can find a detailed example in the API cookbook.

Shell (bash) enable with notification ID

curl -L -X PUT 'https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config/ID-1114/enable' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGlpdmEgS2FzdCIsImVtcGxveWVlSWQiOiJJRC0xMDcxIiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTEyLTE4VDEzOjU2OjU0IiwiZXhwIjoxNzY2MDY2MjE0LCJyb2xlcyI6WyJBRE1JTiIsIkRBU0hCT0FSRF9CQUxBTkNFX1ZJRVdFUiIsIlNZU1RFTSJdfQ.1HUIQ2cZsvoC29zfulds1hFznW5O3JeQlvPPaxk0fJk' \
-d ''

You can find a detailed example in the API cookbook.

3

Subscribe to webhook

Use the webhook subscription endpoint to start receiving webhook notifications at the specified URL.

Shell (bash)

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"
}'

You can find a detailed example in the API cookbook.