webhooks

Update a webhook endpoint

Required permission: webhooks:write

patch/v1/webhooks/{id}

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/webhooks/{id}
  • 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:write)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required

Request body

urlstring uri
eventsWebhookEvent[]
settleMsinteger
enabledboolean

Example request

{
  "url": "https://hooks.example.com/cueframe"
}

Response

Webhook updated.

idstring required
urlstring uri required
eventsWebhookEvent[] required
settleMsinteger required
enabledboolean required
verificationStatus'pending' | 'verified' required

pending = callback URL has not echoed the ownership challenge (receives no events); verified = ownership proven.

createdAtstring required
lastDeliveredAtstring nullable required
lastFailedAtstring nullable required
consecutiveFailuresinteger required

Changes

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