Webhooks - Payload de exemplo

Quando você configura o seu formulário para enviar uma webhook, a url destino irá receber uma requisição HTTP do tipo POST com um payload similar a este abaixo:

{
  "form": {
    "form_name": "Teste de webhook",
    "form_id": "CImh9589"
  },
  "respondent": {
    "date": "2022-01-01 14:00",
    "respondent_id": "109fc39c-d8a8-4bb3-94fe-e20cc0613cd4",
    "score": 10,
    "status": "completed",
    "respondent_utms": {
      "utm_source": "exemplo",
      "utm_medium": "exemplo",
      "utm_campaign": "exemplo",
      "utm_term": "exemplo",
      "utm_content": "exemplo"
    },
    "answers": {
      "Qual o seu nome?": "Fernando",
      "Qual seu e-mail?": "exemplo@exemplo.com",
      "Qual sua fruta favorita?": "Banana",
      "Qual seu endereço?": "Rua Guarará, 123. São Paulo/SP/BR CEP: 01425000"
    },
    "raw_answers": [
      {
        "question": {
          "question_title": "Qual o seu nome?",
          "question_id": "3716ad0542d3",
          "question_type": "text"
        },
        "answer": "Fernando"
      },
      {
        "question": {
          "question_title": "Qual seu e-mail?",
          "question_id": "x4k3pgwkowan",
          "question_type": "email"
        },
        "answer": "exemplo@exemplo.com"
      },
      {
        "question": {
          "question_title": "Qual sua fruta favorita?",
          "question_id": "xg8tmynhnv6u",
          "question_type": "radio"
        },
        "answer": [
          "Banana"
        ]
      },
      {
        "question": {
          "question_title": "Qual seu endereço?",
          "question_id": "xym6y9qkt0o9",
          "question_type": "address"
        },
        "answer": {
          "country": "BR",
          "cep": "01425000",
          "city": "São Paulo",
          "state": "SP",
          "neighborhood": "Jardim Paulista",
          "street": "Rua Guarará",
          "number": "123",
          "addressComp": null
        }
      }
    ]
  }
}

Note que existem dois formatos de respostas no objeto. O primeiro, chamado apenas de "answers", exibe as respostas e perguntas em um formato de chave/valor, o que facilita bastante para criar integrações rápidas.

O segundo, dentro do nó "raw_answers", exibe o valor bruto tanto da pergunta como da resposta. É útil caso você precise de integrações mais complexas. Você pode utilizar qualquer uma das opções que desejar.

Dados reais

No json acima você tem um exemplo genérico de como os dados do nosso webhook são estruturados. Isso te ajuda com campos que não mudam, como UTMs, ou dados do respondente. Mas se você precisa do valor da chave de uma pergunta real do seu formulário, esse dado acima não vai te ajudar.

Pra isso, você deve enviar um teste real de exemplo e capturar os valores reais. Consulte este artigo para ver como fazer: Como testar um webhook