Webhook_destination
Retrieve this organization's webhook destinations.
Permissions
This endpoint may be impacted by the following permissions:
Webhook:GetWebhookDestinationon the webhook destinations to retrieve.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The IDs of the webhook destinations to retrieve.
[]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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/webhook_destination/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"webhook_destinations": [
{
"id": "text",
"url": "text",
"secret_generated_at": "2025-11-13T18:50:35.499Z",
"retry_attempts": 1,
"accepted_types": [
"text"
]
}
]
}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:CreateWebhookDestinationfor the webhook destination.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
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 URL to which the webhook will be sent. The URL must be in HTTPS.
A list of webhook types to receive.
The number of attempts to retry sending the webhook event in case of failure.
3Succeeded.
The organization already has the maximum amount of webhook destinations defined.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/webhook_destination/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"url": "https://example.com",
"accepted_types": [
"text"
],
"retry_attempts": 3
}{
"webhook_destination_id": "text",
"secret": "text"
}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:UpdateWebhookDestinationfor the webhook destination.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The identifier of the webhook destination to update.
^[a-f0-9]{24}$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 number of attempts to retry sending the webhook event in case of failure. If not specified, this field is not updated.
A list of webhook types to receive. If not specified, this field is not updated.
Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization or webhook destination is not found.
Invalid request path parameter or request body failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/webhook_destination/{webhook_destination_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"retry_attempts": 1,
"accepted_types": [
"text"
]
}No content
Remove a webhook destination from the organization. The webhook destination might still be active for a few seconds after this endpoint returns.
Permissions
This endpoint requires the following permissions:
Webhook:DeleteWebhookDestinationfor the webhook destination.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The identifier of the webhook destination to update.
^[a-f0-9]{24}$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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization or webhook destination is not found.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
DELETE /v1/{organization}/webhook_destination/{webhook_destination_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
No content
Rotate the secret of a webhook destination
Replace the secret for the given webhook destination. The new secret will be returned and cannot be retrieved later.
Until the dual_signing_stops_at timestamp in the response, which is roughly 30 minutes after the generation of the new secret, the webhook will be signed by both the old and the new secret. This allows the webhook consumer to transition to the new secret without downtime.
The webhook rotation can occur at most once per hour for each webhook destination.
Permissions
This endpoint requires the following permissions:
Webhook:UpdateWebhookDestinationfor the webhook destination.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The ID for the webhook destination to rotate the secret for.
^[a-f0-9]{24}$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.
[]Succeeded.
The frequency of secret rotation is limited to once per hour.
Invalid authorization credentials.
Missing required permissions.
Specified organization or webhook destination is not found.
Invalid request path parameter failed validation.
The user has exceeded the rate limit of 20 requests per minute for this endpoint.
The service is going through temporary maintenance.
POST /v1/{organization}/webhook_destination/{webhook_destination_id}/rotate-secret HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"secret": "text",
"dual_signing_stops_at": "2025-11-13T18:50:35.499Z"
}Retrieve the webhook deliveries to a webhook destination.
Permissions
This endpoint may be impacted by the following permissions:
Webhook:GetWebhookDeliverieson the webhook deliveries to retrieve.
Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the SignInWithAPIKey endpoint.
An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is making a request for resources in another organization.
The ID of the webhook destination whose deliveries to retrieve.
^[a-f0-9]{24}$The status of the webhook delivery.
The type of the webhook.
An ISO8601 timestamp in UTC of the earliest creation time of the webhook deliveries to retrieve.
An ISO8601 timestamp in UTC of the latest creation time of the webhook deliveries to retrieve.
The maximum number of webhook deliveries to retrieve.
50The token from the previous request to return the next page of webhook deliveries.
0The 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 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.
[]Succeeded.
Invalid authorization credentials.
Missing required permissions.
Specified organization or webhook destination is not found.
Invalid request path parameter or request query parameter failed validation.
The user has exceeded the rate limit of 5 requests per minute for this endpoint.
The service is going through temporary maintenance.
GET /v1/{organization}/webhook_destination/{webhook_destination_id}/delivery HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
X-ORG-ID: YOUR_API_KEY
Accept: */*
{
"webhook_deliveries": [
{
"id": "text",
"type": "text",
"webhook_content": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"status": "success",
"delivery_attempts": [
{
"delivery_time": "2025-11-13T18:50:35.499Z",
"status_code": 1
}
],
"dual_signed": true,
"created_at": "2025-11-13T18:50:35.499Z"
}
],
"has_more": true,
"continuation_token": 1
}Last updated
Was this helpful?