SAsalesstream
Webhooks

Set your webhook configuration

Register the HTTPS URL we POST job events to (job.completed / job.failed). If you enable webhooks without an existing or provided secret, one is generated and returned ONCE in secret — store it to verify the X-Signature header. Each delivery is a POST with header X-Webhook-Event and X-Signature: sha256=<hex>, where the signature is the HMAC-SHA256 of the raw JSON body keyed by your secret. The body matches the WebhookEvent schema.

put/v1/webhook

Request

  • Base URL
    https://dataapi.reachthepeople.ai/api
  • Auth
    HTTP bearer

Request body

urlstring

Public HTTPS URL

enabledboolean
secretstring

Optional signing secret. If omitted when enabling and none exists, one is generated and returned once.

Example request

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

Response

Webhook saved

urlstring
enabledboolean
hasSecretboolean
secretstring

Present ONLY when a secret was just generated — store it now; it is not retrievable later.

Changes

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