> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pivotal.app/llms.txt.
> For full documentation content, see https://docs.pivotal.app/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivotal.app/_mcp/server.

# 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

```json title="onboarding.phase_changed"
{
  "id": "evt_2nQv...",
  "type": "onboarding.phase_changed",
  "data": {
    "object": {
      "id": "onb_2N...",
      "customer_id": "cus_2N...",
      "display_id": 1108,
      "name": "Acme Corp · Q3 rollout",
      "phase": "integration",
      "state": "active",
      "target_launch_date": "2026-07-15",
      "owner_email": "csm@yourdomain.com"
    },
    "previous_attributes": {
      "phase": "kickoff"
    }
  }
}
```