en:how_to_create_an_interface

This is an old revision of the document!


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”.

1. 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.

2. 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.

3. 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.

4. Copy interfaces

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

en/how_to_create_an_interface.1686563882.txt.gz · Last modified: 2023/06/12 11:58 by bk