Clique na seta em "Copiar Página" para tirar dúvidas com a Inteligência Artificial.
Add new webhook
POST
https://evo-integracao-api.w12app.com.br/api/v1/webhook
Webhook
Criar Webhook
Descrição
Parâmetros do Webhook
| Parâmetro | Tipo | Descrição |
|---|---|---|
| idBranch | String | Número da filial onde o webhook será registrado. Apenas disponível ao usar uma chave multilocalização, ignorado caso contrário. |
| eventType | String | Especifica o tipo de evento que acionará este webhook. |
| urlCallback | String | URL que será chamada após o evento ocorrer. A API que receberá a requisição deve aceitar o tipo POST e o conteúdo no formato especificado. |
| headers | Array | Opcional. Lista de cabeçalhos personalizados que serão incluídos na requisição. Cada cabeçalho é um objeto com name (tipo: string) e value (tipo: string). |
| filters | Array | Opcional. Lista de filtros aplicáveis somente para webhooks do tipo 'NewSale'. Ler explicação abaixo. |
Campo filters
FilterType (string) → Tipo de filtro a ser aplicado. Atualmente, o tipo disponível é 'SaleItemDescription'.Value (string) → Valor utilizado para filtragem. A correspondência é feita por contém (substring), ou seja, se o valor informado estiver presente em qualquer parte da descrição do item de venda, o filtro será satisfeito.Regras de Avaliação de Múltiplos Filtros
"filters": [
{ "FilterType": "SaleItemDescription", "Value": "ANUAL" },
{ "FilterType": "SaleItemDescription", "Value": "MENSAL" }
]Payload Enviado no Disparo do Webhook
Estrutura de Payload
| Campo | Tipo | Descrição |
|---|---|---|
IdW12 | int32 | Identificador da conta W12 (empresa) onde o evento ocorreu. |
IdBranch | int32 | Identificador da filial relacionada ao evento. |
IdRecord | int32 | Identificador do registro gerado pelo evento (ex.: ID da venda, matrícula, cliente, etc.). |
EventType | string | Tipo do evento que disparou o webhook. O valor varia conforme o evento configurado (ex.: NewSale). |
ApiCallback | string | Endpoint da API de Integração do EVO onde é possível consultar os dados completos do evento ocorrido. |
Exemplo de Payload
{
"IdW12": 123,
"IdBranch": 1,
"IdRecord": 123,
"EventType": "NewSale",
"ApiCallback": "https://evo-integracao-api.w12app.com.br/api/v1/sales/123"
}Eventos Disponíveis
🏋️ Atividades e Acessos
| eventType | Descrição | ID Recebido |
|---|---|---|
| EndedSessionActivity | Ativado sempre que uma sessão da Grade é finalizada. | idActivitySession |
| Entries | Ativado sempre que uma passagem é registrada pelo controle de acesso. | IdEntry |
| ActivityEnroll | Ativado sempre que um aluno se agenda para uma atividade da grade. | idSession |
| SpotAvailable | Ativado sempre que uma atividade da grade, antes lotada, passa a ter vaga disponível. | idActivitySession |
| AppointmentEnroll | Ativado sempre que há um novo agendamento de atividade no módulo de agendamentos (EVO, Site/Totem/Fiti/API. | idActivitySession |
| CancelAppointment | Ativado sempre que há um cancelamento de agendamento de atividade no módulo de agendamentos (EVO, Site/Totem/Fiti/API. | idActivitySession |
| EndedSessionAppointment | Ativado sempre que a atividade da agen é finalizada no EVO (manual ou via cron job). | idActivitySession |
👤 Clientes (Membros)
| eventType | Descrição | ID Recebido |
|---|---|---|
| CreateMember | Ativado sempre que uma oportunidade é convertida em cliente. | idMember |
| AlterMember | Ativado sempre que as informações pessoais de um cliente são alteradas ou quando o cliente é excluído. Obs.: Não inclui mudança de status de ativo para inativo. | idMember |
| Freeze | Ativado sempre que é feita uma suspensão em um aluno ou quando a suspensão é removida. | idMemberMembership |
| TransferMember | Ativado sempre que um cliente (membro) é transferido de uma filial para outra. | idMember |
📄 Contratos (Membership e MemberMembership)
| eventType | Descrição | ID Recebido |
|---|---|---|
| CreateMembership | Ativado sempre que um novo tipo de contrato é criado. | idMembership |
| AlterMembership | Ativado sempre que uma informação do contrato é alterada. | idMembership |
| ScheduleCancelMembership | Ativado sempre que há um agendamento de cancelamento de contrato. | idMemberMembership |
| CancelMembership | Ativado sempre que um contrato é cancelado. | idMemberMembership |
💳 Financeiro
| eventType | Descrição | ID Recebido |
|---|---|---|
| ClearedDebt | Ativado sempre que um cliente paga um saldo devedor em aberto, seja manualmente pela recepção ou pela cobrança automatizada do sistema. | idSale |
| AlterReceivables | Ativado sempre que as informações de um recebimento no Contas a Receber são editadas. | idReceivable |
| NewInvoice | Ativado sempre que uma nova fatura é gerada no sistema (independente se foi criada por venda recorrente, avulsa ou lançamento manual). | id |
| CancelInvoice | Ativado sempre que uma fatura existente é cancelada no sistema. | id |
🎯 Oportunidades (Prospects)
| eventType | Descrição | ID Recebido |
|---|---|---|
| TransferProspect | Ativado sempre que uma oportunidade (prospect) é transferida de uma filial para outra. | idProspect |
📦 Produtos
| eventType | Descrição | ID Recebido |
|---|---|---|
| CreateProduct | Ativado sempre que um novo tipo de produto é criado. | |
| AlterProduct | Ativado sempre que um tipo de produto é alterado. |
🛠️ Serviços
| eventType | Descrição | ID Recebido |
|---|---|---|
| CreateService | Ativado sempre que um novo tipo de serviço é criado. | idService |
| AlterService | Ativado sempre que um tipo de serviço é alterado. | idService |
🛒 Vendas
| eventType | Descrição | ID Recebido |
|---|---|---|
| NewSale | Ativado sempre que uma nova venda é realizada no sistema EVO ou pelo Site/Totem. Obs.: Não inclui vendas geradas automaticamente pela recorrência. | idSale |
| RecurrentSale | Ativado sempre que um contrato é renovado automaticamente na recorrência. | idSale |
| SalesItensUpdated | Ativado sempre que um novo item de venda é adicionado em uma Página de Vendas. | idSaleItem |
Requisição
Parâmetros Bodyapplication/json-patch+json
Exemplos de Requisição
Respostas
Modificado em 2026-01-16 17:54:31