Manage Webhooks

1. Update Audit Log Webhook

This POST method is used to save or update audit log webhooks. A tenant can have multiple webhooks for different notificationMediumIds. If the notificationMediumId already exists, the existing webhook is updated.

Request Example

curl --location --request POST '{{url}}/api/logs/webhooks' \
--header 'Authorization: TOKEN {{apiToken}}'
--data-raw '{
  "notificationMediumId": "string",
  "filter": "string",
  "description": "string"
}'

Response Example 

{
  "notificationMediumId": "string",
  "filter": "string",
  "description": "string"
}

2. Retrieve Audit Log Webhook Details

This GET method is used to retrieve audit log webhook details for the tenant.

Request Example

curl --location --request GET '{{url}}/api/logs/webhooks' \
--header 'Authorization: TOKEN {{apiToken}}'

Response Example 

[
  {
    "notificationMediumId": "string",
    "filter": "string",
    "description": "string"
  }
]

3. Retrieve WebHook Details by Notification Medium ID

This GET method is used to retrieve audit log webhook details specified by notificationMediumId..

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request GET '{{url}}/api/logs/webhooks/{notificationMediumId} \
--header 'Authorization: TOKEN {{apiToken}}

Response Example 

{
  "notificationMediumId": "string",
  "filter": "string",
  "description": "string"
}

4. Delete Audit Log Webhook

This DELETE method deletes an audit log webhook.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location --request DELETE '{{url}}/api/logs/webhooks/{notificationMediumId}' \ --header 'Authorization: TOKEN {{apiToken}}'

Response Example