Omniconnect Set-Up

🚧

Prerequisites:

Before starting the Set-Up process, make sure that you have:

• A Bloomreach Engagement project with integration access,
• Fair knowledge of Javascript.

Select a Platform

Before getting into Omniconnect, it is vital to identify the platform you want to integrate with. Your selected platform needs to support Webhooks; otherwise, the integration will not be possible.

📘

Note

Each platform identifies Webhooks differently. It is possible that your selected platform might call it differently. Some common examples of alternative names can be API Notifications or Web Service Requests.

For the purpose of this guide, Typeform will be used as an example. You can follow the same steps with other platforms and adjust the process to your needs.

Watch this short demo on how to integrate Typeform with Bloomreach Engagement.

1. Add a New Integration

To integrate with a 3rd party platform using Omniconnect, go to your Bloomreach Engagement account. From there,

1. Go to Data & Assets > Integrations.
2. Click on + Add new integration.
3. Search for Omniconnect.
4. Click + Add integration.

5. Give your integration a name and click on Save integration.
6. Provide a description that explains the function of this integration.
7. Copy the Omniconnect URL.

8. [Optional] Go to your Typeform Workspace > Connect > Webhooks > Add a webhook.

9. Paste the Omniconnect URL into the dedicated place inside the 3rd party platform (in this case, Typeform).

2. Transformation

The two platforms are now connected. It's time to look at the transformation function.

1. Go to your Omniconnect Integration in Bloomreach.
2. Click on Transformation.

Incoming request

The Incoming request dropdown menu lists the incoming data from the platform. We suggest you choose the most recent one.

Input

The input will be automatically updated once you select the required request. Go through the data to make sure everything is delivered to Bloomreach correctly.

Transformation Function

The next step is to write the Transformation Function. The transformation function will vary from integration to integration and allows for a high-level personalization of the integration using Javascript. To view the sample Typeform Transformation Function, visit the Use Cases part of this guide.

When the Transformation Function is done, click on Transform input. You will now see the data from the survey in the Output tab.

A successful request in Omniconnect should have the following characteristics:

Payload: JSON format e.g {}

Content type: application/json

Allowed methods: POST

Payload size: 500 KiB or less is recommended. If the payload is higher or equal to 1 MB, we cannot guarantee that Omniconnect can process all messages without issues or timeouts.

The following are Omniconnect return codes that allow us to understand the outcome of your API request before reaching the function. This offers insights into the cause of failure if the request is unsuccessful:

3. Track the Integration

Once you are happy with the Transformation part, click on Save changes.

You are now ready to go live with the integration! Do so by clicking on Start. The integration has now successfully started.

Go to Data & Assets > Customers to track the events coming to Bloomreach from the platform. The data from the platform will automatically update customer profiles.

4. (Optional) Turn on notifications

We recommend you turn on the notifications in case your integration fails. Whenever the integration encounters an issue, you will be notified via email and in-app notification.

To turn on notifications:

🚧

Prerequisite

Make sure your email notifications settings are turned on, otherwise this feature will not work. To turn them on, go to User settings > Notification settings > Get notifications via email.

1. Go to your Omniconnect integration.
2. Click on the three dots next to the Start button.
3. Click on Notifications.

4. Enter the email addresses of relevant project users you wish to subscribe to Omniconnect notifications. We recommend adding your implementation partner, internal teams, or technical teams, for example.
5. Click on Save.

5. Debugging

Some errors can appear due to payload changes in the third-party platform. The Bloomreach support team can identify any changes made to the transformation code by users in the Audit Log, which helps to identify the root cause of the error.

In this case, please contact Bloomreach support.