Authorization

bearerAuth

AuthorizationBearer <token>

API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.

In: header

Request Body

application/json

events?|null

Event types to subscribe to (empty or ["*"] for all events)

headers?|null

Custom headers to include in webhook requests

Itemsitems <= 10

is_active*boolean

Whether this webhook is active

name*string

Unique name for this webhook

Length1 <= length <= 64

secret?string

Secret for HMAC-SHA256 signature (leave empty to disable signing)

Lengthlength <= 256

url*string

Webhook URL to send events to

Formaturi

Length1 <= length

[key: string]?never

Response Body

`application/json`

`application/problem+json`

curl -X POST "http://localhost:8080/api/v1/webhooks" \
  -H "Content-Type: application/json" \
  -d '{
    "is_active": true,
    "name": "string",
    "url": "http://example.com"
  }'

curl -X POST "http://localhost:8080/api/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "is_active": true,    "name": "string",    "url": "http://example.com"  }'

{
  "created_at": "string",
  "events": [
    "string"
  ],
  "has_secret": true,
  "headers": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "is_active": true,
  "name": "string",
  "updated_at": "string",
  "url": "string"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Create webhook

Authorization

Request Body

Response Body

200application/json

defaultapplication/problem+json

`application/json`

`application/problem+json`