Skip to main content
POST
/
agents
/
{id}
/
webhooks
Create Agent Webhook
curl --request POST \
  --url https://api.tess.im/agents/{id}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "method": "<string>",
  "status": "<string>"
}
'

​
Code Examples

curl --request POST \
  --url 'https://api.tess.im/agents/{id}/webhooks' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/webhook",
    "method": "POST",
    "status": "active"
  }'

​
Headers

​
x-workspace-id
integer
ID of the workspace. If not provided, the user’s selected workspace will be used.
Note: This field will be required in a future release of the API. It is highly recommended to set it now to ensure compatibility with future updates.

​
Path Parameters

​
id
integer
required
The agent ID

​
Body Parameters

​
url
string
required
The URL that will receive webhook notifications
​
method
string
required
The HTTP method to use for the webhook (POST)
​
status
string
The status of the webhook (active or inactive)

​
Response

{
"template_id": 8794,
"user_id": 0,
"url": "https://webhook.site/3bea4d55-0734-4bbd-aab9-95639585e539",
"method": "POST",
"status": "active",
"updated_at": "2025-01-05T23:35:20.000000Z",
"created_at": "2025-01-05T23:35:20.000000Z",
"id": 18
}