How do I create an interface?

For a newsletter, new addresses are generally obtained automatically, e.g., via the company website. When using REST, you will find the interfaces under Addresses > Interfaces.

Via Addresses > Interfaces, you can create a new interface with this button:

The following window opens via Create interface, in which you assign a name, select the channel (E-mail, App Push, SMS, Print, Web Push, Voice), the opt-in type (Double opt-in, Single opt-in), and configure hooks. You can also enter a URL for redirects.

Now the interface has been created and provided with an ID.

Under Add hook, you can define which Action should be carried out with the generated address. First, choose between the following actions:

Now select a target group for which the action is to be carried out under List.

After a successful or failed login, you can be redirected to any page. To do this, enter a URL, e.g., a confirmation page on your company website.

You can specify a URL, including a protocol for forwarding, if the login was successful. Appending parameters is possible to personalize the landing page. You can also enter a URL, including a log for forwarding, in the event of a failed login.

At the top right of the interface, you have the option of copying the created interface with all the associated settings.

Here you will find a list of user actions:

Above you will find the following two statistics:

Registrations: Number of registered logins. In the case of double opt-in procedures, regardless of whether the registration was confirmed by double opt-in.
Confirmations: Number of registered registrations whose e-mail address was not included in the master data before registration.

Below you will find the openings and clicks on the DOI Mail.

This tab only appears if Email was selected as the channel and Double Opt-In was selected as the opt-in type.

You can create one or more messages. The message that is to be used for the DOI Mail must be activated.

The available messages are displayed in a list. (Maximum) one message is active. The active one is used for delivery. It cannot be edited. To change the active message, you can copy it and edit the copy or create a new one. Activating the message created in this way will deactivate the previously active message.

Don't forget to configure sender and subject too!

You can use $confirmToken, which contains the opt-in confirmation token. This token can be used to confirm an opt-in via REST API. This placeholder is not replaced in the preview of this mail and is only available when the double opt-in mail is actually sent.

Example URL: https://foo.bar.com/?token=$confirmToken

If you want to use our system and still want to use a replaced URL for tracking you can use this URL: https://system.promio-connect.com/optin/?token=$confirmToken

Under this menu item, you can configure a form for address generation that you can embed on a website or call up as a stand-alone page.

In the Content tab, you can select the fields that your form should contain.

The same newsletter can be selected as often as you like.

Validation is not possible in the preview.

Here you can enter and format text that should be displayed after the completed form has been submitted.

Set the font, font size, font color, and primary color of the button. You can optionally insert a custom CSS.

Select a language. To use a separate page for the form, enter an image path and an imprint link.

Here you can see the preview of the created form.

Copy the code of the created form to embed it on a web page or copy the code for a stand-alone page.