Webhooks-URL hinterlegen

Webhooks sind HTTP-basierte Callback-Schnittstellen. Über Webhooks kannst du andere Anwendungen mit Realtime-Informationen über die Transaktionen für dein Produkt versorgen.

Hast du beispielsweise deinen Mitgliederbereich oder Online-Kurs nicht bei uns liegen, kannst du dir so die Daten zum Kauf in dein System übertragen lassen und so die Mitglieder einrichten oder sperren, wenn bei Abo- oder Ratenzahlungen keine weitere Zahlung eingeht.

Hier findest du, wie du deine Webhooks-URL im Produkt hinterlegst und welche Daten übertragen werden.

Template für Webhooks-URL erstellen

• Gehe zu "Marketing" und "Webhooks".
• Erstelle das Template.

Fülle die Felder entsprechend aus.

• Setze den Webhook aktiv, wenn er genutzt werden soll sobald du ihn bei einem Produkt hinterlegt hast.
• Entscheide, ob der Webhook bei Fehlern nochmal ausgelöst werden soll bis von deinem System der Status "erfolgreich" zurückgeliefert wird. Dieser wird innerhalb von 24 Stunden alle drei Stunden neu geschickt.
  
  In dem Fall solltest du dir regelmäßig die Logs ansehen, ob Fehler zu beheben.
  
  Beispiele für Fehlercodes: 403 Forbidden, 404 Not Found, 500 Internal Server Error, 502 Bad Gateway, Timed out reading data from server, 503 Service Unavailable.
  
  
• Wähle alle Events oder einzelne Events aus.
• Speichere das Template und hinterlege es danach bei dein relevanten Produkten.

Dir stehen diverse Events zur Verfügung bei denen die Daten an dein System geschickt werden.

• Events für Bestellungen
  
  Für Bestellungen gibt es diverse Events die du nutzen kannst. 
  
  
  
  

• Änderung der E-Mail-Adresse deine:r Kund:in
  
  Wurde die E-Mail-Adresse deines Kunden geändert, kannst du eine Information darüber erhalten.
  
  
  
  

• Events rund um Zahlungen / Rückzahlungen / Chargebacks
  
  Für den Status einer  Transaktion kannst du folgende Webhooks nutzen,
  
  
  
  

• Events rund um Online-Kurse
  
  Für Online-Kurse kannst du folgende Events nutzen.
  
  

Template beim Produkt hinterlegen

• Gehe zu deinem Produkt und klicke auf Bearbeiten.
• Gehe zum Schritt "Weiteres".
• Wähle aus, ob Webhooks aktiviert werden sollen.

Sollen Webhooks aktiviert werden, wähle aus, ob alle aktiviert werden sollen oder nur ein bestimmter Endpunkt. Soll nur ein bestimmter Endpunkt aktiviert werden, wähle das gerade angelegte Template dafür aus.

Welche Parameter werden übertragen?

Es werden nur die Parameter übertragen, für die die Daten vorhanden sind. Die Daten hängen somit vom Kauf und den eingegebenen Käuferdaten ab.

Käufer:

• id: Id
• email: E-Mail-Adresse
• first_name: Vorname
• last_name: Nachname
• country: Land
• city: Stadt
• street: Straße und Hausnummer
• zip: Postleitzahl
• company: Firma
• vat_no: Steuernummer
• phone: Telefonnummer     

Beim Verkauf über einen Publisher:

• id: Id
• email: E-Mail-Adresse
• first_name: Vorname
• last_name: Nachname
• country: Land
• city: Stadt
• street: Straße und Hausnummer
• zip: Postleitzahl
• company: Firma
• vat_no: Steuernummer

Beim Verkauf über einen Joint-Venture-Partner:

• id: Id
• email: E-Mail-Adresse
• first_name: Vorname
• last_name: Nachname

Produktdaten:

• id: Produkt-ID
• slug: URL
• name: Produktname
• type: Produkttyp (digital, e-tickets, voucher, courses, link)
• price: Preis

• internal product name: Interne Produktbezeichnung (selbst gewählt)

• product category

Beim Verkauf als Bundle:

• id: id
• name: Name des Bundles

Bei Tickets weitere Daten:

• count: Anzahl gerade gekaufter Tickets
• codes: Ticket-Code
• reserved_bills_count: Anzahl reservierter Tickets

Beim Gutschein:

• voucher_codes: Code für den gekauften Gutschein

Bei Tickets zusätzlich die Event-Daten:

• id: Event-ID
• name: Event-Name
• price: Preis
• location_short: Kurzbezeichnung Ort
• location_long: Ort
• current_code: Ticket-Code
• code_prefix: Ticket-Code-Präfix
• date: Datum
• date_id: ID des Ticket-Datums

Wurde das Produkt als Geschenk gekauft:

• id: Id
• email: E-Mail-Adresse
• first_name: Vorname
• last_name: Nachname
• country: Land
• city: Stadt
• street: Straße und Hausnummer
• zip: Postleitzahl
• company: Firma
• vat_no: Steuernummer
• phone: Telefonnummer     
  
  

Zusätzliche Informationen:

• add_id_1: eingehender URL-Parameter “add_id_1”
• add_id_2: eingehender URL-Parameter “add_id_2”
• bill_number: Rechnungsnummer
• revenue: Gesamtumsatz
• amount: Einnahme
• fee: transaktionsbezogene Gebühren
• vat_rate: Umsatzsteuer in %
• vat_amount: Umsatzsteuer-Betrag
• campaign_id: eingehender URL-Parameter “campaign ID”
• coupon_code: Couponcode
• recurring: Abo / Ratenzahlung =yes/no
• recurring_form: Art der Zahlung Einmalzahlung (one time payment), Abo (subscription), Limitiertes Abo (limited subscription), Ratenzahlung (installment payment)
• payment_method: Zahlungsmethode
• state: Zahlungsstatus
• created_date: Kaufdatum
• success_date: Datum der Zahlung / Auslieferung
• success_date_short: Datum der Zahlung / Auslieferung (kurz)
• invoice_link: Link zur Kundenrechnung
• success_link: Link zur Danke-Seite

Hier geht's zur vollständigen API-Dokumentation