/outbound-webhooks (POST)

POST

/outbound-webhooks

curl --request POST \
  --url https://example.com/api/v1/outbound-webhooks \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "events": [ "example" ], "secret": "example" }'

Request Body ^required

Media type application/json

object

url

required

string

>= 1 characters <= 2048 characters

events

required

Array<string>

>= 1 items <= 16 items

secret

string

>= 8 characters <= 256 characters

Example ^generated

{
  "url": "example",
  "events": [
    "example"
  ],
  "secret": "example"
}

Responses

201

Default Response

Media type application/json

object

id

required

string

url

required

string

events

required

Array<string>

active

required

boolean

hasSecret

required

boolean

createdAt

required

string format: date-time

Example ^generated

{
  "id": "example",
  "url": "example",
  "events": [
    "example"
  ],
  "active": true,
  "hasSecret": true,
  "createdAt": "2026-04-15T12:00:00Z"
}

400

Default Response

Media type application/json

object

type

required

string

title

required

string

status

required

integer

code

required

string

detail

string

instance

string

errors

Array<object>

object

path

required

string

message

required

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}