Skip to main content
GET
Read a database webhook subscription

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

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}$

Query Parameters

environment
enum<string>
required

Application environment the mutation applies to.

Available options:
dev,
prod

Response

Current subscription state, without secret.

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