Webhook Destination
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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": "2026-01-01T00:00:00.000Z",
"retry_attempts": 1,
"accepted_types": [
"text"
]
}
]
}The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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.
The number of attempts to retry sending the webhook event in case of failure.
3Succeeded.
The ID of the created webhook destination.
The secret used to sign the webhook event. This is only visible once and cannot be retrieved later.
The organization already has the maximum amount of webhook destinations defined.
Invalid authorization credentials.
Missing required permissions.
Specified organization is not found.
A related operation is in progress.
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: 107
{
"url": "https://example.com",
"accepted_types": [
"conversation-post-processing-complete"
],
"retry_attempts": 3
}{
"webhook_destination_id": "text",
"secret": "text"
}The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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.
Succeeded.
No content
Invalid authorization credentials.
Missing required permissions.
Specified organization or webhook destination is not found.
A related operation is in progress.
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: 79
{
"retry_attempts": 1,
"accepted_types": [
"conversation-post-processing-complete"
]
}No content
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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.
No content
Invalid authorization credentials.
Missing required permissions.
Specified organization or webhook destination is not found.
A related operation is in progress.
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
The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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 new secret used to sign the webhook event. This is only visible once and cannot be retrieved later. For the next 30 minutes, the webhook will be signed by both the old and the new secret.
A UTC time where the dual-signing behavior stops. After this time, webhooks will only be signed using the new secret from this endpoint.
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.
A related operation is in progress.
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": "2026-01-01T00:00:00.000Z"
}The username should be set to {org_id}_{user_id}, and the password should be the Amigo issued JWT token that identifies the user.
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.
Whether there are more webhook deliveries to retrieve.
A token to supply to the next request to retrieve the next page of webhook deliveries. Only populated if has_more is True.
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": "2026-01-01T00:00:00.000Z",
"status_code": 1
}
],
"dual_signed": true,
"created_at": "2026-01-01T00:00:00.000Z"
}
],
"has_more": true,
"continuation_token": 1
}Last updated
Was this helpful?