Settings

Configure the org's outbound webhook

Sets the org-level webhook URL. When configured, the platform fires POST requests to this URL when async operations complete — audience builds (enrichment, propensity, similarity) and file delivery exports. Events fired: segment.ready, segment.failed, delivery.completed, delivery.failed. The signing secret is platform-generated, not a request field — see the Webhooks tag for the envelope shape and signing scheme, and POST /v1/settings/webhook/secret to rotate it. Requires 'account' scope.

put/v1/settings/webhook

Request

  • Base URL: https://api.infiniteaudience.ai
  • URL: https://api.infiniteaudience.ai/v1/settings/webhook
  • Auth: HTTP bearer

Request body

urlstring uri required

HTTPS endpoint URL to receive webhook POST requests.

Response

Webhook configured.

oktrue required
secretstring

Plaintext signing secret — present ONLY the first time a webhook is configured for this org (the platform just generated it). A later call that only changes the URL omits this field, since the existing secret is preserved unchanged. Store it now; it is never retrievable again — use POST /v1/settings/webhook/secret to rotate if lost.

Changes

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