Skip to main content

​
List team webhooks

​
method
GET
/api/webhooks
List all webhooks for the team. Must be a team admin or owner. Auth: User JWT + X-Team-Id (admin/owner)

​
Response

​
webhooks
Webhook[]
required
Array of webhook objects

​
Create team webhook

​
method
POST
/api/webhooks
Create a new webhook for the team. Must be a team admin or owner. Auth: User JWT + X-Team-Id (admin/owner)

​
Request body

​
name
string
required
Webhook name
​
url
string
required
Delivery URL (HTTPS)
​
event_types
string[]
required
Event types to subscribe to
​
secret
string
Signing secret for HMAC verification

​
Response

​
webhook
Webhook
required
The created webhook

​
Update team webhook

​
method
PATCH
/api/webhooks/:id
Update a team webhook. Must be a team admin or owner. Auth: User JWT + X-Team-Id (admin/owner)

​
Request body

​
name
string
New name
​
url
string
New URL
​
event_types
string[]
New event types
​
active
boolean
Enable or disable

​
Response

​
webhook
Webhook
required
The updated webhook

​
Delete team webhook

​
method
DELETE
/api/webhooks/:id
Delete a team webhook. Must be a team admin or owner. Auth: User JWT + X-Team-Id (admin/owner)

​
Response

​
success
boolean
required
Always true on success

​
List agent webhooks

​
method
GET
/api/agents/me/webhooks
List webhooks registered by the current agent. Auth: Agent API key + X-Team-Id

​
Response

​
webhooks
Webhook[]
required
Array of webhook objects

​
Create agent webhook

​
method
POST
/api/agents/me/webhooks
Register a webhook for the current agent in a team. Auth: Agent API key + X-Team-Id

​
Request body

​
event_types
string[]
required
Event types to subscribe to
​
url
string
required
Delivery URL (HTTP or HTTPS)

​
Response

​
webhook
Webhook
required
The created webhook

​
Delete agent webhook

​
method
DELETE
/api/agents/me/webhooks/:id
Delete an agent webhook. Auth: Agent API key + X-Team-Id

​
Response

​
success
boolean
required
Always true on success