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

Regenerate a webhook secret (returned once)

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

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 secret regenerate <id>
POST
/v1/orgs/{orgId}/webhooks/{id}/regenerate-secret

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

orgId*string
id*string

Response Body

Regenerated

application/json
  1. response
id*string
secret*string
secretPrefix*string
Example Request
curl -X POST 'https://api.openrelay.inc/v1/orgs/string/webhooks/string/regenerate-secret'
Example Response
{  "id": "string",  "secret": "string",  "secretPrefix": "string"}

Enable/disable a webhook POST

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.

Recent delivery attempts for a webhook GET

Lists a webhook's recent delivery attempts: event type, the id of the resource the event is about, attempt number, status, response code, error and time. The newest deliveries first, at most limit (default 50). A delivery of a batch event is left out for a caller without batch read access, and one of a balance event for a caller without billing read access, so a page can hold fewer than limit.