Skip to main content
POST
/
integrations
/
api
/
v1
/
webhooks
/
endpoints
/
{endpoint_id}
/
test
Send test event
curl --request POST \
  --url https://www.closient.com/integrations/api/v1/webhooks/endpoints/{endpoint_id}/test/ \
  --header 'X-API-Key: <api-key>'
{
  "delivery_id": "<string>",
  "status": "pending",
  "http_status_code": 349,
  "response_body": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
endpoint_id
string<shortuuid>
required

UUID of the webhook endpoint. Returned as the id field on every endpoint response.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

200 - application/json

OK

Result of a synchronous test or replay delivery.

Returned by POST /webhooks/endpoints/{endpoint_id}/test/ (sends a synthetic ping event) and POST /webhooks/deliveries/{id}/replay/ (re-queues a dead-lettered delivery and waits for the first attempt to finish before responding). Subsequent retries — if any — happen asynchronously and surface in the deliveries list.

​
delivery_id
string
required

UUID of the delivery record that was created or replayed. Use this to look the attempt up in the deliveries list.

​
status
enum<string>
required

Lifecycle state of the delivery attempt. pending deliveries are awaiting their next retry; delivered is terminal-success; failed is mid-retry-backoff; rate_limited is a 429 response (retried separately so 429s don't inflate failure rates); dead_letter is terminal-failure after retries are exhausted and must be replayed via the deliveries-replay endpoint to attempt again.

Available options:
pending,
delivered,
failed,
rate_limited,
dead_letter
​
http_status_code
integer | null

HTTP status code returned by the customer endpoint on the most recent attempt. null while the delivery is enqueued but has not been attempted yet, or when the request errored before a response was received (DNS / TLS / connect timeout).

Required range: 100 <= x <= 599
​
response_body
string | null

First 256 characters of the customer endpoint's response body for the test attempt, or null if the request errored before a response was received.

Maximum string length: 256