O que é Webhook?

Um webhook no desenvolvimento web é um método para aumentar ou alterar o comportamento de uma aplicação web, com callbacks personalizados. Esses callbacks podem ser mantidos, modificados e gerenciados por usuários e desenvolvedores terceirizados que podem não ser necessariamente afiliados à aplicação original.

QuestionPro suporta webhooks de entrada e de saída. Os webhooks podem ser invocados antes do início da pesquisa, durante a pesquisa (antes ou depois de uma pergunta) ou após a conclusão da pesquisa.

O que são webhooks de entrada?

Webhooks de entrada são uma maneira simples de buscar dados de fontes externas para sua pesquisa.

O que são webhooks de saída?

Webhooks de saída podem ser usados para enviar dados de pesquisa para uma fonte externa. Eles usam solicitações HTTP normais com um payload JSON.

Como configurar webhooks?

Para criar um webhook:

Vá para: Survey >> Integrations >> Webhooks

Clique no botão Add New Webhook.
Insira uma descrição para o seu webhook
Selecione o tipo necessário (entrada / saída)
Escolha quando o webhook deve ser invocado.
Clique em Salvar Alterações

Depois que o webhook for adicionado, você precisará fornecer os dados necessários para fazer a chamada da API:

API URL: O URL do endpoint para fazer uma chamada da API.
Method: O método HTTP usado para fazer a chamada.
Request Header: Campos de cabeçalho HTTP que são componentes da seção de cabeçalho da solicitação
Request JSON: Dados de payload necessários pela API. Você também pode usar o botão Inserir Resposta para inserir a resposta no JSON da Solicitação.

Depois de preencher os detalhes acima, clique no botão Save.

Como usar os dados recuperados de um webhook de entrada?

Você pode salvar os dados recuperados do recurso externo mapeando-os para variáveis personalizadas. Para abrir a caixa de diálogo de mapeamento, clique no botão Add Custom Mapping:

Você pode mapear os dados para variáveis personalizadas atribuindo chaves JSON individuais a variáveis personalizadas específicas. Você também pode atribuir um nome relevante às variáveis personalizadas:

Depois que o mapeamento for definido, os dados coletados podem ser exibidos na pesquisa usando o seguinte código: ${DisplayName}

Como fornecer dados para um webhook de saída?

No caso de webhooks de saída, você pode enviar os dados coletados em variáveis personalizadas para um serviço web externo adicionando as variáveis personalizadas no JSON da Solicitação:

Variáveis de Substituição de Dados

Para buscar os dados das Variáveis Personalizadas, você pode usar as seguintes tags para as Variáveis Personalizadas correspondentes no JSON da solicitação:

Variável Personalizada 1: ${custom1}

Variável Personalizada 2: ${custom2}

Variável Personalizada 3: ${custom3}

Variável Personalizada 4: ${custom4}

Variável Personalizada 5: ${custom5}

Variável Personalizada N: ${customN}

Como saberei se o Webhook foi executado com sucesso ou falhou?

O QuestionPro fornece um recurso de logs para cada webhook onde você pode verificar os detalhes da API que foi chamada por esse webhook, juntamente com o payload e a resposta do endpoint. Para acessar os logs, vá para um webhook específico e role até a parte inferior da página, onde você pode visualizar as solicitações feitas por esse webhook e, ao clicar no ID, você pode verificar os detalhes de qualquer chamada específica.

Além disso, se algumas chamadas de saída falharem ao enviar os dados, um botão Manual Retry estará disponível na frente dessas chamadas da API, no qual você pode clicar a qualquer momento para enviar os dados de volta para o endpoint da API.