Skip to main content

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 suborganization.created

Disparado para a organização da plataforma quando uma nova sub-organização é criada e vinculada a ela. Para fluxos hospedados, isso acontece na criação do hosted_flow, antes da conclusão do cadastro financeiro.
Quando a origem é um hosted flow, hosted_flow.completed também é disparado para o mesmo flow. A ordem de entrega entre os dois não é garantida — workers de retry podem inverter. Cada evento é idempotente pelo seu id.

Payload de Exemplo

{
  "type": "suborganization.created",
  "id": "evt_3KLm9XPq",
  "timestamp": "2026-04-28T13:42:11.000Z",
  "data": {
    "suborganization": {
      "id": "org_seller_new"
    },
    "parent_organization_id": "org_platform_owner",
    "platform_id": "plat_abc",
    "hosted_flow_id": "hf_abc123",
    "platform_reference": {
      "external_reference": "airbee_seller_456",
      "metadata": {
        "airbee_workspace_id": "ws_789"
      }
    }
  }
}

Campos do Payload

CampoTipoDescrição
typestring"suborganization.created"
idstringID único do evento (evt_*).
timestampstringData/hora ISO 8601.
data.suborganization.idstringID da sub-organização criada (org_*).
data.parent_organization_idstringID da organização da plataforma (destino do webhook).
data.platform_idstringID da plataforma.
data.hosted_flow_idstring | absentID do hosted flow que criou o vínculo. Presente quando a origem foi Hosted flows.
data.platform_referenceobjectPresente quando você passou external_reference e/ou metadata na criação do flow. Echo dos valores.

Uso Típico

switch (event.type) {
  case 'suborganization.created': {
    const { suborganization, hosted_flow_id, platform_reference } = event.data
    await db.subOrgs.upsert({
      id: suborganization.id,
      hosted_flow_id,
      airbee_seller_id: platform_reference?.external_reference ?? null,
      airbee_metadata: platform_reference?.metadata ?? {},
    })
    break
  }
}