Webhooks

Replace webhook subscriptions for an agent

Changed on

Replaces all existing webhook subscriptions for the agent with the provided event types. Any previously configured subscriptions for this agent are deleted before the new ones are created. To add subscriptions without removing existing ones, retrieve current subscriptions first and include them in the request.

post/agent/{agentId}/webhook-subscriptions

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/agent/{agentId}/webhook-subscriptions
  • Auth
    HTTP bearer

Path parameters

agentIdstring required

The ID of the agent to create subscriptions for

Request body

eventTypesstring[] required

Array of event types to subscribe to

webhookIdstring required

The ID of the webhook to subscribe to

Example request

{
  "eventTypes": [
    "post-conversation"
  ],
  "webhookId": "60d0fe4f5311236168a109ca"
}

Response

Subscriptions created successfully

statusboolean
datastring

Success message

Example response

{
  "status": true,
  "data": "Subscriptions created successfully"
}

Changes