Enable with notification type and channel code

Use case

Here you will find instructions on how to activate notifications for webhooks with the notification type and channel code.

Use case data	API parameters with values
Enabling the notification type PERSON_UPDATED for channel WEBHOOK	{ "notificationTypeCode": "PERSON_UPDATED", "channelCode": "WEBHOOK" }

Sample API call

To activate notifications by notification type and channel code, make the API call below:

https://notification-api.sandbox.tuumplatform.com/api/v1/notification-config/enable

Enables the generation of notifications for events based on the notification type and channel code.

Learn more about the endpoint in the Tuum developer portal.

Sample request

Here is a sample request for enabling the generation of notifications for events based on the notification type and channel code:

JSON

{
  "notificationTypeCode": "PERSON_UPDATED",
  "channelCode": "WEBHOOK"
}

cURL

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

Sample response

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

Response

{}

Result

The API call was successful and now notifications of the type PERSON_UPDATED can be generated through the WEBHOOK channel as it is now enabled ("enabled":true).

You can validate the API call's outcome with the request: GET api/v1/notification-config