Skip to main content
GET
Read one database webhook

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}$
webhook_id
string
required

Database webhook identifier.

Pattern: ^whk_[a-z0-9]{20}$

Query Parameters

environment
enum<string>
default:dev

Application environment to read; dev when omitted.

Available options:
dev,
prod

Response

The database webhook.

id
string
required
Pattern: ^whk_[a-z0-9]{20}$
environment
enum<string>
required
Available options:
dev,
prod
url
string
required

The receiver URL. Callers without projects:write receive only its origin, because the path or query may carry the receiver's credential.

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
header_names
string[]
required

Names of the extra headers only; their values are never returned.

Maximum array length: 8
Pattern: ^[A-Za-z][A-Za-z0-9-]{0,63}$
created_at
string<date-time>
required