Skip to main content

​
Evento organization.created

Disparado para a organização da plataforma quando uma nova organização conectada é criada e vinculada a ela por POST /v1/organizations. data.object carrega o snapshot completo da organização conectada (identidade, dados fiscais, perfil público, endereço de cobrança, status de ativação financeira e conta bancária default quando preenchidos) para que você possa armazenar localmente sem chamadas extras à API.

​
Exemplo de payload

{
  "id": "evt_123",
  "object": "event",
  "created_at": "2026-04-28T13:42:11.000Z",
  "data": {
    "object": {
      "id": "org_789",
      "object": "organization",
      "activation_status": "activation_pending",
      "activation_status_updated_at": null,
      "avatar_url": "https://cdn.meusite.com/avatar.png",
      "bank_account": null,
      "billing_additional_info": null,
      "billing_address": null,
      "billing_name": null,
      "branding_settings": {
        "accent_color": null,
        "border_style": null,
        "brand_color": null,
        "font_family": null,
        "theme": null
      },
      "created_at": "2026-04-28T13:42:10.000Z",
      "document": "12345678000190",
      "document_type": "cnpj",
      "email": "contato@meusite.com",
      "livemode": true,
      "metadata": {},
      "name": "Acme Importadora",
      "platform": "plat_456",
      "socials": [
        {
          "platform": "instagram",
          "url": "https://instagram.com/meusite"
        }
      ],
      "updated_at": null,
      "website": "https://meusite.com"
    }
  },
  "livemode": true,
  "organization": "org_789",
  "request": {
    "id": null
  },
  "type": "organization.created"
}

​
Campos do payload

​
Payload

CampoTipoDescrição
idstringID único do evento (evt_*).
objectstringSempre "event".
created_atstringData/hora ISO 8601 da geração do evento.
livemodebooleanMesmo valor de data.object.livemode.
organizationstringID da organização conectada que originou o evento. Mesmo valor de data.object.id.
typestring"organization.created"

​
data

CampoTipoDescrição
objectobjectSnapshot da organização conectada criada. Ver tabela abaixo.

​
data.object

CampoTipoDescrição
idstringID público da organização conectada (org_*).
objectstringSempre "organization".
livemodebooleantrue em produção; false em ambiente de teste.
namestringNome ou razão social.
emailstring | nullE-mail principal da organização conectada.
avatar_urlstring | nullURL da imagem de perfil/logo, quando definida.
documentstring | nullCPF (PF) ou CNPJ (PJ), somente dígitos.
document_type"cpf" | "cnpj" | nullTipo fiscal.
websitestring | nullSite público da organização conectada.
socialsarrayLista de { platform, url }. platform é um enum: x, github, facebook, instagram, youtube, linkedin, other. Vazia quando não há redes cadastradas.
billing_namestring | nullNome usado em cobranças.
billing_addressobject | nullEndereço de cobrança quando informado. Campos: line1, line2, city, state, postal_code, country.
billing_additional_infostring | nullInformação adicional para cobranças (ex: setor responsável).
branding_settingsobjectIdentidade visual aplicada ao checkout hospedado. Campos não configurados vêm null.
created_atstringData/hora de criação da organização conectada.
updated_atstring | nullData/hora da última modificação da organização conectada.
activation_statusstringStatus de ativação financeira: activation_pending, pending, active ou disabled. Normalmente nasce como activation_pending; pode refletir um cadastro financeiro já conhecido para o mesmo documento.
activation_status_updated_atstring | nullData/hora ISO 8601 da última atualização de activation_status. null enquanto o status ainda não evoluiu.
bank_accountobject | nullObjeto bank_account conectado à organização. null quando ainda não há conta conectada.
platformstringID da sua plataforma (plat_*).
metadataobjectEco dos pares chave/valor que você passou em metadata na criação da organização. Objeto vazio ({}) quando você não passou nada.

​
Uso típico

switch (event.type) {
  case "organization.created": {
    const organization = event.data.object;
    await db.organizations.upsert({
      id: organization.id,
      name: organization.name,
      document: organization.document,
      activation_status: organization.activation_status,
      metadata: organization.metadata,
    });
    break;
  }
}