Send a test event

POST

/v1/webhooks/{id}/test

Sends a test event to the endpoint and reports how your URL answered. Free.

Authorization

bearerAuth

headerAuthorizationBearer <API key>

Create a key in the app under Developers. Keys start with dcd_live_.

id*string

Webhook endpoint id. Starts with wh_.

Match^wh_

Success.

application/json

Result of sending a test event to the endpoint.

delivered*boolean

Whether your URL answered with a 2xx status.

status_code*|

HTTP status your URL returned. Null if it could not be reached.

error*|

What went wrong, if the delivery failed.

request_id*string

Id of the request that produced this response. A replayed idempotent response keeps the original id.

Example Request

curl -X POST 'https://api.diced.si/v1/webhooks/wh_2BnM4vCx6ZlK8jHg1FdS3aQw/test' \  -H 'Authorization: Bearer dcd_live_your_key'

Example ResponseSchema

{  "delivered": true,  "status_code": -9007199254740991,  "error": "string",  "request_id": "string"}