E-Mail-Anmeldungen
Verbinde Resend, Mailchimp, Kit, Loops, beehiiv, Brevo oder SendGrid, um E-Mail-Anmeldungen aus deiner Doku beim Anbieter in der Zielgruppe zu erfassen.
Jamdesk erfasst E-Mail-Adressen auf deiner Dokumentationswebsite und fügt sie dem E-Mail-Anbieter hinzu, den du bereits verwendest. Es ist kein Drittanbieter für Formulare zwischengeschaltet. Verbinde einmalig einen Anbieter im Dashboard und füge dann auf beliebigen Seiten ein Anmeldeformular ein. Die Liste und den Versand verwaltest du selbst. Jamdesk erfasst die Adresse und übermittelt sie an deinen Anbieter.
Die Screenshots zeigen die Benutzeroberfläche auf Englisch.
Voraussetzungen
- Ein Konto bei einem der unterstützten Anbieter
- Ein API-Schlüssel dieses Anbieters mit Berechtigung zum Hinzufügen von Kontakten
- Die Zielgruppenkennung, mit der die meisten Anbieter eine Liste auswählen (Audience ID, List ID, Form ID oder Publication ID)
So funktioniert die Erfassung
Jamdesk überprüft den API-Schlüssel vor dem Speichern anhand der API des Anbieters. Bei jeder Formularübermittlung auf deiner Dokumentationswebsite wird dann der Anbieter aufgerufen und der Leser zu deiner Zielgruppe hinzugefügt. Übermittlungen werden pro Besucher und Projekt begrenzt. Ein verborgenes Honeypot-Feld filtert Bots heraus.
Leser sehen ein Formular wie dieses:
Ein Beispiel findest du live im Jamdesk-Changelog.
Dein API-Schlüssel wird im Jamdesk-Backend gespeichert und ausschließlich zum Hinzufügen von Kontakten verwendet. Er wird niemals in deine veröffentlichte Website, deine docs.json oder clientseitigen Code geschrieben.
Unterstützte Anbieter
Sieben Anbieter erfassen Anmeldungen nativ. Leser senden ein von Jamdesk gehostetes Formular ab und werden deiner Zielgruppe hinzugefügt, ohne deine Dokumentation zu verlassen:
| Anbieter | Was du verbindest |
|---|---|
| Resend | API-Schlüssel (Vollzugriff) + Audience ID |
| Mailchimp | API-Schlüssel (endet mit deinem Rechenzentrum, z. B. -us21) + Audience (List) ID |
| Kit (ConvertKit) | v4-API-Schlüssel + Form ID |
| Loops | API-Schlüssel |
| beehiiv | API-Schlüssel + Publication ID |
| Brevo | v3-API-Schlüssel + Contact List ID |
| SendGrid | API-Schlüssel mit Schreibzugriff auf Marketing Contacts + Marketing List ID |
Zwei weitere Anbieter sind nur per Einbettung verfügbar. Jamdesk zeigt ihr eigenes Formular oder ihren Iframe an, anstatt die Adresse zu erfassen. Ein Schlüssel ist nicht erforderlich:
| Anbieter | Was du angibst |
|---|---|
| Buttondown | Den username deines Kontos (im <EmailSubscribe>-Tag) |
| Substack | Den username deines Kontos (im <EmailSubscribe>-Tag) |
Unter EmailSubscribe findest du die Einrichtung für die Einbettung.
Anbieter verbinden
Öffne im Dashboard dein Projekt und gehe zu Integrations. Suche die Karte Email Signups.
Wähle im Dropdown Provider einen Anbieter aus. Das Formular fragt anschließend nach den erforderlichen Angaben. Es enthält einen Link dazu, wo du den API-Schlüssel findest.
Gib den API-Schlüssel und bei den meisten Anbietern die Zielgruppenkennung ein (bei Loops genügt der Schlüssel). Das Schlüsselfeld ist maskiert.
Klicke auf Connect. Jamdesk überprüft den Schlüssel vor dem Speichern bei deinem Anbieter. Bei einem falschen Schlüssel oder fehlenden Kontaktberechtigungen wird ein Fehler angezeigt. Es wird nichts gespeichert.
Auf der verbundenen Karte wird ein Configured-Abzeichen mit deinem Anbieter und der Zielgruppen-ID angezeigt. Bei der nächsten Veröffentlichung deiner Dokumentation werden aktive Erfassungsformulare angezeigt.
Formulartext anpassen
Mit den optionalen Feldern Form title und Form subtitle legst du die Überschrift und den ergänzenden Text automatisch platzierter Formulare fest. Bei leeren Feldern enthält das Formular nur das E-Mail-Feld und die Schaltfläche. Changelog-Formulare übernehmen ausgefüllte Felder bei der nächsten Veröffentlichung, ohne dass du docs.json bearbeiten musst.
Du kannst diese Texte jederzeit ändern. Bearbeite die Felder auf einer verbundenen Karte und klicke auf Save copy. Den API-Schlüssel musst du nicht erneut eingeben. Ein in docs.json oder im <EmailSubscribe>-Tag festgelegter title oder eine description überschreibt die Texte aus dem Dashboard.
Formular zur Dokumentation hinzufügen
Durch das Verbinden eines Anbieters wird noch kein Formular platziert. Du bestimmst, wo Anmeldungen möglich sind:
- Füge auf einer beliebigen Seite
<EmailSubscribe provider="resend" />ein (mit der ID deines verbundenen Anbieters). - Oder setze in
docs.jsonplacement: changelog, um automatisch auf jeder Changelog-Seite ein Formular einzufügen.
Auf der Komponentenseite EmailSubscribe werden diese Optionen genauer beschrieben.
Anbieter trennen
Öffne die Karte Email Signups und klicke auf Remove, um keine weiteren Anmeldungen mehr zu erfassen. Nach deiner nächsten Veröffentlichung erfassen die Formulare keine Anmeldungen mehr.
Beim Trennen wird nur der Schlüssel aus Jamdesk entfernt. Bereits erfasste Abonnenten bleiben in der Zielgruppe deines Anbieters. Jamdesk löscht sie niemals. Du kannst den Anbieter jederzeit wieder verbinden.