Como configurar Webhooks?
Webhooks permitem que a Amplifique.me notifique seu sistema automaticamente quando uma resposta de pesquisa é recebida. Veja os eventos disponíveis, o payload completo e como configurar o endpoint receptor.
Visão geral
Os Webhooks da Amplifique.me funcionam na direção inversa das integrações: ao invés de sistemas externos enviarem dados para a Amplifique.me, a Amplifique.me envia dados para o seu sistema quando um evento ocorre dentro da plataforma.
Use Webhooks para:
- Registrar respostas de pesquisa no seu CRM ou ERP em tempo real
- Disparar automações internas quando um Detrator responde
- Recuperar respondentes que abandonaram a pesquisa no meio
- Alimentar dashboards e ferramentas de BI com dados de CX ao vivo
Eventos disponíveis
| Evento | Quando é disparado |
|---|---|
cf_response | Nova resposta de pesquisa finalizada pelo respondente |
cf_response_incomplete | Resposta em andamento ou abandonada — há perguntas respondidas, mas o respondente parou sem enviar |
O cf_response_incomplete é opt-in e entrega um snapshot parcial, que pode ser seguido de um cf_response para a mesma resposta. Veja a referência completa do evento antes de habilitar.
Payload do evento cf_response
{
"event": {
"event_type": "cf_response",
"customer": {
"name": "Nome do Respondente",
"email": "email@respondente.com",
"phone": "Telefone do Respondente",
"custom_fields": {
"cpf": "Campo Customizado CPF"
},
"_business": "ID_DA_CONTA"
},
"cf_response": {
"responses": [
{
"answer": "10",
"question": "Em uma escala de 0 a 10, qual é a probabilidade de você recomendar a Empresa para um amigo?",
"type": "nps",
"internal_name": "nps_1"
},
{
"answer": "7",
"question": "A empresa facilitou a resolução do meu problema?",
"type": "ces",
"internal_name": "ces_3"
},
{
"answer": "4",
"question": "O quão satisfeito você está com o serviço prestado?",
"type": "csat",
"internal_name": "csat_2"
},
{
"answer": "Opção 1",
"question": "Texto da pergunta",
"type": "unique",
"internal_name": "unique_4"
},
{
"answer": "Opção 1,Opção 2",
"question": "Texto da pergunta",
"type": "multiple",
"internal_name": "multiple_5"
},
{
"answer": "texto livre",
"question": "Texto da pergunta",
"type": "text",
"internal_name": "text_6"
},
{
"answer": "Opção 1",
"question": "Texto da pergunta",
"type": "select",
"internal_name": "select_7"
}
],
"finalized": true,
"channel": "Link",
"origin": "Link1",
"created_at": "2021-09-16T17:48:50.035Z",
"sent_at": "2021-09-16T17:48:50.033Z",
"opened_at": "2021-09-16T17:48:50.667Z",
"finalized_at": "2021-09-16T17:49:07.410Z",
"last_interaction_at": "2021-09-16T17:49:07.410Z",
"_survey": "ID_DA_PESQUISA"
}
}
}
Tipos de pergunta no payload
type | Tipo de pergunta |
|---|---|
nps | Net Promoter Score (0–10) |
csat | Customer Satisfaction Score |
ces | Customer Effort Score |
text | Pergunta aberta de texto |
unique | Escolha única |
multiple | Múltipla escolha |
select | Lista suspensa |
Campos de data/hora
| Campo | Descrição |
|---|---|
created_at | Quando a solicitação foi criada |
sent_at | Quando a pesquisa foi enviada ao respondente |
opened_at | Quando o respondente abriu a pesquisa |
finalized_at | Quando a resposta foi finalizada |
last_interaction_at | Última interação do respondente com a pesquisa |
Como configurar
Prepare seu endpoint receptor
Crie um endpoint na sua aplicação que aceite requisições POST com body em JSON. O endpoint deve retornar HTTP 200 (ou 201) para confirmar o recebimento — qualquer outro status é tratado como falha e gera retentativas.
Acesse Configurações → Webhooks na plataforma
No menu lateral, vá em Configurações → Webhooks e adicione a URL do seu endpoint.
Selecione os eventos e salve
Marque os eventos que esse endpoint deve receber — cf_response, cf_response_incomplete ou ambos — e salve. A Amplifique.me passa a notificar seu endpoint a cada ocorrência.
Teste com uma resposta real
Envie uma resposta de teste para a pesquisa configurada e verifique se seu endpoint recebeu o payload corretamente.
Use ferramentas como webhook.site ou RequestBin para inspecionar o payload recebido durante o desenvolvimento.
Perguntas frequentes
Próximo passo
Documentação da API Amplifique.me
Acesse a referência completa de endpoints para integrações programáticas avançadas.