Skip to main content
POST
/
v1
/
webhook-endpoints
Create an outbound webhook endpoint (generates a signing secret)
curl --request POST \
  --url https://api.example.com/v1/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Slack #alerts",
  "url": "https://hooks.slack.com/services/T00/B00/xxx",
  "type": "generic",
  "events": [
    "budget.threshold_reached",
    "policy.violation"
  ]
}
'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Human-readable name for this endpoint

Example:

"Slack #alerts"

​
url
string
required

Destination URL for webhook delivery

Example:

"https://hooks.slack.com/services/T00/B00/xxx"

​
type
enum<string>
default:generic
required

Payload format: slack uses the Slack incoming-webhook shape

Available options:
slack,
generic
​
events
string[]
required

Event types this endpoint subscribes to

Example:
[
  "budget.threshold_reached",
  "policy.violation"
]

Response

201 - undefined