diff --git a/src/api/rsvp.md b/src/api/rsvp.md index 67a1d38..083505e 100644 --- a/src/api/rsvp.md +++ b/src/api/rsvp.md @@ -44,6 +44,12 @@ Reading an rsvp block does not allow for any additional parameters. It only take "default": false } ], + "email_rsvp_doi": 34, + "email_rsvp_thank_you": 33, + "email_rsvp_signup_confirmation": 763, + "email_rsvp_change_confirmation": 434, + "email_rsvp_event_update": 55, + "email_rsvp_magic_link": 454, "date_updated": "2023-12-09T14:54:27.586Z", "date_created": "2023-11-19T08:43:16.180Z", } @@ -95,6 +101,12 @@ Creating a new RSVP template block requires you to at least provide the "name" f "default": false } ], + "email_rsvp_doi": 34, // the id of an email template can be seen from the url, when opening it in the web app + "email_rsvp_thank_you": 33, + "email_rsvp_signup_confirmation": 763, + "email_rsvp_change_confirmation": 434, + "email_rsvp_event_update": 55, + "email_rsvp_magic_link": 454, } ``` diff --git a/src/application-manual/elements.md b/src/application-manual/elements.md index 4a9bc50..25aa687 100644 --- a/src/application-manual/elements.md +++ b/src/application-manual/elements.md @@ -15,10 +15,10 @@ The hierarchy looks likes this: └─ Event Group └─ Event ├─ RSVP template *(optional)* + └─ Email template per RSVP email type *(optional)* ├─ CTA template *(optional)* └─ Style *(optional)* - ├─ Landingpage template *(optional)* - └─ Email template per RSVP email type *(optional)* + └─ Landingpage template *(optional)* ``` You will face this hierarchy during the creation of element. Still, within the app, they are organized a little different, in order to make them easily accessible - see the main navigation (Events - Styles - Templates). @@ -85,7 +85,7 @@ Create the functionality here, link it to your event, and it will automatically ### Emails -[Email templates](/application-manual/styles-and-templates.html#emails) can be linked to a Style. +[Email templates](/application-manual/styles-and-templates.html#emails) can be linked to an RSVP template. When setting them, you overwrite the default emails, that we send for any RSVP interaction of the user (like Double-Opt-In, confirmation, etc.). diff --git a/src/application-manual/styles-and-templates.md b/src/application-manual/styles-and-templates.md index 9665760..c859f36 100644 --- a/src/application-manual/styles-and-templates.md +++ b/src/application-manual/styles-and-templates.md @@ -9,9 +9,9 @@ While you can create them right during event creation, you can also do this at t As it might be obvious already, styles define the look and feel of your published elements. They, however, also account for usability and UX - like which calendar providers are available for an Add to Calendar Button. -Templates exist for RSVP forms, Call to Action (CTA) screens, emails, as well as landingpages. +Templates exist for RSVP forms and emails, Call to Action (CTA) screens, as well as landingpages. -While RSVP forms, CTA screens, and styles can be linked to events; emails and landingpages can be linked to styles. +While RSVP forms, CTA screens, and styles can be linked to events; emails can be linked to RSVP forms and landingpages can be linked to styles. ::: info Build your world! The Add to Calendar system is structured in way to offer you a maximum of flexibilty when it comes to you building your specific setup. @@ -82,40 +82,15 @@ Depending on the field type, the available options might differ. When you want to create a radio button group, create multiple radio fields after each other. -### Call to Action (CTA) - -CTA templates are relevant when you activate this functionality at an event. -Having it enabled, we show a respective screen to the user after the connected event got saved. - -The template defines what is shown on this screen. - -It can be simple text, a link (button), a sharing function, or a custom form. - -While the settings for the text, or link, or even the sharing tool, are quite obvious, setting up the form can be a little bit more complicated. - -But it is an awesome feature, as you can even use it to offer a newsletter subscription after a person saved your event! - -When working with the form, the `url` specifies the endpoint, where we send the input to. The `button label` can be used to customize what is shown on the submit button. +#### Email templates -Next, you can specify all the `fields` you want to show. - -They are basically the same as with the RSVP form. - -The `name` is mandatory and used to identify the field in the backend. The `label` is the user facing label, while you can use `placeholder` and `default` value information to prefil input fields. - -Depending on the field type, the available options might differ. - -Two things to mind: -1. When you want to create a radio button group, create multiple radio fields after each other. -2. If you name a hidden field "header" and its value is a JSON scheme, we will use this as the requests header information. In this case, we send the form as JSON; otherwise as multipart/form-data. - -You can always test your settings via the button at the very right of the screen. +Override the default emails with customized ones by linking email templates with the RSVP form. ### Email When working with RSVP, there are multiple emails, your user's might receive. This can be a Double-Opt-In confirmation email or an email, containing a magic link to log into the management page, where users can adjust their responses. -*You can link those templates to a style.* +*You can link those templates to an RSVP form.* Our default is created in a way that it fits all cases. @@ -144,3 +119,32 @@ As you see, there is a big chance, your users are getting in contact with your e With a respective template, linkable to an event style, you can customize this page. You can change the auto-generated headline, add some intro text, define colors, and optimize meta/SEO content. + +### Call to Action (CTA) + +CTA templates are relevant when you activate this functionality at an event. +Having it enabled, we show a respective screen to the user after the connected event got saved. + +The template defines what is shown on this screen. + +It can be simple text, a link (button), a sharing function, or a custom form. + +While the settings for the text, or link, or even the sharing tool, are quite obvious, setting up the form can be a little bit more complicated. + +But it is an awesome feature, as you can even use it to offer a newsletter subscription after a person saved your event! + +When working with the form, the `url` specifies the endpoint, where we send the input to. The `button label` can be used to customize what is shown on the submit button. + +Next, you can specify all the `fields` you want to show. + +They are basically the same as with the RSVP form. + +The `name` is mandatory and used to identify the field in the backend. The `label` is the user facing label, while you can use `placeholder` and `default` value information to prefil input fields. + +Depending on the field type, the available options might differ. + +Two things to mind: +1. When you want to create a radio button group, create multiple radio fields after each other. +2. If you name a hidden field "header" and its value is a JSON scheme, we will use this as the requests header information. In this case, we send the form as JSON; otherwise as multipart/form-data. + +You can always test your settings via the button at the very right of the screen. diff --git a/src/de/api/rsvp.md b/src/de/api/rsvp.md index d1f85a2..72a064e 100644 --- a/src/de/api/rsvp.md +++ b/src/de/api/rsvp.md @@ -44,6 +44,12 @@ Beim Abrufen eines RSVP-Blocks sind keine zusätzlichen Parameter möglich. Es w "default": false } ], + "email_rsvp_doi": 34, + "email_rsvp_thank_you": 33, + "email_rsvp_signup_confirmation": 763, + "email_rsvp_change_confirmation": 434, + "email_rsvp_event_update": 55, + "email_rsvp_magic_link": 454, "date_updated": "2023-12-09T14:54:27.586Z", "date_created": "2023-11-19T08:43:16.180Z", } @@ -95,6 +101,12 @@ Um einen neuen RSVP-Template-Block zu erstellen, musst du mindestens das Feld "n "default": false } ], + "email_rsvp_doi": 34, // die ID eines E-Mail-Templates ist aus der URL ersichtlic, wenn du das Template in der Web App aufrufst + "email_rsvp_thank_you": 33, + "email_rsvp_signup_confirmation": 763, + "email_rsvp_change_confirmation": 434, + "email_rsvp_event_update": 55, + "email_rsvp_magic_link": 454, } ``` diff --git a/src/de/application-manual/elements.md b/src/de/application-manual/elements.md index 55cf0a9..97c57f8 100644 --- a/src/de/application-manual/elements.md +++ b/src/de/application-manual/elements.md @@ -14,10 +14,10 @@ Die Hierarchie sieht folgendermaßen aus: └─ Event-Gruppe └─ Event ├─ RSVP-Template *(optional)* + └─ E-Mail-Template je RSVP-E-Mail-Typ *(optional)* ├─ CTA-Template *(optional)* └─ Style *(optional)* - ├─ Landingpage-Template *(optional)* - └─ E-Mail-Template je RSVP-E-Mail-Typ *(optional)* + └─ Landingpage-Template *(optional)* ``` Du wirst auf diese Hierarchie während der Erstellung eines Elements stoßen. Innerhalb der App sind sie jedoch etwas anders organisiert, um sie leichter zugänglich zu machen - siehe Hauptnavigation (Events - Styles - Templates). @@ -84,7 +84,7 @@ Erstelle hier die Funktionalität, verlinke sie mit deinem Event, und der CTA wi ### E-Mails -[E-Mail-Templates](/de/application-manual/styles-and-templates.html#emails) können mit einem Style verknüpft werden. +[E-Mail-Templates](/de/application-manual/styles-and-templates.html#emails) können mit einem RSVP-Template verknüpft werden. Wenn du sie definierst, überschreibst du die Standard-E-Mails, die wir für jede RSVP-Interaktion des Benutzers senden (wie Double-Opt-In, Bestätigung usw.). diff --git a/src/de/application-manual/styles-and-templates.md b/src/de/application-manual/styles-and-templates.md index 90e22fe..e8d7a42 100644 --- a/src/de/application-manual/styles-and-templates.md +++ b/src/de/application-manual/styles-and-templates.md @@ -9,9 +9,9 @@ Obwohl du sie direkt während der Erstellung eines Events erstellen kannst, kann Wie vielleicht schon offensichtlich ist, definieren Styles Look and Feel deiner veröffentlichten Elemente. Sie berücksichtigen jedoch auch die Benutzerfreundlichkeit und UX - wie bspw. welche Kalenderanbieter für einen „Add to Calendar“-Button verfügbar sind. -Templates gibt es für RSVP-Formulare, Call to Action (CTA)-Screens, E-Mails sowie Landingpages. +Templates gibt es für RSVP-Formulare und -E-Mails, Call to Action (CTA)-Screens, sowie Landingpages. -Während RSVP-Formulare, CTA-Screens und Styles mit Events verknüpft werden können; werden E-Mails und Landingpages mit Styles verbunden. +Während RSVP-Formulare, CTA-Screens und Styles mit Events verknüpft werden können; werden E-Mails mit RSVP-Formularen und Landingpages mit Styles verbunden. ::: info Baue deine Welt! Das „Add to Calendar“-System ist so strukturiert, dass es dir maximale Flexibilität bietet, wenn du dein spezifisches Setup erstellst. @@ -82,41 +82,15 @@ Je nach Feldtyp können die verfügbaren Optionen unterschiedlich sein. Wenn du eine Radio-Button-Gruppe erstellen möchtest, erstelle mehrere Radiofelder nacheinander. -### Call to Action (CTA) - -CTA-Templates sind relevant, wenn du diese Funktionalität bei einem Event aktivierst. -Wenn sie aktiviert ist, zeigen wir dem Benutzer nach dem Speichern des verbundenen Events eine entsprechende Nachricht an. - -Das Template definiert, was hierbei gezeigt wird. - -Es kann einfacher Text, ein Link (Button), eine Sharing-Funktion oder ein benutzerdefiniertes Formular sein. - -Während die Einstellungen für den Text oder den Link oder sogar das Sharing-Tool ziemlich offensichtlich sind, kann die Einrichtung des Formulars ein wenig komplizierter sein. - -Aber es ist ein großartiges Feature, da du es sogar verwenden kannst, um ein Newsletter-Abonnement anzubieten, nachdem eine Person dein Event gespeichert hat! - -Bei der Arbeit mit dem Formular gibt die `URL` den Endpunkt an, an den wir die Eingaben senden. `Button-Text` kann verwendet werden, um anzupassen, was auf dem Absende-Button angezeigt wird. - -Als nächstes kannst du alle `Felder` spezifizieren, die du anzeigen möchtest. - -Sie sind im Grunde ähnlich dem RSVP-Formular. - -Der `Name` ist obligatorisch und wird verwendet, um das Feld im Backend zu identifizieren. Das `Label` ist das dem Benutzer gegenüber sichtbare Label, während du über `Platzhalter` und `Standard` die Werte der Felder (quasi) vorausfüllen kannst. - -Je nach Feldtyp können die verfügbaren Optionen unterschiedlich sein. - -Zwei Dinge zu beachten: -1. Wenn du eine Radio-Button-Gruppe erstellen möchtest, erstelle mehrere Radiofelder nacheinander. -2. Wenn du ein ausgeblendetes Feld "header" nennst und dessen Wert ein JSON-Schema ist, übermitteln wir dies als Header-Information. In diesem Fall wird das Formular als JSON gesendet; ohne Header als multipart/form-data. - -Du kannst deine Einstellungen immer über den Button ganz rechts auf dem Bildschirm testen. +#### E-Mail-Templates +Überschreibe die Standard-E-Mails mit angepassten Versionen, indem du E-Mail-Templates mit dem RSVP-Formular verbindest. ### E-Mail Bei der Arbeit mit RSVP gibt es mehrere E-Mails, die deine Benutzer erhalten können. Dies kann eine Double-Opt-In-Bestätigungs-E-Mail oder eine E-Mail sein, die einen Magic Link enthält, um sich auf der Verwaltungsseite einzuloggen, wo Benutzer ihre Antworten anpassen können. -*Du kannst diese Templates mit einem Style verknüpfen.* +*Du kannst diese Templates mit einem RSVP-Formular verknüpfen.* Unser Standard ist so erstellt, dass er auf alle Fälle grob passt. @@ -145,3 +119,32 @@ Wie du siehst, ist es sehr wahrscheinlich, dass deine Benutzer mit der Landingpa Mit einem entsprechenden Template, das mit einem Event-Style verknüpft werden kann, kannst du diese Seite anpassen. Du kannst die automatisch generierte Überschrift ändern, etwas Einführungstext hinzufügen, Farben definieren und Meta/SEO-Inhalte optimieren. + +### Call to Action (CTA) + +CTA-Templates sind relevant, wenn du diese Funktionalität bei einem Event aktivierst. +Wenn sie aktiviert ist, zeigen wir dem Benutzer nach dem Speichern des verbundenen Events eine entsprechende Nachricht an. + +Das Template definiert, was hierbei gezeigt wird. + +Es kann einfacher Text, ein Link (Button), eine Sharing-Funktion oder ein benutzerdefiniertes Formular sein. + +Während die Einstellungen für den Text oder den Link oder sogar das Sharing-Tool ziemlich offensichtlich sind, kann die Einrichtung des Formulars ein wenig komplizierter sein. + +Aber es ist ein großartiges Feature, da du es sogar verwenden kannst, um ein Newsletter-Abonnement anzubieten, nachdem eine Person dein Event gespeichert hat! + +Bei der Arbeit mit dem Formular gibt die `URL` den Endpunkt an, an den wir die Eingaben senden. `Button-Text` kann verwendet werden, um anzupassen, was auf dem Absende-Button angezeigt wird. + +Als nächstes kannst du alle `Felder` spezifizieren, die du anzeigen möchtest. + +Sie sind im Grunde ähnlich dem RSVP-Formular. + +Der `Name` ist obligatorisch und wird verwendet, um das Feld im Backend zu identifizieren. Das `Label` ist das dem Benutzer gegenüber sichtbare Label, während du über `Platzhalter` und `Standard` die Werte der Felder (quasi) vorausfüllen kannst. + +Je nach Feldtyp können die verfügbaren Optionen unterschiedlich sein. + +Zwei Dinge zu beachten: +1. Wenn du eine Radio-Button-Gruppe erstellen möchtest, erstelle mehrere Radiofelder nacheinander. +2. Wenn du ein ausgeblendetes Feld "header" nennst und dessen Wert ein JSON-Schema ist, übermitteln wir dies als Header-Information. In diesem Fall wird das Formular als JSON gesendet; ohne Header als multipart/form-data. + +Du kannst deine Einstellungen immer über den Button ganz rechts auf dem Bildschirm testen. diff --git a/src/de/recipes/rsvp.md b/src/de/recipes/rsvp.md index 703ec8c..36222ad 100644 --- a/src/de/recipes/rsvp.md +++ b/src/de/recipes/rsvp.md @@ -77,7 +77,7 @@ Es verwendet jedoch immer noch die Standard-E-Mail-Vorlagen. Nicht schlimm - die * Passe alles nach deinen Wünschen und Vorstellungen an. * Nachdem du gespeichert und das Template erneut geöffnet hast, kannst du dir eine Test-E-Mail über den Button auf der rechten Seite des Bildschirms senden. * Wiederhole dies für alle verschiedenen Typen. -* E-Mail-Templates werden mit dem Style deines Events verknüpft. Gehe daher zurück zu deinem vorher erstellten Style-Element, aktiviere die erweiterten Einstellungen (falls noch nicht sichtbar) und wähle die E-Mail-Templates in den entsprechenden Dropdowns aus. +* E-Mail-Templates werden mit dem genutzten RSVP-Template verknüpft. Gehe daher zurück zu deinem vorher erstellten Element und wähle die E-Mail-Templates in den entsprechenden Dropdowns aus. ## ✨ Die Landingpage individualisieren diff --git a/src/de/recipes/waitlist.md b/src/de/recipes/waitlist.md index b275f55..22abdac 100644 --- a/src/de/recipes/waitlist.md +++ b/src/de/recipes/waitlist.md @@ -55,5 +55,5 @@ Wie bei allem, was du bei Add to Calendar PRO erstellst, kannst du es bis ins Kl Vielleicht hast du bereits einen spezifischen Style verwendet. Dieser bietet bereits viele Optionen. -Davon abgesehen solltest du benutzerdefinierte E-Mail-Templates einrichten und sie mit dem Style verlinken. +Davon abgesehen solltest du benutzerdefinierte E-Mail-Templates einrichten und sie mit dem RSVP-Formular verlinken. Auf diese Weise kannst du allen E-Mails, die an den Benutzer gesendet werden (z.B. für die Anmeldebestätigung), eine individuelle Note verleihen und sie an deinen spezifischen Fall anpassen! diff --git a/src/recipes/rsvp.md b/src/recipes/rsvp.md index 9dc27b8..8d38de0 100644 --- a/src/recipes/rsvp.md +++ b/src/recipes/rsvp.md @@ -77,7 +77,7 @@ However, it still uses the default email templates. Nothing wrong with that! It * Adjust and set a style. * After saving and opening the template again, you can send yourself a test email via the button on the right side of the screen. * Repeat this for all different types. -* Email templates get linked to the style of your event. So, get back to your style, activate the advanced settings (if not already visible) and select the email templates at the respective dropdowns. +* Email templates get linked to the RSVP template. So, get back to it and select the email templates at the respective dropdowns. ## ✨ Enrich the landingpage diff --git a/src/recipes/waitlist.md b/src/recipes/waitlist.md index 86fd4aa..3eea13a 100644 --- a/src/recipes/waitlist.md +++ b/src/recipes/waitlist.md @@ -56,5 +56,5 @@ As with all things you create at Add to Calendar PRO, you can customize the hell You might already have used a specific style. This comes with a lot of options, of course. -Besides that, you should set up custom email templates and link the to the style. +Besides that, you should set up custom email templates and link them to the RSVP. This way, you can give all the emails that are send to the user (e.g. for signup confirmation) an individual touch and adjust it to your specific case!