Como usar o webhook

Os webhooks do EVO permitem que o EVO notifique outros sistemas sempre que um evento específico ocorrer, facilitando a automação de processos e a integração entre plataformas. Abaixo está o passo a passo detalhado para criar um webhook no EVO.

O que é um Webhook?

Um webhook é uma forma de notificação em tempo real, onde o sistema EVO envia informações para uma URL externa sempre que um evento específico ocorre (como uma venda realizada, um cliente registrado, etc.). Leia mais.

Passo 1: Obtenha a URL de callback

O primeiro passo para configurar um webhook é ter uma URL de callback. Essa URL será o ponto de recepção dos dados enviados pelo EVO.

O que é a URL de callback?

É a URL de um servidor ou API externa que estará pronta para receber requisições POST com os dados do evento.

É obrigatório que o protocolo seja HTTPS.

Um site que pode ser utilizado para realizar testes é https://webhook.site/, cadastrando um webhook com a URL disponível no site.

Passo 2: Escolha o tipo de evento

Escolha o tipo de evento que irá disparar o webhook.

O EVO oferece vários tipos de eventos, como NewSale, CreateMember, AlterMember, entre outros. Os eventos disponíveis e a descrição de cada um está no endpoint de adicionar novo webhook

Exemplos de eventos:

NewSale: Disparado quando uma venda é realizada.

CreateMember: Disparado quando uma oportunidade se torna um cliente.

NewInvoice: Disparado sempre que uma nova fatura é gerada no sistema.

Passo 3: Determine os parâmetros necessários

Ao configurar o webhook, você precisa preencher alguns parâmetros obrigatórios e, opcionalmente, parâmetros adicionais.

Parâmetros obrigatórios:

eventType: Tipo de evento que acionará o webhook (ex: NewSale).

urlCallback: A URL externa que receberá os dados do evento.

Parâmetros opcionais:

IdBranch: Número da filial onde o evento ocorreu (caso use multilocalização).

headers: Cabeçalhos personalizados, como um token de autenticação.

filters: Filtros aplicáveis (ex: filtrar apenas vendas de um item específico).

Passo 4: Envie uma Requisição POST

Para registrar o webhook no EVO, envie uma requisição POST com os parâmetros definidos. Você pode usar a nossa documentação para fazer isso.

Exemplo de estrutura JSON para o webhook:

{
   "IdBranch": "1", 
   "eventType": "NewSale", 
   "urlCallback": "https://meusistema.com/webhook/callback", 
   "headers": [
        {"name": "Authorization", "value": "Bearer token"}
    ],
   "filters": [
        {
            "FilterType": "SaleItemDescription", 
            "Value": "Produto A"
        }
    ]
}

Como usar o webhook

O que é um Webhook?#

Passo 1: Obtenha a URL de callback#

Passo 2: Escolha o tipo de evento#

Passo 3: Determine os parâmetros necessários#

Parâmetros obrigatórios:#

Parâmetros opcionais:#

Passo 4: Envie uma Requisição POST#

Exemplo de estrutura JSON para o webhook:#