Webhook Integrado - Como Transformar o Body no Corpo da Requisição

Webhooks são uma ferramenta essencial para a integração entre diferentes sistemas. Eles permitem que eventos ocorridos em um sistema sejam enviados automaticamente para outro, facilitando a automação

Na plataforma SprintHub, configurar um webhook de forma eficiente pode ser simples, desde que você entenda como mapear e transformar o corpo da requisição (body) adequadamente.

O que é corpo da requisição?

O corpo da requisição, ou "body", é a parte de uma requisição HTTP que contém os dados enviados para o servidor. Em uma configuração de webhook, esses dados geralmente são enviados em formato JSON e contêm informações específicas sobre o evento que acionou o webhook, como a criação de um pedido, atualização de um cliente, entre outros.

Configurando o Webhook na Sprinthub

1. Criando uma Nova Integração

1. Nome e Alias: Escolha um nome descritivo e um alias para a sua integração, que facilite sua identificação.

2. Método: Defina o método HTTP apropriado (geralmente POST).

3. Chave Secreta: Insira a chave secreta fornecida pela SprintHub para garantir a segurança das suas requisições.

4. Corpo Esperado: Selecione o formato esperado para o corpo da requisição (normalmente, JSON).

2. Mapeamento de Entrada

Na seção de mapeamento de entrada, você deve definir como os dados recebidos no body serão mapeados e utilizados na plataforma SprintHub.

Mapeamento Automático: Envie uma requisição de teste para que a plataforma capture o JSON enviado.

Se for mapeamento automático, NORMALMENTE a plataforma externa já vai deixar o corpo montado corretamente. Mas é necessário verificar a validação dos dados ao requisitar.

Parâmetros do Corpo da Requisição: Aqui, você deve mapear os campos do JSON para os campos que serão utilizados na SprintHub.

Por exemplo, se você está recebendo um JSON como o abaixo:

{
  "event": "order.created",
  "data": {
    "customer": {
      "id": "987654321",
      "name": "John Doe"
    },
    "items": [
      {
        "product_id": "ABC123",
        "quantity": 2,
        "price": 19.99
      }
    ]
  }
}

No mapeamento, você pode definir que o campo event será mapeado para data.event, e assim por diante. No caso do product_id, como ele está dentro de um array, você precisaria especificar a posição, como data.items[0].product_id, caso queira o primeiro item.

Conclusão

Transformar o body no corpo da requisição na SprintHub é um processo fundamental para garantir que seus webhooks funcionem corretamente e que as informações sejam capturadas e utilizadas de forma eficaz. Com o mapeamento correto e uma configuração bem planejada, você pode automatizar processos complexos e melhorar a integração entre sistemas na sua organização.

Dica: Sempre teste suas integrações com dados reais para garantir que tudo esteja funcionando conforme o esperado. E lembre-se de documentar suas configurações para futuras manutenções.