> ## Documentation Index > Fetch the complete documentation index at: https://docs.sigmora.org/llms.txt > Use this file to discover all available pages before exploring further. # 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/{jobId} or their per-job callback instead. ## OpenAPI ````yaml /openapi.json post /v1/webhook-subscriptions openapi: 3.1.0 info: title: Sigmora API version: 1.0.0 description: >- The priced, versioned public API. Every call authenticates with a workspace API key (`Authorization: Bearer sk_live_…`), names the project it files its output under, and reports what it cost. `GET /v1/capabilities` answers what this deployment can serve right now and at what price; anything it reports as unavailable answers 503 `capability_unavailable` rather than 404. servers: - url: https://api.sigmora.org security: - bearerAuth: [] tags: - name: Meta description: What this deployment serves, what it costs, and what you have spent. - name: Projects description: The container every capability files its output under. - name: Sessions description: Durable bindings between an external harness session and one project. - name: Assets description: 'Project media: direct-to-storage uploads, imports, ingest and transcripts.' - name: Jobs description: Where every asynchronous capability is collected, whatever produced it. - name: Text description: Scripts, research, articles, translation and question sets. - name: Video description: Narrated renders, footage edits, shorts and moment selection. - name: UGC description: >- Creator-led vertical videos: AI creators, their faces and voices, frames and clips. - name: Editing description: >- Sigma, the editor: conversational turns, granular transcript edits, approvals. - name: 3D description: Animated 3D renders from a description or a photograph. - name: Image description: Thumbnails, sized for the platform they are posted to. - name: Audio description: Generated music and audio engineering in Audiotool projects. - name: Publishing description: Connected destinations and queued posts. - name: Webhooks description: Signed, at-least-once delivery of job and publishing events. - name: Workflows description: Context snapshots, versioned recipes, costed proposals and their runs. - name: Agents description: Describe an outcome and let a bounded plan of capabilities run. - name: Research description: >- Observed hooks, creator outliers and production briefs from saved analyses. - name: Themes description: The canonical content taxonomy, and the niche profiles built on it. - name: Signals description: Evidence-backed trends and scored viral content. - name: Discovery description: Compiled watch plans, their runs, and source freshness. - name: Watchlist description: 'Accounts you watch: their usual reach and the posts that beat it.' - name: Performance description: Your own channels' videos against their usual, and fixes to live videos. - name: Autopilot description: The durable trend-to-distribution workflow and its checkpoints. - name: Campaigns description: Distribution records shared by the API, the dashboard and autopilot. - name: Brands description: >- Cross-platform identities with their own voice, rules and publishing commitments. - name: Products description: What a campaign promotes. paths: /v1/webhook-subscriptions: post: tags: - Webhooks summary: Create webhook subscription description: >- 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/{jobId} or their per-job callback instead. operationId: postWebhookSubscriptions parameters: - name: idempotency-key in: header required: true description: >- Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey. schema: type: string minLength: 1 maxLength: 255 description: >- Required stable id for this logical write; reuse it after a timeout. Upload endpoints also require the same value in body.idempotencyKey. requestBody: required: true content: application/json: schema: type: object properties: url: type: string maxLength: 2048 format: uri description: Public HTTPS callback endpoint. events: minItems: 1 maxItems: 8 type: array items: type: string enum: - job.awaiting_approval - job.progressed - job.completed - job.failed - job.cancelled - artifact.ready - publish.completed - publish.failed description: Subscribed event set; only matching events are delivered. secret: type: string minLength: 32 maxLength: 512 description: >- Customer-owned HMAC secret. Encrypted at rest and never returned. required: - url - events - secret additionalProperties: false example: url: https://hooks.example.com/sigmora/events events: - job.completed - job.failed - publish.completed secret: whsec_7cf9f73729a02263c975a3fe92461e07 responses: '201': description: Success. content: application/json: schema: type: object properties: success: type: boolean const: true subscription: type: object properties: id: type: string url: type: string format: uri events: type: array items: type: string enum: - job.awaiting_approval - job.progressed - job.completed - job.failed - job.cancelled - artifact.ready - publish.completed - publish.failed status: type: string enum: - active - disabled createdAt: type: string updatedAt: type: string lastDeliveredAt: type: - string - 'null' required: - id - url - events - status - createdAt - updatedAt - lastDeliveredAt additionalProperties: {} required: - success - subscription additionalProperties: {} '400': description: 'Failure. `code` is one of: invalid_request.' content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: 'Failure. `code` is one of: unauthorized.' content: application/json: schema: $ref: '#/components/schemas/Error' '402': description: 'Failure. `code` is one of: insufficient_credits, budget_capped.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: 'Failure. `code` is one of: forbidden, origin_not_allowed.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: 'Failure. `code` is one of: not_found.' content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: 'Failure. `code` is one of: conflict.' content: application/json: schema: $ref: '#/components/schemas/Error' '413': description: 'Failure. `code` is one of: payload_too_large.' content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: 'Failure. `code` is one of: rate_limited.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: 'Failure. `code` is one of: upstream_error, internal_error.' content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- Failure. `code` is one of: capability_unavailable, upstream_unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' callbacks: automationEvent: '{$request.body#/url}': post: summary: Receive a signed Sigmora automation event. description: >- At-least-once delivery. Verify HMAC-SHA256(secret, X-Sigmora-Timestamp + "." + the exact raw request body), then deduplicate X-Sigmora-Event-Id. Return any 2xx response to acknowledge. parameters: - name: X-Sigmora-Signature in: header required: true schema: type: string pattern: ^sha256=[a-f0-9]{64}$ - name: X-Sigmora-Timestamp in: header required: true schema: type: string format: date-time - name: X-Sigmora-Event in: header required: true schema: type: string enum: - job.awaiting_approval - job.progressed - job.completed - job.failed - job.cancelled - artifact.ready - publish.completed - publish.failed - name: X-Sigmora-Event-Id in: header required: true schema: type: string - name: X-Sigmora-Subscription-Id in: header required: true schema: type: string pattern: ^whs_[a-f0-9]{32}$ requestBody: required: true content: application/json: schema: type: object required: - schemaVersion - eventId - event - occurredAt - workspaceId - data properties: schemaVersion: type: string const: automation-event.v1 eventId: type: string pattern: ^awe_[a-f0-9]{48}$ event: type: string enum: - job.awaiting_approval - job.progressed - job.completed - job.failed - job.cancelled - artifact.ready - publish.completed - publish.failed occurredAt: type: string format: date-time workspaceId: type: string data: type: object required: - jobId - projectId - collection - status - phase - sequence - resourceUrl properties: jobId: type: string projectId: type: - string - 'null' collection: type: string enum: - videoJobs - analysisJobs - publishingQueue status: type: string phase: type: - string - 'null' sequence: type: integer minimum: 0 resourceUrl: type: - string - 'null' description: >- Relative API resource path to fetch for job and artifact events; null for publishing events. additionalProperties: false additionalProperties: false responses: 2XX: description: Acknowledged; the delivery receipt may be removed. method: post type: path path: '{$request.body#/url}' components: schemas: Error: type: object required: - success - error - code properties: success: const: false error: type: string description: >- Human-readable. Copy may change between releases — do not match on it. code: type: string enum: - invalid_request - unauthorized - forbidden - origin_not_allowed - not_found - conflict - payload_too_large - insufficient_credits - budget_capped - content_not_cleared - rate_limited - capability_unavailable - upstream_unavailable - upstream_error - internal_error description: Stable machine-readable cause. Branch on this. details: description: Optional structured context, e.g. the credits shortfall. requestId: type: string description: >- Identifies this request in our logs. Include it when you contact support. timestamp: type: string format: date-time description: When the failure was produced. securitySchemes: bearerAuth: type: http scheme: bearer description: A workspace API key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.