Webhooks et API REST

Channels & Integrations7 vues

Webhooks et API REST

Conviro propose des webhooks pour recevoir des notifications d’événements en temps réel, ainsi qu’une API REST pour accéder par programmation à toutes les fonctionnalités de la plateforme.

Webhooks

Qu’est-ce qu’un webhook ?

Les webhooks envoient une requête HTTP POST à votre serveur dès qu’un événement précis se produit dans Conviro. Vous pouvez ainsi réagir en temps réel, sans interrogation périodique (polling).

Événements disponibles

ÉvénementDéclenché lorsque
message.newUn nouveau message est envoyé (par le visiteur ou le bot)
session.startedUne nouvelle session de conversation démarre
session.closedUne conversation est fermée
session.handoffUne conversation est transférée à un agent humain
lead.capturedUn nouveau lead est capturé
contact.createdUn nouveau contact est créé
ticket.createdUn ticket de support est ouvert
csat.submittedUne note CSAT est envoyée

Configuration

  1. Rendez-vous dans Dashboard -> Settings -> Webhooks.
  2. Cliquez sur Add Webhook.
  3. Saisissez l’URL de votre endpoint (elle doit être en HTTPS).
  4. Sélectionnez les événements que vous souhaitez recevoir.
  5. Cliquez sur Save.

Sécurité : signature HMAC-SHA256

Chaque payload de webhook est signé en HMAC-SHA256 à l’aide de votre secret de webhook. Vérifiez la signature sur votre serveur pour garantir l’authenticité :

X-Conviro-Signature: sha256=<hex_digest>

Comparez cet en-tête au condensé HMAC-SHA256 du corps brut de la requête, calculé avec votre secret de webhook.

Politique de nouvelle tentative

Si votre endpoint renvoie un code de statut différent de 2xx, Conviro effectue jusqu’à 3 nouvelles tentatives avec un backoff exponentiel (1 min, 5 min, 30 min).


API REST

Authentification

  1. Générez une clé d’API dans Dashboard -> Settings -> API Keys -> Create Key.
  2. Incluez-la dans l’en-tête Authorization :
Authorization: Bearer sk_your_api_key_here

Principaux endpoints

MéthodeEndpointDescription
GET/api/chatbotsLister tous les chatbots
GET/api/chatbots/:idObtenir les détails d’un chatbot
GET/api/sessionsLister les sessions (avec filtres)
GET/api/sessions/:id/messagesObtenir les messages d’une session
POST/api/sessions/:id/messagesEnvoyer un message dans une session
GET/api/contactsLister les contacts
POST/api/contactsCréer un contact
GET/api/leadsLister les leads
POST/api/leadsCréer un lead
GET/api/analytics/overviewObtenir le résumé des statistiques

Limites de débit

  • Forfait Free : 60 requêtes/minute
  • Starter : 120 requêtes/minute
  • Pro : 300 requêtes/minute
  • Growth+ : 600 requêtes/minute

Les en-têtes de limite de débit sont inclus dans chaque réponse :

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298
X-RateLimit-Reset: 1672531200

Documentation complète

Consultez /developers pour la référence complète de l’API, avec des exemples de requêtes et de réponses.

webhookapiresthmacintegrationendpointsdeveloper

Cet article vous a-t-il été utile ?