POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Provide your API key in the Authorization header using Bearer auth

Body

application/json

Create a webhook endpoint

url
string
required

Endpoint URL, must be https

Maximum string length: 1000
Example:

"https://example.com/webhooks/geekidea"

description
string

Description

Maximum string length: 255
project_id
string

Only receive events of this project (proj_ prefix); the whole organization if omitted

Example:

"proj_0192f1c3a7b87c3e9a4f5b6c7d8e9f01"

events
string[]

Event types to subscribe to; all generation.* events if omitted

Event types to subscribe to; all generation.* events if omitted

Example:

Response

OK

Webhook endpoint. The signing secret is returned only on creation and rotation

id
string

ID (whep_ prefix)

Example:

"whep_0192f1c3a7b87c3e9a4f5b6c7d8e9f01"

object
string

Always webhook_endpoint

Example:

"webhook_endpoint"

url
string

Endpoint URL

description
string

Description

project_id
string

Only receives events of this project; null means the whole organization

events
string[]

Subscribed event types

Subscribed event types

status
string

Status: active / disabled

Example:

"active"

created_at
integer<int64>

Creation time (Unix seconds)

secret
string

Signing secret (whsec_ prefix), returned only on creation and rotation; store it safely