Guided watch and webhook onboarding

Guided watch/webhook onboarding flow: first watch -> first signed webhook delivered -> the 80%-quota expansion nudge. Not billable, same as /quickstart. Idempotent: re-polling never mints a second watch or endpoint and never double-counts a delivery.

get/v1/onboarding

Request

  • Base URL: https://api.reqbeat.com
  • URL: https://api.reqbeat.com/v1/onboarding
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

webhook_urlstring required

Your HTTPS endpoint that will receive signed webhook deliveries for the watch this flow registers.

domainstring nullable

Company website domain to watch, e.g. 'stripe.com'. Omit to get the onboarding steps without resolving a company.

Response

Successful Response

stepstring required
company_idinteger required
watch_idinteger required
webhook_endpoint_idinteger required
first_webhook_deliveredboolean required
expansion_nudge_triggeredboolean required

Changes

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