How to receive data with a webhook on a sequence containing a satisfaction survey step

If you have a sequence with a satisfaction survey step, you can define a webhook to receive data each time a person completes a form.

Where to define the webhook

In the sequence where you want to define your webhook, select the step "Satisfaction Survey".
Then you can define the URL where you want the data to be sent each time a person has filled a form.

How we send the filled form data

Each time a person has filled the form defined in this step, InputKit will make a POST request to the webhook URL with the data in JSON format.

Example of the JSON data sent

customer: {Object}, // See details below

customer_is_satisfied: true, 
/**
* customer_is_satisfied tells if the customer is satisfied based on his feedback provided on this specific completed survey.
* true :  if satisfaction logic is respected
* false :  if satisfaction logic is not respected
* null :  if there's no satisfaction logic on this survey
* To learn more about satisfaction logic : https://help.inputkit.io/en/articles/2213578-what-is-the-satisfaction-filter-learn-how-to-identify-and-filter-out-dissatisfied-customers-in-a-sequence
*/

questions_answers: [Array], // See details below

questionsAndAnswersJson: [Array], // See details below

questionsAndAnswersText: [Array], // Perfect format to add as text note to CRM for example

questionsAndAnswersHtml: [Array], // Perfect format to add as HTML note to CRM for example

date_created: '2023-09-06T16:35:24.000Z', // The date when the form has been filled.

employees: [], // Employees linked to this survey sending

sequence_id: 4130,

sequence_name: 'Suivi après rendez-vous (5e ou plus)',

metrics: [], // Metrics attached to the satisfaction survey, you'll find an array with each element being the name of the metric and its value.

// You'll also find all the custom fields values linked to the sending in the data at the root level of the payload.
"Custom Field 1":"value 1",
"Custom Field 2":"value 2"

customer

Contains all the details about the person who filled the form with most recent NPS score. If the form contains an NPS question, you'llfind the score here (the 'nps' property) and also in question_answers.

customer: {
    email: '[email protected]',
    honorific: 'M.',
    first_name: 'Philippe',
    last_name: 'Test',
    id: 94242,
    location_id: 2819,
    phone: '',
    organization: null,
    full_name: 'Philippe Test',
    name: 'M. Philippe Test',
    nps: 9
  },

questions_answers

This section is now deprecated, please use questionsAndAnswersJson

questionsAndAnswersJson

This array contains all questions and answers

questionsAndAnswersJson: [
    {
      question: 'De façon générale, quel est votre niveau de satisfaction face à vos traitements?',
      answers: [
        {
          answer: '5',
          explanation: 'Très efficaces!',
          nps_value: null,
          scale_value: 10,
          humanAnswer: '5 / 5 (Très efficaces!)'
        }
      ],
      nb_scales: undefined,
      questionType: 1,
      questionTypeName: 'Multiple choices (1 answer)',
      id: 48542
    },
    {
      question: 'De façon générale, quel est votre niveau de satisfaction face à vos traitements?',
      answers: [
        {
          answer: '5',
          explanation: 'Très efficaces!',
          nps_value: null,
          scale_value: 10,
          humanAnswer: '5 / 5 (Très efficaces!)'
        }
      ],
      nb_scales: 5,
      questionType: 6,
      questionTypeName: 'Scale question (value scaled back to 0 - 10)',
      id: 71404
    },
    {
      question: 'Avons-nous répondu à votre besoin initial?',
      answers: [Array],
      nb_scales: undefined,
      questionType: 1,
      questionTypeName: 'Multiple choices (1 answer)',
      id: 48541
    },
    {
      question: 'Quelle est la probabilité que vous recommandiez nos services à un ami ou un collègue ?',
      answers: [Array],
      nb_scales: undefined,
      questionType: 3,
      questionTypeName: 'Net Promoter Score (0 - 10)',
      id: 48545
    },
    {
      question: 'Selon vous, si nous pouvions améliorer un ou des aspects de notre service, ce serait :',
      answers: [Array],
      nb_scales: undefined,
      questionType: 2,
      questionTypeName: 'Multiple choices (1 or multiple answers)',
      id: 48547
    },
    {
      question: 'Veuillez indiquer le type de traitement reçu lors de votre dernière visite.',
      answers: [Array],
      nb_scales: undefined,
      questionType: 1,
      questionTypeName: 'Multiple choices (1 answer)',
      id: 48546
    },
    {
      question: 'Autres commentaires (facultatif)',
      answers: [Array],
      nb_scales: undefined,
      questionType: 0,
      questionTypeName: 'Free text',
      id: 48543
    }
  ]