Webhooks
Send a test event
Queues a signed ping to test your receiver and signature check.
POST
/v1/webhooks/{id}/testAPI key with the productions scope.
Parameters
| Field | In | Type | Description |
|---|---|---|---|
idrequired | path | uuid | The endpoint id. |
Responses
202The queued delivery.
400Invalid request.
401Missing, invalid or revoked key.
403The key lacks the
productions scope (code api_key_missing_scope), or its owner has view-only access to the workspace (code forbidden).404No such endpoint or workspace for this key (code
not_found).409The endpoint is switched off (code
endpoint_disabled), or points at localhost on a server that cannot reach it (code wrong_server).429Rate limited, or a monthly cap reached.
503Webhooks are not switched on for this server (code
disabled). Every webhook route answers this while they are off.202 response body
| Field | Type | Description |
|---|---|---|
deliveryrequired | object | |
delivery.idrequired | uuid | |
delivery.endpointIdrequired | uuid | |
delivery.productionIdrequired | uuid | null | |
delivery.eventrequired | enum | One of: production.pitch_ready, production.skipped, production.greenlit, production.progress, production.delivered, production.failed, production.declined, production.cancelled, ping |
delivery.statusrequired | enum | One of: pending, succeeded, exhausted |
delivery.attemptsrequired | integer | |
delivery.nextAttemptAtrequired | datetime | null | |
delivery.lastResponseStatusrequired | integer | null | |
delivery.lastResponseBodyrequired | string | null | |
delivery.lastErrorrequired | string | null | |
delivery.lastAttemptAtrequired | datetime | null | |
delivery.deliveredAtrequired | datetime | null | |
delivery.createdAtrequired | datetime |
Example
curl -X POST https://api.raylight.app/v1/webhooks/$ID/test \ -H "Authorization: Bearer $RAYLIGHT_API_KEY"