Create a webhook subscription

POST

/api/v1/webhook-subscriptions

• Staging
• Production (planned)

Authorizations

• apiKeyAuth

Request Body ^required

object

targetUrl

required

HTTPS URL to receive webhook payloads

string format: uri

secret

required

Secret for HMAC-SHA256 signature verification

string

>= 16 characters

events

required

Array<string>

>= 1 items

Allowed values: incident.created incident.resolved webchange.detected

description

string | null

<= 200 characters

Responses

201

Subscription created

object

subscription

object

id

string

teamId

string

targetUrl

string format: uri

events

Array<string>

description

string | null

isActive

integer

Allowed values: 0 1

createdAt

string format: date-time