Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Webhook Destination

Create a webhook destination

Create a new webhook destination. At most 10 webhook destinations can be defined per organization.

A secret will immediately be issued for the webhook destination. Every webhook sent to this destination will be signed using this secret. This secret is one-view only and cannot be retrieved later.

Permissions

This endpoint requires the following permissions:

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

Path parameters

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

urlstring uri required

The URL to which the webhook will be sent. The URL must be in HTTPS.

accepted_typesWebhookType[] required

A list of webhook types to receive.

retry_attemptsinteger

The number of attempts to retry sending the webhook event in case of failure.

Response

Succeeded.

webhook_destination_idstring required

The ID of the created webhook destination.

secretstring required

The secret used to sign the webhook event. This is only visible once and cannot be retrieved later.