---
title: "Onboarding event"
method: POST
path: "/v1/onboarding/events"
tags: ["Onboarding"]
---

# Onboarding event

`POST /v1/onboarding/events`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/onboarding/events`
- Auth: HTTP bearer

## Request body

- OnboardingEventReq
  - `kind` string, required
  - `props` SetupMetricProps
    - `step` 'name' | 'tryit' | 'trial' | 'reach' | 'pickup' | 'mobile' | 'intent' | 'taps' | 'ready'
    - `intent` 'unknown_callers' | 'missed_calls' | 'number_to_give_out' | 'bookings'
    - `result` 'proven' | 'failed' | 'skipped'
    - `choice` 'connected' | 'picked' | 'shared' | 'skipped'
    - `itemType` 'live_question' | 'impostor' | 'new_lead' | 'still_waiting' | 'question' | 'call_back' | 'reminder' | 'zone_ask' | 'expect_call' | 'reply_ready' | 'unanswered_text' | 'couldnt_reach' | 'missed_call' | 'automated_notice' | 'nudge' | 'trial_ending' | 'fix' | 'code' | 'check' | 'decided' | 'case'
    - `action` 'yes' | 'no' | 'pick_up' | 'call_them' | 'call_back' | 'call' | 'reply' | 'say_now' | 'send' | 'edit' | 'dont_reply' | 'reveal' | 'copy' | 'open' | 'done' | 'remind' | 'from_my_phone' | 'change_it' | 'details' | 'ask_first' | 'block' | 'dismiss'
    - `channel` 'sms' | 'email' | 'voice' | 'next_call' | 'from_my_phone' | 'call' | 'link'
    - `outcome` 'delivered' | 'failed'
    - `trigger` 'resolved_summary' | 'errand_done' | 'approval_held' | 'turned_away' | 'first_real_call'
    - `day` string

## Response `200`

OK

- OnboardingEventRes
  - `recorded` boolean, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `413`: Body over the limit (64 KB; 512 KB for contact import).
- `500`: Unexpected server error (reported to Sentry).

---

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