PT EN

Onboarding

Eventos de Onboarding: 4 no total. Ver o envelope comum.

onboarding.approved

The onboarding application was approved.

Recurso: onboarding

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_HEXJV5xvEuzfL3nemfGMhmTgP64",
  "type": "onboarding.approved",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLS4Qpifg",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLS4Qpifg",
      "sequence": 1
    }
  }
}

onboarding.information_requested

The platform asked for more onboarding information.

Recurso: onboarding

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_HEXJV5xvEuz8XQz9hReApSkAn7B",
  "type": "onboarding.information_requested",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLSbM9hJn",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLSbM9hJn",
      "sequence": 1
    }
  }
}

onboarding.rejected

The onboarding application was rejected.

Recurso: onboarding

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_HEXJV5xvEuzztQjrkExeeggp2ho",
  "type": "onboarding.rejected",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLSLELezp",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLSLELezp",
      "sequence": 1
    }
  }
}

onboarding.submitted

The onboarding application was submitted.

Recurso: onboarding

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_HEXJV5xvEuzCCwVjnEZZwvLqDoo",
  "type": "onboarding.submitted",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLSXJguSh",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLSXJguSh",
      "sequence": 1
    }
  }
}

Receber estes eventos

O seu endpoint de webhook recebe cada um destes eventos num POST com o envelope comum, descrito na tabela abaixo. Verifique a assinatura antes de agir, responda depressa com um código 2xx e faça o trabalho depois: uma resposta lenta ou falhada é enviada outra vez. O mesmo evento pode chegar mais de uma vez, por isso use o seu id para ignorar repetições.

CampoTipoSignificado
idstringIdentificador do evento; o mesmo em todas as tentativas de entrega.
typestringO nome do evento, por exemplo invoice.issued.
api_versionstringA versão da API em que o corpo é escrito.
tenant_idstringA empresa (espaço de trabalho) onde o evento aconteceu.
created_atstring (RFC 3339)Quando o evento foi registado.
request_idstringO pedido à API que causou a mudança, quando houve um; liga ao registo de pedidos.
data.resource_typestringO tipo do recurso que mudou.
data.resource_idstringO identificador desse recurso, para o ler na API.
data.attributesobjectCampos próprios de cada evento; podem não existir. Leia o recurso na API para o estado completo.
data.resource.sequenceintegerConta os eventos do mesmo recurso; ignore um evento que não seja mais recente do que o último que aplicou.

Outras categorias de eventos