Webhooks

Que sont les webhooks ?

Les webhooks sont des messages automatiques envoyés par des applications lorsque quelque chose se produit. Ils ont un message—ou payload—et sont envoyés à une URL unique (votre endpoint).

Au lieu de vérifier constamment notre API pour de nouvelles données (polling), les webhooks envoient les données à votre application en temps réel lorsque des événements se produisent. C'est plus efficace et fournit des notifications instantanées.

Lorsqu'un utilisateur soumet une enquête ou un formulaire sur votre site web, Ask Users peut instantanément notifier votre application via webhook, vous permettant de :

• Synchroniser automatiquement les données avec votre CRM (Salesforce, HubSpot, etc.)
• Envoyer des notifications à votre équipe via Slack ou email
• Déclencher des workflows personnalisés dans votre application
• Mettre à jour votre base de données en temps réel
• Alimenter les données dans des plateformes d'analyse

Comment fonctionnent les webhooks

Événements supportés

Implémentation de référence webhook

Voici un exemple complet de la façon de créer et de vérifier un endpoint webhook dans votre application :

// Node.js/Express example
const crypto = require('crypto');

app.post('/webhooks/askusers', (req, res) => {
  const signature = req.headers['x-webhook-signature'];

  // Verify signature (see security section)
  if (!verifySignature(req.body, signature)) {
    return res.status(401).send('Invalid signature');
  }

  // Process webhook
  const { event_type, data } = req.body;

  // Return 200 OK immediately
  res.status(200).send('OK');

  // Process async
  processWebhookAsync(event_type, data);
});

Exemple de payload webhook

Voici un exemple de ce à quoi ressemble un payload webhook :

{
  "event_type": "survey.response.created",
  "event_id": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:00.000Z",
  "data": {
    "response": {
      "id": "response-uuid",
      "survey_id": "survey-uuid",
      "response_data": {
        "question-id-1": "Answer 1",
        "question-id-2": "Answer 2"
      },
      "completion_status": "completed",
      "created_at": "2025-01-15T10:30:00.000Z"
    },
    "survey": {
      "id": "survey-uuid",
      "title": "Product Feedback Survey"
    }
  }
}

Vérifiez toujours les signatures webhook pour vous assurer que les requêtes proviennent d'Ask Users. Chaque webhook inclut un en-tête X-Webhook-Signature avec une signature HMAC-SHA256.

Exemple de vérification (Node.js)

const crypto = require('crypto');

function verifySignature(payload, signature) {
  const secret = process.env.ASKUSERS_WEBHOOK_SECRET;
  const payloadString = JSON.stringify(payload);

  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payloadString)
    .digest('hex');

  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expectedSignature)
  );
}

Exemple de vérification (Python)

import hmac
import hashlib
import os

def verify_signature(payload: str, signature: str) -> bool:
    secret = os.environ['ASKUSERS_WEBHOOK_SECRET']

    expected_signature = hmac.new(
        secret.encode('utf-8'),
        payload.encode('utf-8'),
        hashlib.sha256
    ).hexdigest()

    return hmac.compare_digest(signature, expected_signature)