This is an old revision of the document!
Table of Contents
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.
If you use SOAP, you will find all address interfaces under Addresses > Generation. To do this, read the step-by-step instructions in the article “how_to_create_a_new_adress_generation”.
Creation of an interface
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.
Menue item Sheet
Configure hooks
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.
Insert URL for redirects
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.
Copy interfaces
At the top right of the interface you have the option of copying the created interface with all the associated settings.
Menue item Log
Here you will find a list of user actions:
| Created | Timestamp when the user performed the action |
| Action | registration or confirmation of the registration |
| Process | Code that establishes the connection between registration and confirmation |
| IP address | IP address of the user |
| User ID | User ID of the user |
| Message | Comment entered via API (optional) |
menue item Statistics
Above you will find the following two statistics:
Registrations - Number of registered logins. In the case of double optin procedures, regardless of whether the registration was confirmed by double optin.
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.
menue item DOI campaign
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.
Creating a double opt-in email
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 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
