Skip to main content
POST
Publish a new version of a webhook

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

pid
string
required

Project id (UUID) belonging to the caller workspace.

id
string
required

Id of any existing webhook row sharing the base slug to version.

Body

application/json

A complete webhook spec (same validator as create) plus the optional major flag.

name
string
required
Required string length: 1 - 80
slug
string
required

Must equal the base slug of the webhook named by {id}.

Pattern: ^[a-z0-9][a-z0-9-]{0,46}$
dataset
string
required
Pattern: ^[A-Za-z][A-Za-z0-9_]{0,62}$
enabled
boolean
default:true
criteria
object[]
Maximum array length: 10
mappings
object[]
Maximum array length: 50
major
boolean
default:false

true bumps the major version (2), otherwise the minor is incremented (1.1).

Response

New version created with its own high-entropy public slug (not returned here - read it back from the webhook list) and its own mirror rule. The per-project webhook cap is NOT re-checked on this path.

id
string
required
slug
string
required

Versioned route slug, base-v.