Lead-Webhooks und Google-Sheets-Sync

Was du tun kannst

Wenn ein Flipbook Leads erfasst, kannst du jeden neuen Lead aus FlipLink heraus in deine eigenen Systeme leiten. Mit diesen drei Endpunkten kannst du:

• Einen Neu-Lead-Webhook festlegen – eine URL, die für jeden neuen Lead einen JSON-Payload empfängt.
• Den Webhook testen – einen Dummy-Payload abfeuern, sodass du Zustellung und Format ohne einen echten Lead prüfen kannst.
• Leads mit Google Sheets synchronisieren – jeden neuen Lead an ein von dir angegebenes Sheet anhängen.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage entweder als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Flipbooks, zurückgegeben von create-by-file / create-by-url (als ID) oder von list. Alle drei Endpunkte nehmen sie als Pfadparameter entgegen.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Die PUT-Endpunkte (set-lead-webhook, set-lead-google-sheets) senden ihren Body als form-urlencoded (kein JSON). test-webhook nimmt keinen Body entgegen.

Den Neu-Lead-Webhook festlegen

Legt eine Webhook-URL fest, die jeden neuen Lead empfängt (gespeichert als Neu-Lead-Webhook). Nutze den Test-Endpunkt unten, um zu prüfen, ob er auslöst.

curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=https://example.com/hooks/new-lead'

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Den Webhook testen

Feuert einen TEST-Payload an den konfigurierten Lead-Webhook des Flipbooks, sodass du das Zustellformat ohne einen echten Lead prüfen kannst. Es gibt ERROR "No lead webhook is configured for this flipbook." zurück, wenn keiner gesetzt ist. Die Form des Payloads entspricht einem echten Lead (Schlüssel: pdf_id, pdf_name, lead_name, lead_email, lead_phone, lead_company, lead_date, lead_custom_1, lead_custom_2), trägt aber Dummy-Werte (pdf_id:"-1", pdf_name:"Test PDF", …). Es wird kein echter Lead gespeichert und keine Benachrichtigungs-E-Mail gesendet.

curl -X POST 'https://go.fliplink.me/api/test-webhook/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Leads mit Google Sheets synchronisieren

Verbindet die Lead-Erfassung mit einem Google Sheet – neue Leads werden an das von dir angegebene Sheet angehängt. Die Anfrage sendet drei Formularfelder:

• GoogleSheetURL – die Share-URL des Spreadsheets (der Link, den du aus dem Teilen-Dialog von Google Sheets erhältst).
• GoogleSheetIDKey – die ID des Spreadsheets (der lange Bezeichner in der URL des Sheets, zwischen /d/ und /edit).
• GoogleSheetName – der Name des Arbeitsblatts (Tabs), an den Zeilen angehängt werden, z. B. Sheet1.

curl -X PUT 'https://go.fliplink.me/api/set-lead-google-sheets/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'GoogleSheetURL=https://docs.google.com/spreadsheets/d/1A2B3C4D5E6F7G8H9I0J/edit?usp=sharing' \
  --data-urlencode 'GoogleSheetIDKey=1A2B3C4D5E6F7G8H9I0J' \
  --data-urlencode 'GoogleSheetName=Sheet1'

Antwort:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Mögliche Fehler

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header (oder Authorization: Bearer) vorhanden und korrekt ist.
• Unbekannte {flipbookId} (oder eine, die nicht zu deinem Schlüssel gehört) → HTTP 200 mit { "Result": "ERROR", "Message": "Item not found" }.
• Unbekanntes oder falsch geschriebenes Body-Feld (bei den beiden PUT-Endpunkten) → HTTP 200 mit { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }.

Eine schnelle Faustregel: Result: "OK" bedeutet, dass die Änderung angewendet wurde; Result: "ERROR" bedeutet, dass sie es nicht wurde – lies die Message für den Grund.

Hinweise

• Der Test-Endpunkt gibt ERROR "No lead webhook is configured for this flipbook." zurück, wenn für das Flipbook kein Webhook gesetzt ist – konfiguriere ihn zuerst mit set-lead-webhook.
• Ein Test-Payload speichert nie einen echten Lead und sendet nie eine Benachrichtigungs-E-Mail.