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

Update a webhook (name/url/events)

Command line

The orl CLI wraps this endpoint:

orl webhooks update <id>
PATCH
/v1/orgs/{orgId}/webhooks/{id}
AuthorizationBearer <token>

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

In: header

Path Parameters

orgId*string
id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/orgs/string/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "url": "string",  "events": [    "string"  ]}