Onboarding events

Seven events fire on the onboarding resource. Phase and state changes carry data.previous_attributes so you can act on the transition, not just the new state.

EVENT TYPES

Type	Fires when
`onboarding.created`	A new onboarding is created for a customer.
`onboarding.phase_changed`	Onboarding moves to a different phase. `previous_attributes.phase` holds the prior phase.
`onboarding.state_changed`	Onboarding’s state changes (active, paused, blocked, completed).
`onboarding.at_risk`	At-risk flag is set on the onboarding.
`onboarding.back_on_track`	At-risk flag is cleared.
`onboarding.launched`	Onboarding is marked launched (live with end users).
`onboarding.completed`	Onboarding hits its terminal completed state.

PAYLOAD

onboarding.phase_changed

1 {
2   "id": "evt_2nQv...",
3   "type": "onboarding.phase_changed",
4   "data": {
5     "object": {
6       "id": "onb_2N...",
7       "customer_id": "cus_2N...",
8       "display_id": 1108,
9       "name": "Acme Corp · Q3 rollout",
10       "phase": "integration",
11       "state": "active",
12       "target_launch_date": "2026-07-15",
13       "owner_email": "csm@yourdomain.com"
14     },
15     "previous_attributes": {
16       "phase": "kickoff"
17     }
18   }
19 }

1	{
2	"id": "evt_2nQv...",
3	"type": "onboarding.phase_changed",
4	"data": {
5	"object": {
6	"id": "onb_2N...",
7	"customer_id": "cus_2N...",
8	"display_id": 1108,
9	"name": "Acme Corp · Q3 rollout",
10	"phase": "integration",
11	"state": "active",
12	"target_launch_date": "2026-07-15",
13	"owner_email": "csm@yourdomain.com"
14	},
15	"previous_attributes": {
16	"phase": "kickoff"
17	}
18	}
19	}