Webhook personalizado
Webhook personalizado

O que é um webhook?

Um webhook (também chamado de retorno de chamada da Web ou API de push HTTP) é uma maneira de um aplicativo fornecer a outros aplicativos informações em tempo real. Um webhook entrega dados para outros aplicativos à medida que eles acontecem, o que significa que você obtém dados imediatamente. Ao contrário das APIs típicas, onde você precisaria pesquisar dados com muita frequência para obtê-los em tempo real. Isso torna os webhooks muito mais eficientes tanto para o provedor quanto para o consumidor.

Pegue o URL do seu webhook

Você pode encontrar o URL do webhook da sua notificação selecionando sua notificação na lista principal.

Solicitação básica de webhook

Método HTTP

Use o método POST para todas as suas solicitações de webhook.

Campos opcionais

Os webhooks de notificação de conversão não precisam de nenhum dos parâmetros abaixo, uma simples solicitação HTTP POST é suficiente.

Parâmetros do corpo POST somente para stream

Pesquisa automática de e-mail

Pesquisamos um endereço de e-mail nos dados do webhook automaticamente, mas ainda recomendamos seguir o formato abaixo.

Solicitar cabeçalhos

Certifique-se de que seu cabeçalho Content-Type corresponda ao formato do corpo do POST:

  • Para JSON , verifique se é Content-Type => application/json
  • Para dados de formulário, verifique se é Content-Type => application/x-www-form-urlencoded

Parâmetros básicos

Os parâmetros são usados ​​apenas em webhooks de notificação de stream:

  • (obrigatório) email - obrigatório, o email associado à conversão/lead (string)
  • timestamp - um timestamp numérico em milissegundos ou segundos (inteiro)
  • ip - o IP do usuário, para exibir a localização do usuário de conversão, Geo IP (string)
  • firstName - o primeiro nome do lead (exibido na notificação), se não for fornecido, pesquisaremos o nome usando o e-mail
  • lastName - o sobrenome do lead (somente a primeira letra é mostrada no ícone/avatar), se não for fornecido, pesquisaremos o nome usando o e-mail

{

    "email": "teste@gmail.com",

    "timestamp": 1528611279398, //opcional

    "ip": "141.92.55.102", //opcional

    "firstName": "João", //opcional

    "lastName": "Smith" //opcional

   "guid": "id" //opcional, identificador de produto/categoria

}

Parâmetros de localização

Parâmetros associados à localização da conversão/lead, alternativa à localização Geo IP ( opcional ):

  • cidade - a cidade
  • country - o país (se omitido, pesquisará usando countryCode)
  • countryCode - o código do país (se omitido, pesquisará usando country)
  • state - o nome do estado (relevante apenas para os EUA, se omitido, pesquisará usando stateCode)
  • stateCode - o código do estado (relevante apenas para os EUA, se omitido, pesquisará usando o estado)

{

    //TODOS SÃO OPCIONAIS

    "cidade": "Miami",

    "país": "Estados Unidos",

    "countryCode": "EUA",

    "estado": "Flórida",

    "stateCode": "FL"

}

Parâmetros de compra

O produto pode ser exibido após o texto da mensagem da notificação e ter a notificação vinculada automaticamente ao produto.

Adquira propriedades relacionadas ( opcional ):

  • productName - o nome do produto ( será anexado ao texto da mensagem)
  • productLink - o link/URL da página do produto (vai redirecionar para este link ao clicar)
  • productImage - o link/URL para a imagem do produto (será exibido na imagem de notificação)
  • total - valor total da compra
  • moeda - a moeda do valor do pedido

{

    //TODOS SÃO OPCIONAIS

    "total": 55,

    "moeda": "USD",

    "productName": "Tênis", //obrigatório

    "productLink": "https://sneakers.com/sneakers", //requerido

    "productImage": "https://sneakers.com/sneakers.jpg"

}

Parâmetros de vários produtos

Compras com vários produtos/itens de linha ( opcional ).

Se os produtos tiverem preço é exibido o mais caro, caso contrário é exibido o primeiro:

produtos - array de produtos associados ao evento (propriedades do objeto):

  • (obrigatório) nome - nome do produto a ser exibido na notificação (será anexado ao texto da mensagem) .
  • (obrigatório) link - link para a página do produto
  • id - o id do produto
  • imagem - imagem do produto (ideal: imagem 72x72)
  • preço - preço do produto
  • quantidade - número de itens comprados

{

    //OPCIONAL

    "produtos": [{

        "name": "T-Shirt", //requerido

        "link": "https://mystore.com/t-shirt", //requerido

        "id": 123, //pode ser uma string

        "image": "https://mystore.com/images/t-shirt.png",

        "preço": 55,

        "quantidade": 2

    }]

}

Deixe um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *