Webhooks

Create a webhook (returns the signing secret once)

POST
/v1/orgs/{orgId}/webhooks/create
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

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

curl -X POST "https://example.com/v1/orgs/string/webhooks/create" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "string"  }'
{
  "id": "string",
  "name": "string",
  "url": "string",
  "secretPrefix": "string",
  "events": [
    "string"
  ],
  "enabled": true,
  "createdAt": "string",
  "secret": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}