API Preview - This API is under active development. Endpoints may change without notice.
DevelopersEndpoints
Endpoint Details
POST /webhooks/
POST
/webhooks/JWTRegister a new HTTPS endpoint to receive webhook event notifications. Requires org_admin role.
Request Example
json
{
"url": "https://ats.example.com/webhooks/alter",
"events": [
"match.proposed",
"match.accepted",
"attestation.issued"
],
"secret": "whsec_abc123..."
}Response
json
{
"id": "w1h2k3s4-u5b6-7890-abcd-ef1234567890",
"org_id": "e1f2a3b4-c5d6-7890-efab-cdef12345678",
"url": "https://ats.example.com/webhooks/alter",
"events": [
"match.proposed",
"match.accepted",
"attestation.issued"
],
"is_active": true,
"failure_count": 0,
"created_at": "2026-03-10T10:00:00Z"
}GET /webhooks/
GET
/webhooks/JWTList all webhook subscriptions for the authenticated organisation. Cursor-paginated.
GET /webhooks/events
GET
/webhooks/eventsJWTReturns the list of event types that can be subscribed to: placement.created, placement.updated, attestation.issued, attestation.revoked, match.proposed, match.accepted, match.declined.
Response
json
{
"events": [
"placement.created",
"placement.updated",
"attestation.issued",
"attestation.revoked",
"match.proposed",
"match.accepted",
"match.declined"
]
}GET /webhooks/{subscription_id}
GET
/webhooks/{subscription_id}JWTRetrieve details for a single webhook subscription.
Path Parameters
| Name | Type | Description |
|---|---|---|
subscription_id* | string | Subscription UUID |
PATCH /webhooks/{subscription_id}
PATCH
/webhooks/{subscription_id}JWTUpdate the URL, subscribed events, or active status.
Path Parameters
| Name | Type | Description |
|---|---|---|
subscription_id* | string | Subscription UUID |
DELETE /webhooks/{subscription_id}
DELETE
/webhooks/{subscription_id}JWTDelete a webhook subscription and its delivery history. Returns 204 No Content.
Path Parameters
| Name | Type | Description |
|---|---|---|
subscription_id* | string | Subscription UUID |
POST /webhooks/{subscription_id}/test
POST
/webhooks/{subscription_id}/testJWTDispatch a synthetic test event to verify connectivity and signature validation.
Path Parameters
| Name | Type | Description |
|---|---|---|
subscription_id* | string | Subscription UUID |
GET /webhooks/{subscription_id}/deliveries
GET
/webhooks/{subscription_id}/deliveriesJWTPaginated list of delivery attempts for a subscription.
Path Parameters
| Name | Type | Description |
|---|---|---|
subscription_id* | string | Subscription UUID |
Query Parameters
| Name | Type | Description |
|---|---|---|
limit | integer | Page size (max 100) |
cursor | string | Pagination cursor |