Webhooks API
Create a webhook endpoint
Endpoint owned by the authenticated application. Endpoints belonging to another application, and cross-plane access, return 404. Returns a server-generated secret exactly once and immediately attempts the signed verification challenge. Authenticate the partner application with HTTP Basic.
POST/v1/developer/webhook-endpoints
Authentication
Requires HTTP Basic application authentication.
Request body
This request body is required.
Endpoint URL, environment, and exact event subscriptions.
| Field | Type | Required | Notes |
|---|---|---|---|
url | string (uri) | Yes | |
events | array | Yes | |
environment | string | No | Allowed: production, test Default: "production" |
concurrency_limit | integer | No | Default: 4 |
The example below includes optional fields for context; only fields marked Yes are always required. Conditional requirements are listed in Notes.
cURL example
curl -X POST https://api.demarky.ai/v1/developer/webhook-endpoints \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"List webhook endpoints
Endpoint owned by the authenticated application. Endpoints belonging to another application, and cross-plane access, return 404. Authenticate the partner application with HTTP Basic.
GET/v1/developer/webhook-endpoints
Authentication
Requires HTTP Basic application authentication.
cURL example
curl -X GET https://api.demarky.ai/v1/developer/webhook-endpoints \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"Get a webhook endpoint
Endpoint owned by the authenticated application. Endpoints belonging to another application, and cross-plane access, return 404. Authenticate the partner application with HTTP Basic.
GET/v1/developer/webhook-endpoints/{endpoint_id}
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
cURL example
curl -X GET https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"Update a webhook endpoint
Endpoint owned by the authenticated application. Endpoints belonging to another application, and cross-plane access, return 404. Replaces exact event subscriptions atomically. Changing the URL returns the endpoint to pending verification. Authenticate the partner application with HTTP Basic.
PATCH/v1/developer/webhook-endpoints/{endpoint_id}
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
Request body
This request body is required.
Webhook endpoint fields to update.
| Field | Type | Required | Notes |
|---|---|---|---|
url | string (uri) | No | |
events | array | No | |
status | string | No | Allowed: paused, disabled |
concurrency_limit | integer | No |
The example below includes optional fields for context; only fields marked Yes are always required. Conditional requirements are listed in Notes.
cURL example
curl -X PATCH https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"Delete a webhook endpoint
Endpoint owned by the authenticated application. Endpoints belonging to another application, and cross-plane access, return 404. Authenticate the partner application with HTTP Basic.
DELETE/v1/developer/webhook-endpoints/{endpoint_id}
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
cURL example
curl -X DELETE https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"Verify a webhook endpoint
Posts a freshly signed nonce challenge. Only a 200 response echoing the nonce activates the endpoint. Authenticate the partner application with HTTP Basic.
POST/v1/developer/webhook-endpoints/{endpoint_id}/verify
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
cURL example
curl -X POST https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af/verify \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"Rotate a webhook endpoint secret
Returns a new secret exactly once and keeps the previous secret active for a 24-hour signing overlap. Endpoint and circuit state are unchanged. Authenticate the partner application with HTTP Basic.
POST/v1/developer/webhook-endpoints/{endpoint_id}/rotate-secret
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
cURL example
curl -X POST https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af/rotate-secret \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"Schedule a webhook endpoint test
Schedules a signed endpoint test and returns without sending inline. Authenticate the partner application with HTTP Basic.
POST/v1/developer/webhook-endpoints/{endpoint_id}/test
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
cURL example
curl -X POST https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af/test \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"List webhook deliveries
Lists newest deliveries with per-attempt status and latency. Response bodies appear only on non-2xx attempts. Authenticate the partner application with HTTP Basic.
GET/v1/developer/webhook-endpoints/{endpoint_id}/deliveries
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
cursor | query | string | No | Opaque pagination cursor returned by the previous page. |
per_page | query | integer | No | Page size between 1 and 100. |
status | query | string | No | |
event_type | query | string | No |
cURL example
curl -X GET https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af/deliveries \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"Schedule a webhook delivery retry
Marks the stored delivery pending for asynchronous retry without sending inline. Authenticate the partner application with HTTP Basic.
POST/v1/developer/webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/retry
Authentication
Requires HTTP Basic application authentication.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
endpoint_id | path | string | Yes | Opaque external webhook endpoint identifier. |
delivery_id | path | string | Yes | Webhook delivery identifier. |
cURL example
curl -X POST https://api.demarky.ai/v1/developer/webhook-endpoints/f62fba7d-5af6-4741-b94b-6c362d3317af/deliveries/f62fba7d-5af6-4741-b94b-6c362d3317af/retry \
-u "app_0123456789abcdefghjkmnpqrs:dmk_cs_live_xxx"