staqlydocs
REST APIAPI referenceWebhooks

Queue a webhook.test delivery

Queue a webhook.test delivery

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/webhooks/{id}/test

Rate-limited per principal (burst 5, then 10 per minute).

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Response Body

Queued

application/json
  1. response
id*string
webhook_id*string
event_id*string
event_type*string
status*string
Value in"pending""succeeded""failed"
attempts*integer
next_attempt_at*string|null
last_status_code*integer|null
last_error*string
last_response*string

First 2 KB of the receiver's response body (Community Edition only; always empty in cloud mode)

last_attempt_at*string|null
delivered_at*string|null
created_at*string
curl -X POST 'https://staqly.example.com/v1/webhooks/string/test'
{  "id": "string",  "webhook_id": "string",  "event_id": "string",  "event_type": "string",  "status": "pending",  "attempts": 0,  "next_attempt_at": "string",  "last_status_code": 0,  "last_error": "string",  "last_response": "string",  "last_attempt_at": "string",  "delivered_at": "string",  "created_at": "string"}