Skip to main content
POST
/
api
/
integrations
/
webhooks
/
subscriptions
Create Subscription
curl --request POST \
  --url https://mm-midmarket-integrations-api-preview.azurewebsites.net/api/integrations/webhooks/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "description": "Notify when an asset finishes processing",
  "endpointUrl": "https://your-server.example.com/webhooks",
  "eventTypes": [
    "asset.processing.completed"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "endpointUrl": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "enabled": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "description": "<string>"
}

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