Skip to main content

Introduction

Les webhooks VoiceHire vous permettent de recevoir des notifications HTTP en temps réel lorsque des événements se produisent dans votre compte. Cela vous évite d’avoir à interroger constamment l’API pour détecter les changements.

Configuration

1. Accéder aux paramètres

Connectez-vous à votre tableau de bord VoiceHire et accédez à la section API, puis à l’onglet Webhooks.

2. Configurer votre endpoint

string
required
L’URL HTTPS où VoiceHire enverra les notifications
string
Clé secrète optionnelle pour signer les payloads (recommandé)
array
required
Sélectionnez les événements que vous souhaitez recevoir

3. Tester la configuration

Utilisez le bouton “Tester” pour envoyer un événement de test à votre endpoint.

Format des webhooks

Tous les webhooks suivent le même format JSON :

Headers HTTP

Vérification de la signature

Si vous avez configuré un secret partagé, VoiceHire signe chaque webhook avec HMAC-SHA256 :

Événements disponibles

Campagnes

campaign.created

Déclenché lors de la création d’une nouvelle campagne.

campaign.status_changed

Déclenché lorsque le statut d’une campagne change.

Candidats

candidate.added

Déclenché lorsqu’un candidat est ajouté à une campagne.

candidate.sourced

Déclenché lorsqu’un candidat est sourcé via SMS.

Entretiens

candidate.interview.started

Déclenché lorsqu’un entretien téléphonique commence.

candidate.interview.completed

Déclenché lorsqu’un entretien est terminé avec succès.

candidate.interview.completed.extended

Version étendue avec les réponses détaillées (optionnel).

candidate.interview.failed

Déclenché lorsqu’un entretien échoue ou est incomplet.
Valeurs possibles pour failure_reason :
  • voicemail : Le candidat n’a pas décroché, messagerie vocale
  • no_answer : Pas de réponse du candidat
  • user_hangup : Le candidat a raccroché pendant l’entretien
  • technical_error : Erreur technique pendant le traitement

Crédits

credits.low

Déclenché lorsque vos crédits passent sous le seuil configuré (par défaut 10).

credits.depleted

Déclenché lorsque vos crédits sont épuisés.

Bonnes pratiques

1. Répondre rapidement

Votre endpoint doit répondre avec un code 2xx dans les 5 secondes. Pour les traitements longs, répondez immédiatement et traitez en arrière-plan.

2. Idempotence

VoiceHire peut renvoyer le même webhook en cas d’échec. Utilisez l’ID unique de l’événement pour éviter les doublons.

3. Ordre des événements

Les webhooks peuvent arriver dans le désordre. Utilisez les timestamps pour reconstituer la chronologie.

4. Gestion des erreurs

Si votre endpoint retourne une erreur (4xx ou 5xx), VoiceHire retentera 3 fois avec un délai exponentiel.

5. Surveillance

Surveillez vos webhooks depuis le tableau de bord pour détecter les échecs de livraison.

Exemple d’implémentation