GUIDE DES WEBHOOKS

Notifications d’événements en temps réel

Recevez des rappels HTTP instantanés lorsque les appels se terminent, que les campagnes se concluent ou que les crédits s’épuisent. Créez des intégrations réactives qui répondent aux événements en temps réel[cite: 1, 62].

Temps réel

Livraison des événements

HMAC

Sécurité SHA256

JSON

Prise en charge des charges utiles

5x

Nouvelles tentatives automatiques

Comment fonctionnent les webhooks

Abonnez-vous à des événements et recevez des notifications HTTP POST lorsqu’ils surviennent[cite: 1, 68].

1

Créer un webhook

Configurez l’URL de votre point de terminaison et sélectionnez les événements auxquels vous abonner, via l’API ou le tableau de bord[cite: 1, 71].

2

L’événement survient

Lorsqu’un événement auquel vous êtes abonné se produit (fin d’un appel, fin d’une campagne), VoxPria déclenche le webhook[cite: 1, 73].

3

Réception du POST

Votre point de terminaison reçoit une requête HTTP POST contenant la charge utile de l’événement et une signature de vérification[cite: 1, 75].

Événements pris en charge

Nom de l’événement Description
call.completed Déclenché lorsqu’un appel téléphonique est terminé et que le résumé ou l’enregistrement est prêt.
campaign.completed Déclenché lorsque tous les contacts d’une campagne ont été traités.
credit.low Déclenché lorsque le solde de votre compte descend sous le seuil configuré.

Exemples de charges utiles de webhook


Événement call.completed
application/json 
{
  "event": "call.completed",
  "timestamp": "2026-02-02T14:30:00Z",
  "data": {
    "id": "call_abc123xyz",
    "status": "completed",
    "phoneNumber": "+14155551234",
    "duration": 45,
    "summary": "Customer confirmed appointment for Feb 10 at 2pm"
  }
}

Événement campaign.completed
application/json 
{
  "event": "campaign.completed",
  "timestamp": "2026-02-02T16:45:00Z",
  "data": {
    "id": "campaign_xyz789",
    "name": "Q1 Appointment Reminders",
    "stats": {
      "totalContacts": 500,
      "answered": 387,
      "voicemails": 62
    }
  }
}

Événement credit.low
application/json 
{
  "event": "credit.low",
  "data": {
    "currentBalance": 12.50,
    "threshold": 15.00,
    "currency": "USD"
  }
}

🔐 Sécurité et vérification

Chaque webhook comprend un en-tête X-Webhook-Signature. Étapes de vérification :

  • Extrayez l’horodatage (t) et la signature (v1) de l’en-tête.
  • Concaténez l’horodatage et le corps brut avec un « . ».
  • Calculez le HMAC-SHA256 à l’aide de votre secret de webhook.
  • Comparez la signature calculée avec celle de l’en-tête.
# Exemple d'en-tête de vérification
X-Webhook-Signature: t=1609459200,v1=6a295...

Logique de nouvelles tentatives

Si votre serveur retourne un code de statut autre que 2xx, nous réessayons la livraison jusqu’à 5 fois.

Tentative Délai après la tentative précédente
1re nouvelle tentative 1 minute
2e nouvelle tentative 5 minutes
3e nouvelle tentative 30 minutes
4e nouvelle tentative 2 heures
5e nouvelle tentative 6 heures

Meilleures pratiques pour les webhooks

  • Utilisez HTTPS : Fournissez uniquement des URL sécurisées afin de protéger vos données.
  • Idempotence : Concevez votre système pour qu’il puisse gérer le même événement plus d’une fois en toute sécurité.
  • Accusez réception rapidement : Retournez un code 200 OK avant de traiter les tâches de longue durée.
  • Rotation des secrets : Faites pivoter périodiquement vos secrets de webhook pour une sécurité accrue.

Prêt à créer avec les webhooks ?

Commencez à recevoir des notifications d’événements en temps réel en quelques minutes.