Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Path Parameters

webhookId
string
required

Unique identifier for a Webhook. Format: whk_[test_]{ksuid}

Pattern: ^whk_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"whk_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Get webhook

id
string
required

Unique identifier for a Webhook. Format: whk_[test_]{ksuid}

Pattern: ^whk_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"whk_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

appId
string
required

Unique identifier for a App. Format: app_[test_]{ksuid}

Pattern: ^app_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

url
string<uri>
required

URL to send webhook events to

Example:

"https://example.com/webhook"

events
string[]
required

Events that trigger this webhook

Example:
headers
object | null
required

Custom headers included in webhook requests

Example:
createdAt
string<date-time>
required

When the webhook was created

Example:

"2021-08-01T00:00:00Z"

updatedAt
string<date-time>
required

When the webhook was last updated

Example:

"2021-08-01T00:00:00Z"