RaylightAPI

Webhooks

List deliveries

List deliveries. GET /v1/webhooks/{id}/deliveries in the Raylight API.

GET/v1/webhooks/{id}/deliveries

API key with the productions scope.

Parameters

FieldInTypeDescription
idrequiredpathuuidThe endpoint id.
limitqueryinteger

Responses

200Deliveries, newest first.
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).
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.

200 response body

FieldTypeDescription
deliveriesrequiredobject[]
deliveries[].idrequireduuid
deliveries[].endpointIdrequireduuid
deliveries[].productionIdrequireduuid | null
deliveries[].eventrequiredenumOne of: production.pitch_ready, production.skipped, production.greenlit, production.progress, production.delivered, production.failed, production.declined, production.cancelled, ping
deliveries[].statusrequiredenumOne of: pending, succeeded, exhausted
deliveries[].attemptsrequiredinteger
deliveries[].nextAttemptAtrequireddatetime | null
deliveries[].lastResponseStatusrequiredinteger | null
deliveries[].lastResponseBodyrequiredstring | null
deliveries[].lastErrorrequiredstring | null
deliveries[].lastAttemptAtrequireddatetime | null
deliveries[].deliveredAtrequireddatetime | null
deliveries[].createdAtrequireddatetime

Example

curl
curl https://api.raylight.app/v1/webhooks/$ID/deliveries \  -H "Authorization: Bearer $RAYLIGHT_API_KEY"