> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chargefy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Evento onboarding.session.submitted

> Evento onboarding.session.submitted.

## Evento `onboarding.session.submitted`

Disparado para a organização da plataforma quando a organização conectada
termina de preencher a onboarding session e clica em concluir. O evento indica
que o cadastro financeiro inicial foi recebido para análise.

O resultado financeiro da organização chega por
[`organization.updated`](/api-reference/webhooks/organization.updated) e também
pode ser consultado em
[`GET /v1/organizations/{id}`](/api-reference/organizations/get).

## Exemplo de payload

```json theme={}
{
  "id": "evt_123",
  "object": "event",
  "created_at": "2026-04-30T18:31:20.000Z",
  "data": {
    "object": {
      "id": "os_123",
      "object": "onboarding_session",
      "created_at": "2026-04-30T18:25:00.000Z",
      "expires_at": null,
      "livemode": true,
      "metadata": {},
      "opened_at": "2026-04-30T18:25:10.000Z",
      "organization": "org_789",
      "platform": "plat_456",
      "return_url": "https://meusite.com/onboarding/return",
      "status": "submitted",
      "updated_at": "2026-04-30T18:31:20.000Z",
      "url": null
    }
  },
  "livemode": true,
  "organization": "org_789",
  "request": {
    "id": null
  },
  "type": "onboarding.session.submitted"
}
```

## Campos do payload

### Payload

| Campo          | Tipo      | Descrição                                                                                               |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------- |
| `id`           | `string`  | ID único do evento (`evt_*`).                                                                           |
| `object`       | `string`  | Sempre `"event"`.                                                                                       |
| `created_at`   | `string`  | Data/hora ISO 8601 da geração do evento.                                                                |
| `livemode`     | `boolean` | Mesmo valor de `data.object.livemode`.                                                                  |
| `organization` | `string`  | ID da organização conectada vinculada ao onboarding session. Mesmo valor de `data.object.organization`. |
| `type`         | `string`  | `"onboarding.session.submitted"`                                                                        |

### `data.object`

| Campo          | Tipo             | Descrição                                                      |
| -------------- | ---------------- | -------------------------------------------------------------- |
| `id`           | `string`         | ID do onboarding session concluído (`os_*`).                   |
| `object`       | `string`         | Sempre `"onboarding_session"`.                                 |
| `created_at`   | `string`         | Quando o onboarding session foi criado.                        |
| `expires_at`   | `string \| null` | Sempre `null` neste evento.                                    |
| `livemode`     | `boolean`        | `true` em produção; `false` em ambiente de teste.              |
| `metadata`     | `object`         | Eco do `metadata` enviado na criação desta onboarding session. |
| `opened_at`    | `string \| null` | Quando o fluxo hospedado foi aberto pela primeira vez.         |
| `organization` | `string`         | ID da organização conectada vinculada (`org_*`).               |
| `platform`     | `string`         | ID da plataforma.                                              |
| `return_url`   | `string`         | URL de retorno configurada na criação.                         |
| `status`       | `string`         | `"submitted"` neste evento.                                    |
| `updated_at`   | `string \| null` | Última modificação do onboarding session.                      |
| `url`          | `string \| null` | Sempre `null` neste evento.                                    |

<Info>
  `onboarding.session.submitted` significa "cadastro recebido", não "aprovado".
  Para liberar recebimentos, aguarde `organization.activation_status` igual a
  `"active"` por `organization.updated` ou consulte a organização.
</Info>

## Uso típico

```typescript theme={}
switch (event.type) {
  case "onboarding.session.submitted": {
    const session = event.data.object;
    await db.onboardingSessions.upsert({
      id: session.id,
      organization: session.organization,
      status: session.status,
    });
    break;
  }
}
```
