Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Pass your API key as the Bearer token. See Authentication.

Path Parameters

id
string
required

Body

application/json
name
string
endpoint
string<uri>
httpMethod
enum<string>
Available options:
GET,
POST,
PUT,
DELETE,
PATCH,
PURGE
payloadFormat
enum<string>

vercelNativeIntegration is accepted only on webhooks that already use it

Available options:
standard,
standard-no-payload,
sdkPayload,
edgeConfig,
edgeConfigUnescaped,
vercelNativeIntegration,
none
payloadKey
string
headers
string

JSON-encoded object, e.g. "{"X-Token": "abc"}"

timeoutSeconds
integer | null

Request timeout in seconds, up to the server maximum (120 unless configured). Null uses the default.

Required range: x >= 1
bypassApproval
boolean

Set to true to write directly to the live SDK Connection without approval. The caller must have Bypass draft approvals access in the SDK Connection's Projects, unless the organization enables the REST API approval bypass. This field has no effect when approval is not required.

ignoreWarnings
boolean

Set to true to continue past a warning: one raised by a Custom Hook, or a webhook that references a secret that doesn't exist. On publish, it also force-publishes an out-of-date draft when the caller has Bypass draft approvals access. It never clears a Custom Hook rejection. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.

skipHooks
boolean

Set to true to continue despite a Custom Hook rejection. The caller must have Bypass draft approvals access for SDK Connections in every Project. Otherwise, this field is ignored. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.

sdkConnections
string[]

Replaces the SDK Connections this webhook fires for

Minimum array length: 1

Response

Resource updated

sdkWebhook
object
required
bypassedGates
object[]

Gates that would have blocked this publish but were bypassed by the caller's authority. Present only when at least one gate was bypassed.