Webhooks
Create a webhook (returns the signing secret once)
Command line
The orl CLI wraps this endpoint:
orl webhooks create --name <name> --url <url>Authorization
apiKey AuthorizationBearer <token>
OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).
In: header
Path Parameters
orgId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/orgs/string/webhooks/create" \ -H "Content-Type: application/json" \ -d '{ "name": "deploy-events", "url": "https://example.com/hooks/openrelay", "events": [ "vm.running", "vm.stopped", "cluster.degraded" ] }'{ "id": "string", "name": "string", "url": "string", "secretPrefix": "string", "events": [ "string" ], "enabled": true, "createdAt": "string", "secret": "string"}