Use case

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

Sample API call

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

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

Sample request

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

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

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

Sample response

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

{}

Result

The API call was successful and now notifications of the type PERSON_UPDATED with ID-1114 are not generated as it is now disabled ("enabled":false).

Use case

Here you will find instructions on how to deactivate notifications for webhooks with a specific notification ID.

Sample API call

To deactivate notifications by notification ID, make the API call below:

Disables the generation of notifications for events based on the notification ID.

Sample request

Here is a sample request for disabling the generation of notifications for events based on the notification ID:

Sample response

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

Result

The API call was successful and now notifications of the type PERSON_UPDATED with ID-1114 are not generated as it is now disabled ("enabled":false).

Use case

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

Sample API call

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

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

Sample request

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

Sample response

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

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).

Use case

Here you will find instructions on how to activate notifications for webhooks with the notification ID.

Sample API call

To activate notifications by notification ID, make the API call below:

Enables the generation of notifications for events based on the notification ID.

Sample request

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

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

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:

{}

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).

Here you will find instructions on how to activate/deactivate notifications for webhooks.

Activate notifications

You can activate notifications by using the following parameters:

Deactivate notifications

You can deactivate notifications by using the following parameters: