v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Webhooks

Update a webhook notification configuration.

This endpoint will update the webhook configuration

You need the "Create and update webhooks" permission to use this endpoint.

patch/v2/notifications/configurations/webhook/{identifier}

Path parameters

identifierstring required

Identifier of the webhook notification configuration object

Request body

is_activeboolean nullable

This flag sets whether the webhook is active or not. If 'true', Mesh sends updates when the monitored events take place. If 'false', Mesh will not send any updates.

namestring nullable

The name of the webhook configuration.

urlstring url nullable

The client side URL that webhooks should be sent to

Example request

{
  "name": "New Name",
  "url": "https://www.example.org/hooks"
}

Response

Webhook configuration updated successfully

identifierstring uuid required

The identifier of the webhook notification configuration that has been updated

Example response

{
  "identifier": "70f0581a-8d09-4077-8dcc-0d78d3f687e3"
}