Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Webhook Destination

Update a webhook destination

Update certain configs for a webhook destination. The changes will only take effect a few seconds after this endpoint returns.

The URL of a webhook destination cannot be changed. Use Create a webhook destination instead.

Permissions

This endpoint requires the following permissions:

  • Webhook:UpdateWebhookDestination for the webhook destination.
post/v1/{organization}/webhook_destination/{webhook_destination_id}

Path parameters

webhook_destination_idstring required

The identifier of the webhook destination to update.

The identifier of the webhook destination to update.

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

retry_attemptsinteger nullable

The number of attempts to retry sending the webhook event in case of failure. If not specified, this field is not updated.

accepted_typesWebhookType[] nullable

A list of webhook types to receive. If not specified, this field is not updated.

Response

Succeeded.