Skip to main content
POST
Create webhook destination

Authorizations

Authorization
string
header
required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Headers

Idempotency-Key
string
required

Identifies one logical mutation across retries.

Required string length: 1 - 255
Pattern: ^[\x21-\x7e]{1,255}$

Path Parameters

projectId
string
required
Pattern: ^pho_prj_[0-7][0-9a-hjkmnp-tv-z]{25}$

Body

application/json
apiVersion
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
enabledEvents
required
name
string
required
Required string length: 1 - 256
url
string<uri>
required

HTTPS URL without credentials or a fragment.

Required string length: 1 - 2048
description
string
Maximum string length: 1000
status
enum<string>
default:enabled
Available options:
enabled,
disabled

Response

The created destination and its signing secret.

destination
object
required
signingSecret
string
required
Pattern: ^whsec_.*