latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Webhook Destination

Get webhook deliveries

Retrieve the webhook deliveries to a webhook destination.

Permissions

This endpoint may be impacted by the following permissions:

  • Webhook:GetWebhookDeliveries on the webhook deliveries to retrieve.
get/v1/{organization}/webhook_destination/{webhook_destination_id}/delivery

Path parameters

webhook_destination_idstring required

The ID of the webhook destination whose deliveries to retrieve.

The ID of the webhook destination whose deliveries to retrieve.

organizationstring required

Query parameters

status'success' | 'failed'

The status of the webhook delivery.

typestring nullable

The type of the webhook.

The type of the webhook.

created_afterstring date-time nullable

An ISO8601 timestamp in UTC of the earliest creation time of the webhook deliveries to retrieve.

An ISO8601 timestamp in UTC of the earliest creation time of the webhook deliveries to retrieve.

created_beforestring date-time nullable

An ISO8601 timestamp in UTC of the latest creation time of the webhook deliveries to retrieve.

An ISO8601 timestamp in UTC of the latest creation time of the webhook deliveries to retrieve.

limitinteger

The maximum number of webhook deliveries to retrieve.

The maximum number of webhook deliveries to retrieve.

continuation_tokeninteger

The token from the previous request to return the next page of webhook deliveries.

The token from the previous request to return the next page of webhook deliveries.

sort_bystring[]

The fields to sort the sets by. Supported fields are type, status, and created_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

The fields to sort the sets by. Supported fields are type, status, and created_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

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[]

Response

Succeeded.

has_moreboolean required

Whether there are more webhook deliveries to retrieve.

continuation_tokeninteger nullable required

A token to supply to the next request to retrieve the next page of webhook deliveries. Only populated if has_more is True.