Skip to main content
PATCH
Update 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

Body

application/json

Request model for updating a webhook subscription.

Partial update: only the provided fields are applied. At least one must be set.

enabled
boolean | null

Whether subscription should be enabled

endpointUrl
string<uri> | null

New HTTPS endpoint to receive webhook events

Required string length: 1 - 2083

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