Create webhook subscription

curl --request POST \
  --url https://api.sigmora.org/v1/webhook-subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "url": "https://hooks.example.com/sigmora/events",
  "events": [
    "job.completed",
    "job.failed",
    "publish.completed"
  ],
  "secret": "whsec_7cf9f73729a02263c975a3fe92461e07"
}
'

import requests

url = "https://api.sigmora.org/v1/webhook-subscriptions"

payload = {
    "url": "https://hooks.example.com/sigmora/events",
    "events": ["job.completed", "job.failed", "publish.completed"],
    "secret": "whsec_7cf9f73729a02263c975a3fe92461e07"
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://hooks.example.com/sigmora/events',
    events: ['job.completed', 'job.failed', 'publish.completed'],
    secret: 'whsec_7cf9f73729a02263c975a3fe92461e07'
  })
};

fetch('https://api.sigmora.org/v1/webhook-subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "subscription": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "job.awaiting_approval"
    ],
    "status": "active",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "lastDeliveredAt": "<string>"
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Create webhook subscription

Subscribe an automation callback to durable events. Stores the signing secret encrypted, returns no secret, and delivers matching events at least once with X-Sigmora-Signature. Subscription events cover shared Firestore video jobs (including video.edit), public media-analysis jobs, and publishing transitions. Curriculum jobs from POST /v1/video/render and asset.animate jobs remain on their service-owned stores; use GET /v1/jobs/ or their per-job callback instead.

POST

webhook-subscriptions

curl --request POST \
  --url https://api.sigmora.org/v1/webhook-subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "url": "https://hooks.example.com/sigmora/events",
  "events": [
    "job.completed",
    "job.failed",
    "publish.completed"
  ],
  "secret": "whsec_7cf9f73729a02263c975a3fe92461e07"
}
'

import requests

url = "https://api.sigmora.org/v1/webhook-subscriptions"

payload = {
    "url": "https://hooks.example.com/sigmora/events",
    "events": ["job.completed", "job.failed", "publish.completed"],
    "secret": "whsec_7cf9f73729a02263c975a3fe92461e07"
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://hooks.example.com/sigmora/events',
    events: ['job.completed', 'job.failed', 'publish.completed'],
    secret: 'whsec_7cf9f73729a02263c975a3fe92461e07'
  })
};

fetch('https://api.sigmora.org/v1/webhook-subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "subscription": {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "job.awaiting_approval"
    ],
    "status": "active",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "lastDeliveredAt": "<string>"
  }
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "success": false,
  "error": "<string>",
  "code": "invalid_request",
  "details": "<unknown>",
  "requestId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

A workspace API key.

Headers

idempotency-key

string

required

Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey.

Required string length: 1 - 255

Body

application/json

url

string<uri>

required

Public HTTPS callback endpoint.

Maximum string length: 2048

events

enum<string>[]

required

Subscribed event set; only matching events are delivered.

Required array length: 1 - 8 elements

Available options:

job.awaiting_approval,

job.progressed,

job.completed,

job.failed,

job.cancelled,

artifact.ready,

publish.completed,

publish.failed

secret

string

required

Customer-owned HMAC secret. Encrypted at rest and never returned.

Required string length: 32 - 512

Callbacks

POST

{$request.body#/url}automationEvent

Body

application/json

schemaVersion

string

required

Allowed value: "automation-event.v1"

eventId

string

required

Pattern: ^awe_[a-f0-9]{48}$

event

enum<string>

required

Available options:

job.awaiting_approval,

job.progressed,

job.completed,

job.failed,

job.cancelled,

artifact.ready,

publish.completed,

publish.failed

occurredAt

string<date-time>

required

workspaceId

string

required

data

object

required

Show child attributes

Response

2XX

Acknowledged; the delivery receipt may be removed.

Response

Success.

success

boolean

required

subscription

object

required

Show child attributes

{key}

any

Meta

Projects

Sessions

Assets

Jobs

Text

Video

UGC

Editing

3D

Image

Audio

Publishing

Webhooks

Workflows

Agents

Research

Themes

Signals

Discovery

Watchlist

Performance

Autopilot

Campaigns

Brands

Products

Create webhook subscription

Authorizations

Headers

Body

Callbacks

Body

Response

Response