webhooks

Get the webhook delivery contract

The machine-readable webhook contract: the delivery envelope, Standard-Webhooks signing (secret format, signed content, how to verify), the synchronous echo-the-token ownership handshake, and every subscribable event with its exact data fields. Read this before building a receiver — it answers 'what's the payload shape / how do I verify the signature / how does activation work' without guessing.

get/v1/webhooks/events

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/webhooks/events
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token, scopes: webhooks:read)
    • API key in header PAYMENT-SIGNATURE

Response

The webhook delivery/signing/verification contract, as data.

deliveryobject required

The shared HTTP envelope + headers + retry semantics.

signingobject required

Standard Webhooks signing: secret format, signed content, how to verify.

ownershipVerificationobject required

The synchronous echo-the-token activation handshake + recovery.

sampleobject required

A fully-worked example delivery (headers + body).

Changes

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