In Magpie öffnen

Ein Webhook sendet jede neue Antwort auf Ihre Formulare an eine andere App, etwa Zapier, Make, n8n oder Ihren eigenen Server, sobald sie eintrifft. Team-Admins fügen die Webhooks des Teams hinzu und ändern sie.

Einen Webhook hinzufügen

  1. Wählen Sie in Formulare Webhooks.
  2. Wählen Sie Webhook hinzufügen.
  3. Geben Sie ihm einen Namen und fügen Sie die Adresse ein, die Ihnen die andere App gibt, etwa eine Catch Hook-Adresse von Zapier.
  4. Wählen Sie Webhook hinzufügen.

Die Seite des Webhooks öffnet sich mit seinem Signaturgeheimnis. Kopieren Sie das Geheimnis dann: Es wird nicht noch einmal gezeigt.

Ein neuer Webhook sendet die Antworten aller Formulare des Teams. Um nur die Antworten eines Formulars zu senden, wählen Sie dieses Formular auf der Seite des Webhooks unter Formulare.

Ein Team kann bis zu 20 Webhooks haben. Die Formulareinstellungen eines Formulars zeigen, wie viele davon seine Antworten senden, mit einem Link zu Webhooks.

Wann eine Antwort gesendet wird

  • Eine Antwort auf ein Formular ohne Zahlung wird gesendet, sobald sie gespeichert ist.
  • Eine Antwort auf ein Formular mit Zahlung wird gesendet, sobald sie bezahlt ist. Eine Antwort, die nie bezahlt wird, wird nicht gesendet.
  • Jede Antwort wird an jeden Webhook einmal gesendet.

Was jede Anfrage enthält

Jede Anfrage ist ein POST mit einem JSON-Body. Sein type ist form.response.created, und sein data enthält:

  • team: die ID und den Namen des Teams.
  • form: UUID, Titel, Adresse und Version des Formulars.
  • response: ihre UUID, wann sie gesendet wurde (submitted_at, in UTC), ihre Adresse in Magpie, ihre answers und ihre payment.

answers listet jede Frage des Formulars in ihrer Reihenfolge auf, jeweils mit id, label, type und value. Eine nicht beantwortete Frage hat value null. Eine Antwort mit Kontrollkästchen ist die Liste der angekreuzten Optionen.

Eine Datei wird nicht selbst gesendet. Ihr value enthält den Dateinamen und eine url, die sie mit einem API-Schlüssel herunterlädt. Senden Sie den Schlüssel und X-Magpie-Team-Id mit der ID des Teams (siehe API-Schlüssel und REST-API).

payment ist null bei einem Formular ohne Zahlung. Sonst enthält es den Status, den Betrag in der kleinsten Einheit der Währung, die Währung und den Zeitpunkt der Zahlung.

Prüfen, ob eine Anfrage von Magpie kommt

Jede Anfrage hat die Header X-Magpie-Event, X-Magpie-Id, X-Magpie-Timestamp und X-Magpie-Signature.

  1. Verbinden Sie den Zeitstempel, einen Punkt und den unveränderten Body.
  2. Berechnen Sie daraus den HMAC-SHA256 mit dem Signaturgeheimnis.
  3. Vergleichen Sie ihn mit dem Wert v1 in X-Magpie-Signature (t=<timestamp>,v1=<signature>).

X-Magpie-Id bleibt gleich, wenn eine Antwort erneut gesendet wird. Speichern Sie sie und ignorieren Sie eine Anfrage, deren ID Sie schon haben.

Fehlgeschlagene Zustellungen

Antworten Sie mit einem beliebigen 2xx-Status. Jede andere Antwort, oder keine Antwort, wird nach 1, 5 und 30 Minuten und dann nach 2, 6, 12 und 24 Stunden erneut versucht. Nach 8 Versuchen schlägt die Zustellung fehl.

Die Seite des Webhooks listet seine letzten 50 Zustellungen auf. Erneut senden sendet eine fehlgeschlagene Zustellung noch einmal, mit derselben ID.

Einen Webhook ausschalten, seine Adresse oder sein Formular ändern oder ihn löschen storniert die Antworten, die er noch nicht erhalten hat.

Einen Webhook ändern oder löschen

Auf der Seite des Webhooks:

  • Klicken Sie auf seinen Namen oder seine Adresse, um sie zu ändern.
  • Schalten Sie Ein aus, um das Senden zu beenden, ohne den Webhook zu löschen.
  • Wählen Sie Mehr und dann Neues Signaturgeheimnis, um das Geheimnis zu ersetzen. Das alte funktioniert dann nicht mehr, aktualisieren Sie also die App, die den Webhook empfängt.
  • Wählen Sie Mehr und dann Webhook löschen.

Webhooks in der API

Ein Programm kann Webhooks mit einem API-Schlüssel unter /api/v1/forms/webhooks hinzufügen, ändern und löschen. Die vollständige Referenz ist unter /docs/api verlinkt.

Wenn die Signatur eines Webhooks nicht passt oder eine Antwort nicht gesendet wird, Support kontaktieren.

Den Magpie-Support fragen

Senden Sie dem Magpie-Team eine Frage zu allem, was dieser Artikel nicht beantwortet.