Skip to main content

Creating referrals via Bloomreach Engagement

To make the most of your integration with Bloomreach Engagement, you can create referral codes directly from your Bloomreach Engagement platform using our generic CEP endpoints and use them in your customer engagement efforts.

In your Bloomreach Engagement scenario, you can use a combination of operators and actions to send referral codes generated in Talon.One to relevant users based on custom conditions. For example, when the user shares the URL of a product you wish to promote, you can email them a referral code.

Prerequisites​

  • Talon.One
    • You understand the parameters required by the Create referral endpoint, for example, a valid campaign ID.
  • Bloomreach Engagement
    • You know your audience and scenario execution requirements, for example, your preferred email provider.
    • You created the relevant events and properties in the Data Manager.
tip

A good understanding of email marketing can help you tailor your scenarios effectively. We highly recommend you read the Bloomreach documentation first.

Creating an Integration API key​

An Integration API key allows authentication for incoming webhook requests. In Talon.One, let's create an API key to aid authentication in a later step.

To create an API key:

  1. In your Talon.One Application, click Settings > Developer settings.
  2. Click Create API Key.
  3. For Do you want to use this API Key with a 3rd party service?, select Yes.
  4. From Platform, select Customer Engagement Platform.
  5. Select an expiration date, and click Create API Key.
  6. Copy the key for later use.

    7. note
    You cannot display the API key after this step. If you lose the value, create a new API key.

Configuring webhook authentication​

In Bloomreach Engagement, let's configure the webhook authentication for Talon.One so that data can be passed securely in the webhook request. We will use this webhook authentication while creating a scenario in a later step.

To configure webhook authentication:

  1. In Bloomreach Engagement, open Data & Assets > Integrations.

  2. Click Add new integration > HTTP Authentication Schemas > Add integration.

  3. In Endpoint, type the endpoint URL to create a referral from a generic CEP.

    GET Create referral
    https://integration.talon.one/customer_engagement/referral

  4. Click Custom headers, and enter the following headers:

    KeyValueType
    AuthorizationApiKey-v1 <API-key>, where <API-key> represents the API key you generated.public
    destination-hostnameThe base URL of your Talon.One deployment.public
    customer-engagement-platform-nameBloomreachEngagementpublic

  5. Rename the integration appropriately.

  6. Click Save integration.

Creating a scenario​

In Bloomreach Engagement, let's create a scenario to automate the communication with our users based on custom conditions.

Specifically, let's use an action to send a webhook request to Talon.One for a new referral code. Let's then use another action to forward the received value from the first webhook's response in an email to our users.

note

Your scenario path may vary from the following steps depending on the actions you decide to implement and the dynamic data you choose to include in your user communication. See Personalization Using Jinja.

To create a scenario:

  1. In Bloomreach Engagement, open Campaigns > Scenarios > Create new.
  2. (Optional) Click the edit symbol in the scenario name to change it.
  3. Create and configure the triggers and operators that best suit your campaign needs.
  4. Create an action with the webhook request to Talon.One.
    1. In the Editor tab of the action:

      1. Enter the endpoint URL with the required parameters. To understand the request format, see the API Docs.

        note

        To see the Application ID and campaign ID of your campaign:

        1. Open your Talon.One campaign.
        2. In your browser, check the URL. It should look similar to:
        https://mycompany.europe-west1.talon.one/applications/198/campaigns/373

        In this example, the Application ID is 198, and the campaign ID is 373.

      2. Click Do not process response, and select Process response as JSON.

    2. In the Settings tab of the action:
      1. Enable Authentication and select the webhook authentication you created.
      2. In Other, select the required consent category for your users.
    3. Click Done.
  5. Create another action to send the generated referral code in a message to your users. For example, create an Email or SMS action.

    1. In the Editor tab of the action, compose your message with the desired personalization.

    2. In the message composition field, type the following placeholder value so the generated referral code is populated dynamically when the scenario runs:

      {{ webhook.code }}
      note

      Property names are case-sensitive. Type webhook.code with a lowercase c, according to the response of the Create referral endpoint.

    3. In the Settings tab of the action, review your recipients and the tracking consent category.

    4. Click Done.

  6. Click Save.
tip

You can also create a webhook preset, which is a reusable webhook template that you can use in your Bloomreach Engagement scenarios.

Next steps​

Before you launch your scenario, you can test and preview the complete workflow in the Test tab. When you click Start, you will see a confirmation window indicating how many customers will be affected by the scenario run.