Webhooks
Update a webhook endpoint
Update a webhook endpoint. PATCH /v1/webhooks/{id} in the Raylight API.
PATCH
/v1/webhooks/{id}API key with the productions scope.
Parameters
| Field | In | Type | Description |
|---|---|---|---|
idrequired | path | uuid | The endpoint id. |
Request body
application/json
| Field | Type | Description |
|---|---|---|
url | url | |
description | string | null | |
events | enum[] | |
enabled | boolean |
Responses
200The updated endpoint.
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 |
|---|---|---|
endpointrequired | object | |
endpoint.idrequired | uuid | |
endpoint.workspaceIdrequired | uuid | |
endpoint.urlrequired | url | |
endpoint.descriptionrequired | string | null | |
endpoint.eventsrequired | enum[] | |
endpoint.enabledrequired | boolean | |
endpoint.disabledReasonrequired | string | null | |
endpoint.consecutiveFailuresrequired | integer | |
endpoint.lastAttemptAtrequired | datetime | null | |
endpoint.lastSuccessAtrequired | datetime | null | |
endpoint.previousSecretExpiresAtrequired | datetime | null | |
endpoint.createdAtrequired | datetime | |
endpoint.updatedAtrequired | datetime |
Example
curl -X PATCH https://api.raylight.app/v1/webhooks/$ID \ -H "Authorization: Bearer $RAYLIGHT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "enabled": true }'