Skip to main content
POST
/
agent
/
{agentId}
/
webhook-subscriptions
Create webhook subscriptions for an agent
curl --request POST \
  --url https://atoms-api.smallest.ai/api/v1/agent/{agentId}/webhook-subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventTypes": [
    "post-conversation"
  ],
  "webhookId": "60d0fe4f5311236168a109ca"
}
'
{
  "status": true,
  "data": "Subscriptions created successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agentId
string
required

The ID of the agent to create subscriptions for

Body

application/json
​
eventTypes
enum<string>[]
required

Array of event types to subscribe to

The type of event to subscribe to

Available options:
pre-conversation,
post-conversation
​
webhookId
string
required

The ID of the webhook to subscribe to

Example:

"60d0fe4f5311236168a109ca"

Response

Subscriptions created successfully

​
status
boolean
Example:

true

​
data
string

Success message

Example:

"Subscriptions created successfully"