---
title: "Guided watch and webhook onboarding"
method: GET
path: "/v1/onboarding"
---

# Guided watch and webhook onboarding

`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

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.

## Query parameters

- `webhook_url` string, required: Your HTTPS endpoint that will receive signed webhook deliveries for the watch this flow registers.
- `domain` string, nullable: Company website domain to watch, e.g. 'stripe.com'. Omit to get the onboarding steps without resolving a company.

## Response `200`

Successful Response

- OnboardingResponse
  - `step` string, required
  - `company_id` integer, required
  - `watch_id` integer, required
  - `webhook_endpoint_id` integer, required
  - `first_webhook_delivered` boolean, required
  - `expansion_nudge_triggered` boolean, required

## Other responses

- `401`: No API key was sent.
- `403`: A key was sent, but it is unknown or revoked.
- `422`: Validation Error

---

[API](https://skmtc.dev/reqbeat/apis/reqbeat-api.md) · [All operations](https://skmtc.dev/reqbeat/apis/reqbeat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/reqbeat/apis/reqbeat-api/revisions/4758e5957e8c?raw)