Webhooks

Register a webhook

Subscribe to Numonic events (asset.created, collection.published, pipeline.completed, etc.) via HTTP callback. asset.created is delivered once an uploaded asset has finished processing. Works with a session or an API key with the write scope; an API key registers webhooks for its own workspace only. Returns an HMAC-SHA256 signing secret for payload verification — this secret is shown only once, so store it securely.

post/api/v1/webhooks

Request

  • Base URL: https://numonic.ai
  • URL: https://numonic.ai/api/v1/webhooks
  • Auth: API key in header x-api-key

Headers

X-Tenant-IDstring uuid required

Target tenant UUID. Required when API key has access to multiple tenants.

Example:fd32351e-ddfc-4800-9182-cb16e0bc5f5b

Request body

namestring required

Human-friendly name for this webhook subscription

descriptionstring

Optional description of this webhook subscription

urlstring uri required

Destination URL that will receive webhook POST requests

eventsstring[] required

List of event names to subscribe to (e.g. "asset.created")

enabledboolean

Whether this webhook subscription is active

timeout_msinteger

Timeout for each webhook delivery attempt in milliseconds

custom_headersobject

Optional custom HTTP headers sent with each webhook request

Example request

{
  "name": "My Webhook",
  "description": "Notifies Slack when assets are uploaded",
  "url": "https://example.com/webhook",
  "events": [
    "asset.created",
    "asset.updated"
  ],
  "enabled": true,
  "timeout_ms": 10000,
  "custom_headers": {
    "X-Custom-Header": "value"
  }
}

Response

Webhook registered. HMAC secret returned (store securely — shown once).

idstring required
namestring required
urlstring uri required
eventsstring[] required
enabledboolean required
secretstring required

HMAC-SHA256 signing secret — shown only once. Store securely.

created_atstring required

Example response

{
  "secret": "whsec_a1b2c3d4e5f6..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.