Criar Webhook

Descrição

Os webhooks permitem que o EVO notifique sistemas externos sempre que ocorrer um evento específico. Com isso, é possível integrar outros sistemas ao EVO e automatizar ações baseadas nos eventos capturados.

OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

📨 Corpo da Requisição (Request Body)

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	Arrayobject	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	Arrayobject	Opcional. Lista de filtros aplicáveis somente para webhooks do tipo 'NewSale'. Ler explicação abaixo.

🧩 Estrutura do Objeto `filters`

Cada filtro deve ser um objeto com os campos:

Parâmetro	Tipo	Descrição
`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

Quando mais de um filtro for cadastrado, a validação é feita como uma condição OU. Exemplo:

"filters": [
  { "FilterType": "SaleItemDescription", "Value": "ANUAL" },
  { "FilterType": "SaleItemDescription", "Value": "MENSAL" }
]

Nesse caso, o webhook será disparado sempre que a descrição do item de venda contiver "ANUAL" ou "MENSAL".

📤🪝 Payload recebido após disparo do Webhook

Sempre que um evento configurado ocorrer, o EVO realizará uma requisição HTTP POST para a urlCallback informada no cadastro do webhook, enviando no corpo da requisição um objeto padrão de notificação do evento.

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"
}

O formato do objeto é sempre o mesmo para todos os eventos. As únicas variações são:

EventType: assume o nome do evento que foi disparado.

ApiCallback: cada tipo de evento possui um endpoint específico para consulta detalhada na API de Integração.

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 realiza o pagamento de um saldo vencido, ou seja, apenas quando a quitação ocorre APÓS a data de vencimento, seja manualmente pela recepção ou por cobrança automatizada do sistema.	`idSale`
AlterReceivables	Ativado sempre que as informações de um recebimento no Contas a Receber são editadas manualmente. Atualizações automáticas, como de status de pagamento, não disparam este evento.	`idReceivable`
NewInvoice	Ativado sempre que uma nova nota fiscal enviada para emissão é de fato emitida (independente se foi criada por venda recorrente, avulsa ou lançamento manual).	`id`
CancelInvoice	Ativado sempre que uma nota fiscal existente no sistema com status de emitida é cancelada.	`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.	`id`
AlterProduct	Ativado sempre que um tipo de produto é alterado.	`id`

🛠️ 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`

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/webhook' \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json-patch+json' \ --data '{ "idBranch": 0, "eventType": "string", "urlCallback": "string", "headers": [ { "nome": "string", "valor": "string" } ], "filters": [ { "filterType": "string", "value": "string" } ] }'

Add new webhook

Criar Webhook

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `filters`

📄 Regras de Avaliação de Múltiplos Filtros

📤🪝 Payload recebido após disparo do Webhook

📝 Exemplo de Payload

Eventos Disponíveis

🏋️ Atividades e Acessos

👤 Clientes (Membros)

📄 Contratos (Membership e MemberMembership)

💳 Financeiro

🎯 Oportunidades (Prospects)

📦 Produtos

🛠️ Serviços

🛒 Vendas

Request

Responses

Add new webhook

Criar Webhook#

Descrição#

📨 Corpo da Requisição (Request Body)#

🧩 Estrutura do Objeto filters#

📄 Regras de Avaliação de Múltiplos Filtros#

📤🪝 Payload recebido após disparo do Webhook#

📝 Exemplo de Payload#

Eventos Disponíveis#

🏋️ Atividades e Acessos#

👤 Clientes (Membros)#

📄 Contratos (Membership e MemberMembership)#

💳 Financeiro#

🎯 Oportunidades (Prospects)#

📦 Produtos#

🛠️ Serviços#

🛒 Vendas#

Request

Responses

Criar Webhook

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `filters`

📄 Regras de Avaliação de Múltiplos Filtros

📤🪝 Payload recebido após disparo do Webhook

📝 Exemplo de Payload

Eventos Disponíveis

🏋️ Atividades e Acessos

👤 Clientes (Membros)

📄 Contratos (Membership e MemberMembership)

💳 Financeiro

🎯 Oportunidades (Prospects)

📦 Produtos

🛠️ Serviços

🛒 Vendas