createNotificationWebhook

POST

/api/v1/notifications/webhooks

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

Create a notification webhook. Requires an Owner or Administrator with the admin scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters

url

required

string format: uri

categories

Array<string>

Allowed values: incident content_health backup update

Responses

201

Notification webhook created

Media typeapplication/json

object

data

required

The signing secret is returned exactly once. There is no endpoint that reads it back.

object

webhook

required

object

id

required

string format: uuid

name

required

string

url

required

string format: uri

enabled

required

boolean

categories

required

Array<string>

Allowed values: incident content_health backup update

lastAttemptAt

string format: date-time

lastSuccessAt

string format: date-time

lastError

string

createdAt

required

string format: date-time

signingSecret

required

string

secretNotice

required

string

Example

{
  "data": {
    "webhook": {
      "categories": [
        "incident"
      ]
    }
  }
}

400

Invalid webhook

401

Dashboard authentication required

403

Insufficient role