Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeWebhooks

Enable/disable a webhook

Sets enabled and returns the new state. A disabled webhook keeps its URL, events and secret but gets no deliveries. A retry that comes due while it is disabled is dropped.

Required permission

Requires the webhook.write permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl webhooks toggle <id> --enabled
POST
/v1/orgs/{orgId}/webhooks/{id}/toggle

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string
id*string

Request Body

application/json
  1. body
enabled*boolean

Response Body

Toggled

application/json
  1. response
id*string
enabled*boolean
Example Request
curl -X POST 'https://api.openrelay.inc/v1/orgs/string/webhooks/string/toggle' \  -H 'Content-Type: application/json' \  -d '{  "enabled": true}'
Example Response
{  "id": "string",  "enabled": true}

Delete a webhook DELETE

Deletes the webhook and returns 204. It gets no further deliveries, and any retries still pending for it are dropped instead of sent.

Regenerate a webhook secret (returned once) POST

Replaces the webhook's signing secret and returns the new whsec_ secret once. Later deliveries, retries included, are signed with the new secret.