CleverReach connection for newsletter registrations

With the Newsletters extension, collecting and using email addresses is easier than ever! The extension ensures that your users' email addresses can be transferred to CleverReach via REST API. How? It's simple: open the synchronization view in the Newsletters backend module (Pro version) and synchronize your data.

What's special: using so-called connection records, you can create different recipient lists and link them directly to your record containers. This way, the collected data automatically ends up where it belongs – ready for your next email marketing mailing.

Why is this cool? You save time, automate your processes, and can fully concentrate on your marketing.

Preparation of the CleverReach REST interface

To be able to use the Newsletters extension with CleverReach, we need to establish an OAuth connection. To do this, proceed as follows:

1. Log in to CleverReach
2. Click on your avatar at the top right and on My Account
3. Now click on the REST API item in the Interfaces tab
4. Click on Create OAuth2 app at the top right to define the interface
5. Give the app a name and select REST API Version 3
6. Define in which scope the app is allowed to manage data. Select Recipients here

Creation of a connection record

The connection record establishes the link between your newsletter topics (topic records) and the CleverReach recipient lists. You can therefore create a connection for each of your record containers and then decide exactly where the email address should be synchronized when assigning it in the topics.

1. Create a record of type Connection
2. Select the entry CleverReach for the Type and save the record
3. Give the new connection a descriptive title so that your editors know exactly that the data is being pushed to CleverReach and which recipient list it ends up in
4. Enter the Client ID and the Client Secret that you generated in the CleverReach login
5. The Authorize URL and Token URL should already fit as pre-entered
6. The Redirect URI is any URL from your frontend
7. As soon as you save, you will receive a new info display in your record - here you can complete the OAuth authorization by clicking on CleverReach authorization
8. After clicking, a CleverReach page opens (don't be unsettled by the red message - it only means that CleverReach has not yet verified this extension) on which you only have to enter your access data by clicking on connect
9. Finally, you will be redirected to your own website, where Authorization successful now indicates that the connection has been established
10. Finally, you only have to specify in the connection record which recipient list your email addresses should be entered into.

Attention:

Sometimes it can take a moment for a newly transferred recipient to become visible in CleverReach! It can also happen that a recipient is displayed, but their fields are still empty and the field contents appear a bit later!

Troubleshooting

Calling the CleverReach authorization ends with a 404 error

The call to authorization results in a:

Page Not Found
Reason: Request parameters could not be validated (&cHash empty)

Solution 1.:

Open the Install Tool and deactivate the pageNotFoundOnCHashError setting: [FE][pageNotFoundOnCHashError] = false

$GLOBALS['TYPO3_CONF_VARS']['FE']['pageNotFoundOnCHashError'] = false;

Solution 2.

Remove the parameters of the request from the cHash calculation (LocalConfiguration/settings.php):

$GLOBALS['TYPO3_CONF_VARS'] = array_replace_recursive(
    $GLOBALS['TYPO3_CONF_VARS'],
    [
        'FE' => [
            'cacheHash' => [
                'enforceValidation' => true,
                'excludedParameters' => [
                    'connection',
                    'code',
                ],
            ],
        ],
    ]
);

Error: No page configured

If the error message "No page configured for type=1766752431." appears during authorization, make sure that the static TypoScript template is present on the root page.

Permission denied!

Sometimes it happens that the authorization initially shows "Permission denied!" when redirecting to your page. Try placing the cursor in the browser's address bar and reloading the page – this might solve the problem.

Only your website appears after authorization?

Open the network console in your developer tools in the browser and inspect the requests.

In this case, the problem is that a redirect based on the user agent takes place to directly display the correct language. I.e. the Redirect URI in the connection record must not be https://www.coding.ms/, but the address resulting from the language redirect - i.e. https://www.coding.ms/en/.