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

# Estrutura dos dados

> Todos os campos que a Assiny envia nos payloads de webhook

Nesta página estão todos os dados que enviamos nos payloads. Nas páginas abaixo há a separação entre "seções" do payload para simplificar.

As informações são as mesmas, porém nas seções específicas há mais detalhamento.

<CardGroup cols={2}>
  <Card title="Offer" icon="tag" href="/webhooks/estrutura/offer">
    Oferta, produto e order bumps envolvidos no evento.
  </Card>

  <Card title="Transaction" icon="receipt" href="/webhooks/estrutura/transaction">
    Valores, taxas, parcelas e status da transação.
  </Card>

  <Card title="Client" icon="user" href="/webhooks/estrutura/client">
    Dados de quem comprou, incluindo endereço.
  </Card>

  <Card title="Metadata" icon="chart-line" href="/webhooks/estrutura/metadata">
    UTMs, parâmetros de URL e origem do evento.
  </Card>
</CardGroup>

Os order bumps são enviados junto com o checkout principal (Entrada, Upsell ou Downsell), dentro do objeto `data.offer.order_bumps`.

## Tabela completa dos dados enviados

| Nome | Tipo | Descrição |
| - | - | - |
| `event` | string | Nome do evento |
| `data.offer.id` | UUID | Id da oferta criada na Assiny |
| `data.offer.name` | string | Nome da oferta criada na Assiny |
| `data.offer.type` | string | Tipo da oferta na Assiny (ENTRY, UPSELL, DOWNSELL) |
| `data.offer.recurrence` | string | Recorrencia em caso de oferta do tipo assinatura. Caso não seja uma assinatura, retornará "null" |
| `data.offer.amount` | integer | Valor da oferta configurado na Assiny |
| `data.offer.amount_client` | integer | É o valor que foi para o produtor/vendedor |
| `data.offer.amount_assiny` | integer | Valor da taxa da Assiny |
| `data.offer.amount_with_tax` | integer | Valor da oferta com juros |
| `data.offer.product.id` | string | Id do produto na Assiny |
| `data.offer.product.name` | string | Nome do produto na Assiny |
| `data.offer.product.producer_name` | string | Nome do produtor cadastrado no produto na Assiny |
| `data.offer.order_bumps` | array | Conjunto de produtos de orderbumps desta transação. Possui os mesmos campos do "offer" |
| `data.transaction.id` | UUID | Id da transação na Assiny |
| `data.transaction.project.name` | string | Nome do seu projeto na Assiny em que aconteceu a transação em questão |
| `data.transaction.project.id` | UUID | Id do seu projeto na Assiny em que aconteceu a transação em questão |
| `data.transaction.project.organization.id` | UUID | Id da sua organização na Assiny que é dona do projeto em questão |
| `data.transaction.project.organization.name` | string | Nome da sua organização na Assiny que é dona do projeto em questão |
| `data.transaction.amount` | integer | Soma dos amounts de todos os produtos na transação (produto principal + orderbumps) |
| `data.transaction.fee_amount` | integer | Valor da taxa da Assiny cobrada na transação |
| `data.transaction.net_amount` | integer | Valor líquido da transação |
| `data.transaction.commissions` | Array | Produtores que receberam valores da transação. Quando há uma co-produção, há mais de um item. |
| `data.transaction.installments` | integer | Número de parcelas da transação. Em casos à vista o valor vem 1 |
| `data.transaction.currency` | string | Moeda em que a transação foi feita. Segue o padrão ISO 4217. |
| `data.transaction.cycle` | integer | Qual o ciclo da assinatura a transação se refere. Quando não for assinatura retorna 1 |
| `data.transaction.created_at` | string | Data de criação da transação |
| `data.transaction.updated_at` | string | Data da última atualização da transação. |
| `data.transaction.status` | string | Status da transação. |
| `data.transaction.payment_type` | string | Tipo de pagamento na transação. Ex.: PIX, CREDIT\_CARD, BANK\_SLIP |
| `data.transaction.smart_installments` | Object | Informações relativa ao parcelamento inteligente. Caso null, não se aplica. |
| `data.transaction.additional_data.PIX` | string | Código copia cola para pagamento do PIX |
| `data.transaction.additional_data.BANK_SLIP.url` | string | Link de download do PDF do boleto |
| `data.transaction.additional_data.BANK_SLIP.barcode` | string | Código de barras do boleto |
| `data.client.id` | UUID | Id do cliente na Assiny |
| `data.client.full_name` | string | Nome completo do cliente |
| `data.client.first_name` | string | Primeiro nome do cliente |
| `data.client.last_name` | string | Último nome do cliente |
| `data.client.email` | string | Email do cliente usado na compra |
| `data.client.phone` | string | Numero de telefone do cliente usado na compra |
| `data.client.document` | string | Documento do cliente (CPF por padrão no Brasil) |
| `data.client.address.street` | string | Rua do endereço que o cliente adicionou no checkout. |
| `data.client.address.number` | string | Numero do endereço do cliente |
| `data.client.address.complement` | string | Complemento do endereço. Ex.: Apartamento 1002 |
| `data.client.address.neighborhood` | string | Bairro do endereço do cliente |
| `data.client.address.city` | string | Cidade do endereço do cliente |
| `data.client.address.state` | string | Estado do endereço do cliente |
| `data.client.address.country` | string | País do endereço do cliente |
| `data.client.address.zipcode` | string | Código do endereço do cliente. No Brasil é o CEP. |
| `data.metadata.utm_campaign` | string | UTM Campaign adicionado na URL nas campanhas publicitárias. |
| `data.metadata.utm_content` | string | UTM Content adicionado na URL nas campanhas publicitárias. |
| `data.metadata.utm_medium` | string | UTM Medium adicionado na URL nas campanhas publicitárias. |
| `data.metadata.utm_source` | string | UTM Source adicionado na URL nas campanhas publicitárias. |
| `data.metadata.utm_term` | string | UTM Term adicionado na URL nas campanhas publicitárias. |
| `data.metadata.ip` | string | IP do usuário que gerou o evento |
| `data.metadata.user_agent` | string | Informações sobre o sistema operacional e navegador do usuário que gerou o evento |
| `data.metadata.url_parameters.fbclid` | string | Id do usuário na integração de pixel da Meta |
| `data.metadata.url_parameters.fbp` | string | Informações referentes ao pixel da Meta configurado no funil |
| `data.metadata.url_parameters.nodeId` | string | Id do nó do funil configurado na Assiny. É o identificador de qual "bloco" de oferta do funil esse evento aconteceu. |
| `data.metadata.url_parameters.referrer` | string | Parâmetro de URL para traquear indicações. |
| `data.metadata.url_parameters.saveCard` | bool | Caso o cliente tenha escolhido salvar as informações de pagamento via cartão, este campo vem como "true". Caso contrário, "false". |
| `data.metadata.funnel_id` | UUID | Id do funil na Assiny |
| `data.metadata.short_funnel_id` | string | Identificador curto do funil. Usado principalmente para as URLs do checkout |
| `data.metadata.event_source_url` | string | URL do checkout em que aconteceu o evento |

<Warning>
  O `data.client.address` só virá caso a oferta possuir o formulário de endereço ativo nas configurações. Caso contrário o endereço não é obrigatório para o cliente na compra.
</Warning>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.