Webhooks API
Webhooks
GET /orgs/{org}/webhooks
Every webhook.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Responses
200- OK. Paged_Webhook
application/json
POST /orgs/{org}/webhooks
Subscribes a URL to events. The response carries the signing secret once.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Request body
application/json, CreateWebhook.
| Field | Type | Description |
|---|---|---|
events required | string[] | Event types (task.*, page.created, *). |
spaces | string[] | Only these spaces (slugs or ids). |
url required | string | Where to deliver (https in production). |
Responses
201- Created. Webhook
application/json
PATCH /orgs/{org}/webhooks/{id}
Changes a webhook.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
id required | path | string (uuid) | The webhook. |
Request body
application/json, UpdateWebhook.
| Field | Type | Description |
|---|---|---|
active | boolean | null | Delivering. |
events | string[] | null | Event types. |
spaces | string[] | null | Spaces. |
url | string | null | Where to deliver. |
Responses
200- OK. Webhook
application/json
DELETE /orgs/{org}/webhooks/{id}
Deletes a webhook.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
id required | path | string (uuid) | The webhook. |
Responses
204- No content
GET /orgs/{org}/webhooks/{id}/deliveries
Recent deliveries, newest first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
id required | path | string (uuid) | The webhook. |
Responses
200- OK. Paged_Delivery
application/json
POST /orgs/{org}/webhooks/{id}/test
Queues a webhook.test delivery to this webhook only.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
id required | path | string (uuid) | The webhook. |
Responses
202- Accepted. TestDelivery
application/json