Webhook Destinations

List webhook destinations

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

totalany ofOptional

integerOptional

or

nullOptional

422

Validation Error

application/json

429

Rate limited

get

/v1/{workspace_id}/webhook-destinations

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/webhook-destinations HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
      "url": "text",
      "field_mapping": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "accepted_event_types": [
        "text"
      ],
      "retry_attempts": 1,
      "is_active": true,
      "created_by": "text",
      "created_at": "2026-05-12T13:04:56.049Z",
      "updated_at": "2026-05-12T13:04:56.049Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create a webhook destination

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

namestring · min: 1 · max: 256Required

descriptionany ofOptional

string · max: 2000Optional

or

nullOptional

trigger_idstring · uuidRequired

field_mappingany ofOptional

or

nullOptional

accepted_event_typesstring[] · max: 50Optional

retry_attemptsinteger · min: 1 · max: 5OptionalDefault: 3

Responses

201

Successful Response

application/json

422

Validation error

429

Rate limited

post

/v1/{workspace_id}/webhook-destinations

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/webhook-destinations HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "name": "text",
  "description": "text",
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "field_mapping": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "accepted_event_types": [
    "text"
  ],
  "retry_attempts": 3
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "field_mapping": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accepted_event_types": [
    "text"
  ],
  "retry_attempts": 1,
  "is_active": true,
  "created_by": "text",
  "created_at": "2026-05-12T13:04:56.049Z",
  "updated_at": "2026-05-12T13:04:56.049Z",
  "secret": "text"
}

Get a webhook destination

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

destination_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

descriptionany ofRequired

stringOptional

or

nullOptional

trigger_idstring · uuidRequired

urlstringRequired

field_mappingany ofRequired

or

nullOptional

accepted_event_typesstring[]Required

retry_attemptsintegerRequired

is_activebooleanRequired

created_byany ofRequired

stringOptional

or

nullOptional

created_atany ofOptional

When the webhook destination was created

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

When the webhook destination was last updated

string · date-timeOptional

or

nullOptional

404

Webhook destination not found

422

Validation Error

application/json

429

Rate limited

get

/v1/{workspace_id}/webhook-destinations/{destination_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/webhook-destinations/{destination_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "field_mapping": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accepted_event_types": [
    "text"
  ],
  "retry_attempts": 1,
  "is_active": true,
  "created_by": "text",
  "created_at": "2026-05-12T13:04:56.049Z",
  "updated_at": "2026-05-12T13:04:56.049Z"
}

Update a webhook destination

put

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

destination_idstring · uuidRequired

Body

application/json

nameany ofOptional

string · min: 1 · max: 256Optional

or

nullOptional

descriptionany ofOptional

string · max: 2000Optional

or

nullOptional

field_mappingany ofOptional

or

nullOptional

accepted_event_typesany ofOptional

string[] · max: 50Optional

or

nullOptional

retry_attemptsany ofOptional

integer · min: 1 · max: 5Optional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

workspace_idstring · uuidRequired

namestringRequired

descriptionany ofRequired

stringOptional

or

nullOptional

trigger_idstring · uuidRequired

urlstringRequired

field_mappingany ofRequired

or

nullOptional

accepted_event_typesstring[]Required

retry_attemptsintegerRequired

is_activebooleanRequired

created_byany ofRequired

stringOptional

or

nullOptional

created_atany ofOptional

When the webhook destination was created

string · date-timeOptional

or

nullOptional

updated_atany ofOptional

When the webhook destination was last updated

string · date-timeOptional

or

nullOptional

404

Webhook destination not found

422

Validation error

429

Rate limited

put

/v1/{workspace_id}/webhook-destinations/{destination_id}

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/webhook-destinations/{destination_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "name": "text",
  "description": "text",
  "field_mapping": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "accepted_event_types": [
    "text"
  ],
  "retry_attempts": 1,
  "is_active": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "field_mapping": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "accepted_event_types": [
    "text"
  ],
  "retry_attempts": 1,
  "is_active": true,
  "created_by": "text",
  "created_at": "2026-05-12T13:04:56.049Z",
  "updated_at": "2026-05-12T13:04:56.049Z"
}

Delete a webhook destination

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

destination_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

429

Rate limited

delete

/v1/{workspace_id}/webhook-destinations/{destination_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/webhook-destinations/{destination_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Rotate the destination's HMAC signing secret

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

destination_idstring · uuidRequired

Responses

200

Successful Response

application/json

secretstringRequired

rotation_expires_atstring · date-timeRequired

404

Webhook destination not found

422

Validation error

429

Rate limited

post

/v1/{workspace_id}/webhook-destinations/{destination_id}/rotate-secret

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/webhook-destinations/{destination_id}/rotate-secret HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "secret": "text",
  "rotation_expires_at": "2026-05-12T13:04:56.049Z"
}

List webhook delivery history

get

Delivery history from the Lakebase entity-event timeline read model.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

destination_idstring · uuidRequired

Query parameters

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

totalany ofOptional

integerOptional

or

nullOptional

422

Validation Error

application/json

429

Rate limited

get

/v1/{workspace_id}/webhook-destinations/{destination_id}/deliveries

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/webhook-destinations/{destination_id}/deliveries HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "event_id": "123e4567-e89b-12d3-a456-426614174000",
      "event_type": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "effective_at": "2026-05-12T13:04:56.049Z",
      "created_at": "2026-05-12T13:04:56.049Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}