Webhooks

Self-register this portal's webhook

Subscribe the calling portal's webhook for the authenticated organization.

OAuth-token only: the client is resolved from the token (not the body), the org from the token's org claim — a portal can only ever register its own webhook, for orgs that consented to it.

put/webhook-subscription

Request

  • Base URL: https://api.yourang.ai/v1
  • URL: https://api.yourang.ai/v1/webhook-subscription
  • Auth: API Key (a scheme the document does not define)

Request body

target_urlstring required

HTTPS receiver yourang POSTs signed event notifications to

event_typesstring[]

Event-type patterns to subscribe to (e.g. event., contact.)

Response

Successful Response

okboolean required

Changes

No recorded changes to this endpoint across all 8 revisions of this API.