Add a webhook endpoint; the answer holds its signing secret, once.

POST

/api/v1/webhooks

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

Request Body^required

Media typeapplication/json

object

name

required

string

Example

ops-pager

url

required

string

Example

https://hooks.example.com/kuben

events

required

Event types, or * for all.

Array<string>

Responses

201

Media typeapplication/json

object

id

required

string format: uuid

name

required

string

url

required

string

events

required

Array<string>

createdBy

required

string

createdAt

required

string

disabledAt

string | null

failures

required

Deliveries given up in a row; the endpoint is disabled at 20.

integer format: int32

secret

The signing secret: shown once, when the endpoint is made.

string | null

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "url": "example",
  "events": [
    "example"
  ],
  "createdBy": "example",
  "createdAt": "example",
  "disabledAt": "example",
  "failures": 1,
  "secret": "example"
}

403

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

409

The name is taken

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

422

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}