Documentação Webhook - Assinaturas
Introdução
Este documento tem como objetivo apresentar a estrutura e os padrões dos webhooks da Celetus, utilizados para facilitar integrações com sistemas externos no que diz respeito ao ciclo de vida das assinaturas.
Através dos webhooks aqui demonstrado, a Celetus envia disparos para uma URL configurada no apps Webhook (Veja Como configurar Webhooks Celetus) e em tempo real sempre que eventos importantes relacionados às assinaturas ocorrem em nossa plataforma. Isso permite que sistemas terceiros sejam atualizados ou acionem ações automaticamente, garantindo sincronização, automação e eficiência nos processos.
Se você estiver desenvolvendo uma integração com a Celetus, esta documentação será essencial para garantir uma comunicação segura, eficiente e alinhada aos eventos críticos de assinatura.
📡 SubscriptionCompleted
Este webhook é enviado quando uma assinatura é concluída com sucesso. Abaixo estão os campos retornados no payload.
🔗 Estrutura do Payload
{
"id": "00000000-0000-0000-0000-000000000000",
"event_name": "Nome do Webhook",
"event_type": "SubscriptionCompleted",
"payment_method": "Pix",
"event_type_identifier": "SubscriptionCompleted.SubscriptionCompleted",
"order_id": "91d97938-9c75-4a43-8471-1fa754aa9c03",
"order_code": "V93ET2DCKV",
"order_status": "SubscriptionCompleted",
"created_date": "2024-07-19T17:06:59.25843+00:00",
"approved_date": null,
"refunded_date": null,
"customer": { ... },
"items": [ ... ],
"charge": { ... },
"lostSaleData": { ... },
"trackingParameters": { ... },
"commission": { ... },
"seller_name": "Nome do Vendedor",
"seller_type": "Produtor"
}
📡 SubscriptionCanceled
Este webhook é enviado quando uma assinatura é cancelada. Abaixo estão os campos retornados no payload.
🔗 Estrutura do Payload
{
"id": "00000000-0000-0000-0000-000000000000",
"event_name": "Nome do Webhook",
"event_type": "SubscriptionCanceled",
"payment_method": "Pix",
"event_type_identifier": "SubscriptionCanceled.SubscriptionCanceled",
"order_id": "91d97938-9c75-4a43-8471-1fa754aa9c03",
"order_code": "V93ET2DCKV",
"order_status": "SubscriptionCompleted",
"created_date": "2024-07-19T17:06:59.25843+00:00",
"approved_date": null,
"refunded_date": null,
"customer": { ... },
"items": [ ... ],
"charge": { ... },
"lostSaleData": { ... },
"trackingParameters": { ... },
"commission": { ... },
"seller_name": "Nome do Vendedor",
"seller_type": "Produtor"
}
📡 SubscriptionBlocked
Este webhook é enviado quando uma assinatura é bloqueada. Abaixo estão os campos retornados no payload.
🔗 Estrutura do Payload
{
"id": "00000000-0000-0000-0000-000000000000",
"event_name": "Nome do Webhook",
"event_type": "SubscriptionBlocked",
"payment_method": "Pix",
"event_type_identifier": "SubscriptionBlocked.SubscriptionBlocked",
"order_id": "91d97938-9c75-4a43-8471-1fa754aa9c03",
"order_code": "V93ET2DCKV",
"order_status": "SubscriptionCompleted",
"created_date": "2024-07-19T17:06:59.25843+00:00",
"approved_date": null,
"refunded_date": null,
"customer": { ... },
"items": [ ... ],
"charge": { ... },
"lostSaleData": { ... },
"trackingParameters": { ... },
"commission": { ... },
"seller_name": "Nome do Vendedor",
"seller_type": "Produtor"
}
📡 SubscriptionActive
Este webhook é enviado quando uma assinatura é ativada com sucesso. Abaixo estão os campos retornados no payload.
🔗 Estrutura do Payload
{
"id": "00000000-0000-0000-0000-000000000000",
"event_name": "Nome do Webhook",
"event_type": "SubscriptionActive",
"payment_method": "Pix",
"event_type_identifier": "SubscriptionActive.SubscriptionActive",
"order_id": "91d97938-9c75-4a43-8471-1fa754aa9c03",
"order_code": "V93ET2DCKV",
"order_status": "SubscriptionCompleted",
"created_date": "2024-07-19T17:06:59.25843+00:00",
"approved_date": null,
"refunded_date": null,
"customer": { ... },
"items": [ ... ],
"charge": { ... },
"lostSaleData": { ... },
"trackingParameters": { ... },
"commission": { ... },
"seller_name": "Nome do Vendedor",
"seller_type": "Produtor"
}
📡 SubscriptionDelayed
Este webhook é enviado quando uma assinatura está atrasada. Abaixo estão os campos retornados no payload.
🔗 Estrutura do Payload
{
"id": "00000000-0000-0000-0000-000000000000",
"event_name": "Nome do Webhook",
"event_type": "SubscriptionDelayed",
"payment_method": "Pix",
"event_type_identifier": "SubscriptionDelayed.SubscriptionDelayed",
"order_id": "91d97938-9c75-4a43-8471-1fa754aa9c03",
"order_code": "V93ET2DCKV",
"order_status": "SubscriptionCompleted",
"created_date": "2024-07-19T17:06:59.25843+00:00",
"approved_date": null,
"refunded_date": null,
"customer": { ... },
"items": [ ... ],
"charge": { ... },
"lostSaleData": { ... },
"trackingParameters": { ... },
"commission": { ... },
"seller_name": "Nome do Vendedor",
"seller_type": "Produtor"
}
🧾 Campos de Nível Raiz (Top-Level)
Campo | Tipo | Descrição | Valores Enviados |
|---|---|---|---|
id | string | Identificador interno da Celetus. |
|
event_name | string | Nome cadastrado do webhook. |
|
event_type | string | Tipo do evento que disparou o webhook | BoletoGenerated, PixGenerated, PurchaseDeclined, ApprovedPurchase, Chargeback, ExpiredPurchase, LatePurchase, WaitingPayment, AbandonedCheckout, Protested, Refunded, Affiliation, SubscriptionActive, SubscriptionCanceled, SubscriptionDelayed, SubscriptionBlocked, SubscriptionCompleted |
payment_method | string | Método de pagamento utilizado. | boleto, pix, credit_card, two_credit_card |
event_type_identifier | string | Identificador do tipo de evento (event_type + order_status). |
|
order_id | string | Identificador do pedido. |
|
order_code | string | Código do pedido. |
|
order_status | string | Status do pedido. | Approved, Complete, Blocked, PurchaseDeclined, NoFunds, Expired, Overdue, WaitingPayment, ProcessingTransaction, Abandoned, Protested, Refunded, Chargeback, UnderAnalisys, SubscriptionActive, SubscriptionCanceled, SubscriptionDelayed, SubscriptionBlocked, SubscriptionCompleted |
created_date | string | Data de criação do pedido. |
|
approved_date | string/null | Data de aprovação, se houver. |
|
refunded_date | string/null | Data de reembolso, se houver. |
|
👤 Customer - Dados do Cliente
Campo | Tipo | Descrição |
|---|---|---|
id | string | ID do cliente. |
name | string | Nome completo do cliente. |
phone | string | Telefone do cliente. |
string | E-mail do cliente. | |
document | string | CPF ou CNPJ do cliente. |
🏠 Customer - Endereço do Cliente
Campo | Tipo | Descrição |
|---|---|---|
id | string | ID do endereço. |
street | string | Nome da rua. |
number | string | Número do imóvel. |
complement | string | Complemento (opcional). |
zip_code | string | CEP. |
neighborhood | string | Bairro. |
city | string | Cidade. |
state | string | Estado (sigla). |
country | string | País (sigla ISO, ex: BR). |
reference | string | Referência (opcional). |
🛒 Itens do Pedido
Campo | Tipo | Descrição | Valores Enviados |
|---|---|---|---|
id | string | ID do item. |
|
code | string | Código do item. |
|
name | string | Nome do produto ou serviço. |
|
amount | number | Valor unitário. |
|
quantity | integer | Quantidade adquirida. |
|
item_type | string | Tipo do item. | Principal, Orderbump, Upsell |
offer_name | string | Nome da oferta. |
|
item_type_sale | string | Tipo de venda. | Produto Único, Assinatura |
frequency | string/null | Frequência da recorrência. | Semanal, Mensal, Bimestral, Trimestral, Simestral, Anual |
💳 Dados da Cobrança
Campo | Tipo | Descrição | Valores Enviados |
|---|---|---|---|
id | string | ID da cobrança. |
|
code | string | Código da cobrança. |
|
status | string | Status da cobrança. | paid, pending, failed, processing, canceled, chargeback, refunded, refund_claimed |
amount | string | Valor total da cobrança. |
|
gateway_response | string/null | Resposta do gateway de pagamento. |
|
📉 Dados de Venda Perdida
Campo | Tipo | Descrição |
|---|---|---|
LostSaleId | string/null | ID da venda perdida. |
Product | string/null | Produto relacionado. |
Producer | string/null | Nome do produtor. |
CoProducers | string/null | Co-produtores envolvidos. |
Affialted | string/null | Afiliado responsável. |
LeadName | string/null | Nome do lead. |
LeadEmail | string/null | E-mail do lead. |
LeadPhone | string/null | Telefone do lead. |
LeadZipCode | string/null | CEP do lead. |
CreatedDate | string/null | Data de criação do lead. |
CheckoutModelId | string/null | ID do modelo de checkout. |
CheckoutModelName | string | Nome do modelo de checkout. |
TenantId | string | ID do tenant. |
TenantName | string | Nome do tenant. |
📍 Parâmetros de Rastreamento
Campo | Tipo | Descrição |
|---|---|---|
sck | string | Tracking SCK. |
src | string | Tracking SRC. |
utm_campaign | string | Campanha UTM. |
utm_content | string | Conteúdo UTM. |
utm_medium | string | Meio UTM (ex: e-mail, cpc). |
utm_source | string | Fonte UTM (ex: Google, Facebook). |
utm_term | string | Termo UTM (palavra-chave). |
💰 Dados da Comissão
Campo | Tipo | Descrição |
|---|---|---|
totalPrice | number | Valor total da venda. |
gatewayFee | number | Taxa do gateway. |
userCommission | number | Comissão do usuário. |
currency | string | Moeda (ex: BRL). |
coproducers | string/null | Comissão para co-produtores (se houver). |
affiliated | string/null | Comissão para afiliados (se houver). |
🧑💼 Dados do Vendedor
Campo | Tipo | Descrição |
|---|---|---|
seller_name | string | Nome do vendedor. |
seller_type | string | Tipo do vendedor (ex: Produtor). |
**
Atualizado em: 19/05/2025
Obrigado!