Ouvrir dans Magpie

Un webhook envoie chaque nouvelle réponse à vos formulaires vers une autre application, comme Zapier, Make, n8n ou votre propre serveur, dès son arrivée. Les administrateurs de l’équipe ajoutent et modifient les webhooks de l’équipe.

Ajouter un webhook

  1. Dans Formulaires, choisissez Webhooks.
  2. Choisissez Ajouter un webhook.
  3. Donnez-lui un nom, et collez l’adresse que l’autre application vous donne, par exemple une adresse Catch Hook de Zapier.
  4. Choisissez Ajouter un webhook.

La page du webhook s’ouvre avec son secret de signature. Copiez le secret à ce moment-là : il ne sera plus affiché.

Un nouveau webhook envoie les réponses de tous les formulaires de l’équipe. Pour n’envoyer que les réponses d’un formulaire, choisissez ce formulaire sous Formulaires sur la page du webhook.

Une équipe peut avoir jusqu’à 20 webhooks. Les Paramètres du formulaire indiquent combien d’entre eux envoient ses réponses, avec un lien vers Webhooks.

Quand une réponse est envoyée

  • Une réponse à un formulaire sans paiement sera envoyée dès qu’elle est enregistrée.
  • Une réponse à un formulaire payant sera envoyée une fois payée. Une réponse jamais payée n’est pas envoyée.
  • Chaque réponse sera envoyée une seule fois à chaque webhook.

Ce que contient chaque requête

Chaque requête est un POST avec un corps JSON. Son type est form.response.created, et son data contient :

  • team : l’identifiant et le nom de l’équipe.
  • form : l’uuid, le titre, l’adresse et la version du formulaire.
  • response : son uuid, la date d’envoi (submitted_at, en UTC), son adresse dans Magpie, ses answers et son payment.

answers liste toutes les questions du formulaire, dans l’ordre, chacune avec son id, son label, son type et sa value. Une question sans réponse a une value null. Une réponse à cases à cocher est la liste des choix cochés.

Un fichier n’est pas envoyé lui-même. Sa value contient le nom du fichier et une url qui le télécharge avec une clé d’API. Envoyez la clé, et X-Magpie-Team-Id avec l’identifiant de l’équipe (voir Clés d’API et API REST).

payment est null sur un formulaire sans paiement. Sinon, il contient l’état, le montant dans la plus petite unité de la devise, la devise et la date du paiement.

Vérifier qu’une requête vient de Magpie

Chaque requête porte les en-têtes X-Magpie-Event, X-Magpie-Id, X-Magpie-Timestamp et X-Magpie-Signature.

  1. Joignez l’horodatage, un point et le corps brut.
  2. Calculez leur HMAC-SHA256 avec le secret de signature.
  3. Comparez-le à la valeur v1 de X-Magpie-Signature (t=<timestamp>,v1=<signature>).

X-Magpie-Id reste le même quand une réponse est renvoyée. Conservez-le, et ignorez une requête dont vous avez déjà l’identifiant.

Envois qui échouent

Répondez avec n’importe quel statut 2xx. Toute autre réponse, ou une absence de réponse, sera réessayée après 1, 5 et 30 minutes, puis 2, 6, 12 et 24 heures. Après 8 tentatives, l’envoi échoue.

La page du webhook liste ses 50 derniers envois. Renvoyer renvoie un envoi échoué, avec le même identifiant.

Désactiver un webhook, changer son adresse ou son formulaire, ou le supprimer annule les réponses qu’il n’a pas encore reçues.

Modifier ou supprimer un webhook

Sur la page du webhook :

  • Cliquez sur son nom ou sur son Adresse pour le modifier.
  • Désactivez Activé pour arrêter les envois sans supprimer le webhook.
  • Choisissez Plus, puis Nouveau secret de signature, pour remplacer le secret. L’ancien cesse de fonctionner : mettez à jour l’application qui reçoit le webhook.
  • Choisissez Plus, puis Supprimer le webhook.

Les webhooks dans l’API

Un programme peut ajouter, modifier et supprimer des webhooks avec une clé d’API, à /api/v1/forms/webhooks. La référence complète est liée depuis /docs/api.

Si la signature d’un webhook ne correspond pas, ou si une réponse n’est pas envoyée, Contacter l’assistance.

Demander à l’assistance Magpie

Envoyez à l’équipe Magpie une question sur tout ce que cet article n’explique pas.