Skip to main content
GET
Get Subscription

Authorizations

X-API-Key
string
header
default:sk_live_your_api_key_here
required

Workspace-scoped API key. Format: sk_live_{64 hex chars}

Path Parameters

subscription_id
string<uuid>
required

Response

Successful Response

Response model for webhook subscription (GET/LIST/PATCH operations).

id
string<uuid>
required

Subscription ID

workspaceId
string<uuid>
required

Workspace ID

endpointUrl
string
required

Webhook endpoint URL

eventTypes
string[]
required

Subscribed event types

enabled
boolean
required

Whether subscription is active

createdAt
string<date-time>
required

Creation timestamp

updatedAt
string<date-time>
required

Last update timestamp

description
string | null

Subscription description