REST API
API: Webhooks
Outbound event notifications (standard and Slack-format). All endpoints require authentication unless noted. 6 endpoints.
GET /api/webhooks
Section titled “GET /api/webhooks”List webhooks for workspace
Company admins only, signed in (API keys are refused).
Responses: 200 · 400 · 401 · 403
POST /api/webhooks
Section titled “POST /api/webhooks”Create a webhook
Company admins only, signed in (API keys are refused).
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
url |
string | yes | |
kind |
"generic" | "slack" |
no | |
events |
array of string | yes | |
secret |
string | no | |
headers |
object | no |
Responses: 201 · 400 · 401 · 403 · 409
PUT /api/webhooks/{id}
Section titled “PUT /api/webhooks/{id}”Update a webhook
Company admins only, signed in (API keys are refused).
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | no | |
url |
string | no | |
events |
array of string | no | |
secret |
string | no | |
headers |
object | no | |
isEnabled |
boolean | no |
Responses: 200 · 400 · 401 · 403 · 404
DELETE /api/webhooks/{id}
Section titled “DELETE /api/webhooks/{id}”Delete a webhook
Company admins only, signed in (API keys are refused).
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 204 — No content · 401 · 403 · 404
GET /api/webhooks/{id}/deliveries
Section titled “GET /api/webhooks/{id}/deliveries”List recent deliveries for a webhook
Company admins only, signed in (API keys are refused).
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
integer | no | |
offset |
integer | no |
Responses: 200 · 400 · 401 · 403
POST /api/webhooks/{id}/test
Section titled “POST /api/webhooks/{id}/test”Send a test webhook payload
Company admins only, signed in (API keys are refused).
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 200 · 400 · 401 · 403 · 404