Skip to main content
PUT
Activate or reconcile one webhook subscription generation

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
subscription_id
string
required

Stable, client-chosen subscription ULID.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
generation
integer
required

Positive activation generation, starting at one.

Required range: 1 <= x <= 9007199254740991

Query Parameters

environment
enum<string>
required

Application environment the mutation applies to.

Available options:
dev,
prod

Body

application/json
url
string
required

HTTPS receiver URL.

Maximum string length: 2048
Pattern: ^https://
event_types
(enum<string> | string)[]
required
Required array length: 1 - 16 elements

A platform event type, data. for the rows of one watched table, or data.* for every watched table. A bare * is not accepted and never matches data events.

Available options:
database.created,
database.ready,
database.woke,
database.slept,
database.suspended,
database.resized,
database.deleted
headers
object

Extra headers sent with every delivery. Names are case-insensitive and must be unique; content-type, host, content-length, connection, transfer-encoding, user-agent, te, upgrade, expect and any name starting with pgcf-, cf- or x-forwarded- are refused.

Response

Active generation with its signing secret; only this exact activation or retry returns it.

id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment
enum<string>
required
Available options:
dev,
prod
state
string
required
Allowed value: "active"
generation
integer
required
Required range: 1 <= x <= 9007199254740991
provider_id
string
required
Pattern: ^whk_[a-z0-9]{20}$
secret
string
required

Generation signing secret available only on the exact authorized activation or retry.

Minimum string length: 1