Webhooks

☁️ Que sont les Webhooks ?

Les Webhooks sont un excellent moyen d’envoyer le répondant et ses réponses à n’importe quel endpoint API HTTP dès que le répondant a été enregistré dans la base de données ngSurvey.

🔅 Propriétés des Webhooks

• URL du Webhook de l’API REST ou du serveur HTTP qui doit recevoir le post de la charge utile JSON du répondant.

• Modèle de transformation de la charge utile utilisé pour changer la structure de la charge utile JSON postée en une autre structure d’objet personnalisée.

🔤 Format du post

Le répondant et ses réponses sont envoyés sous forme de charge utile au format JSON en utilisant une requête HTTP POST. La charge utile JSON par défaut ci‑dessous peut être personnalisée à l’aide d’un modèle de transformation de la charge utile.

{
  respondent: {
    id: string;
    surveyId: string;
    panelistId: string;
    contextUsername: string
    resumeUId: string;
    resumePageId: string;
    startDate: Date;
    voteDate: Date;
    iPSource: string;
    changeUID: string;
    progressSaveDate: Date;
    languageCode: string;
    timeToEnd: number;
    validated: boolean;        
  },
  answers: [{
      respondentId: string,
      value:string,
      answerId": string,
      answerText": string,
      questionId": string,
      questionAlias": string,
      questionText": string,
      sectionNumber": number
  }],
  visitedPages: [{
    id: string;
    respondentId: string;
    visitTime: string;
  }],
  dataAttributes: [{
    securityItemId: string;
    respondentId: string;
    attributeName: string;
    attributeValue: string;
  }],
  querystring: string
}

Réponses chiffrées avec restreint la classification des données sera envoyée sous forme de message PGP chiffré.