Webhooks
List webhook endpoints
List webhook endpoints. GET /v1/webhooks in the Raylight API.
GET
/v1/webhooksAPI key with the productions scope.
Parameters
| Field | In | Type | Description |
|---|---|---|---|
workspaceId | query | uuid |
Responses
200The workspace's endpoints.
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
| Field | Type | Description |
|---|---|---|
endpointsrequired | object[] | |
endpoints[].idrequired | uuid | |
endpoints[].workspaceIdrequired | uuid | |
endpoints[].urlrequired | url | |
endpoints[].descriptionrequired | string | null | |
endpoints[].eventsrequired | enum[] | |
endpoints[].enabledrequired | boolean | |
endpoints[].disabledReasonrequired | string | null | |
endpoints[].consecutiveFailuresrequired | integer | |
endpoints[].lastAttemptAtrequired | datetime | null | |
endpoints[].lastSuccessAtrequired | datetime | null | |
endpoints[].previousSecretExpiresAtrequired | datetime | null | |
endpoints[].createdAtrequired | datetime | |
endpoints[].updatedAtrequired | datetime |
Example
curl https://api.raylight.app/v1/webhooks \ -H "Authorization: Bearer $RAYLIGHT_API_KEY"