Passo a Passo para Criar um Webhook no EVO

Os webhooks do EVO permitem que o sistema 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.

Passo 1: Compreenda 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.). Isso permite a automação de processos e a integração com outros sistemas.

Passo 2: 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 utilizar para realizar teste é https://webhook.site/

Passo 3: 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. A descrição de cada um está na descrição do Endpoint Create Webhook

Exemplos de eventos:

NewSale: Quando uma venda é realizada.
CreateMember: Quando uma oportunidade se torna um cliente.
AlterMember: Quando as informações de um cliente são alteradas.

Passo 4: 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 5: Envie uma Requisição POST

Para registrar o webhook no EVO, envie uma requisição POST com os parâmetros definidos. Você pode usar ferramentas como Postman, Insomnia ou até um código em Python, Node.js, ou cURL para isso.

Exemplo de estrutura JSON para o webhook:

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