Skip to main content
POST
Create 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}

Body

application/json

Request model for creating a webhook subscription.

endpointUrl
string<uri>
required

HTTPS endpoint to receive webhook events

Required string length: 1 - 2083
eventTypes
enum<string>[]
required

Event types to subscribe to. Allowed values: asset.processing.completed, asset.processing.failed

Minimum array length: 1

All event types that can be delivered via webhooks.

Available options:
asset.processing.completed,
asset.processing.failed
description
string | null

Optional human-readable description

Response

Successful Response

Response model for creating a webhook subscription (includes one-time secret).

The signing secret is only shown once at creation time. The customer must store this secret to verify webhook signatures from Hookdeck.

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

secret
string
required

Signing secret for verifying webhook signatures (shown only once)

description
string | null

Subscription description