Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The SDK Connection id

version
required

Body

application/json
name
string
required
endpoint
string<uri>
required
revisionTitle
string

Short draft title (e.g. Enable for beta testers). Only used when version is "new"; ignored for existing drafts.

revisionComment
string

Markdown. What changed and why, for reviewers. Only used when version is "new"; ignored for existing drafts.

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.

httpMethod
enum<string>
Available options:
GET,
POST,
PUT,
DELETE,
PATCH,
PURGE
payloadFormat
enum<string>
Available options:
standard,
standard-no-payload,
sdkPayload,
edgeConfig,
edgeConfigUnescaped,
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

Response

Resource created

revision
object
required