Webhook Connection

What:  The Webhook connection allows you to pass BlueConic data to webhooks of external marketing automation platforms. The connection also allows you to import data returned by the webhook!

 

About BlueConic: BlueConic is a Customer Data Platform that harnesses the data required to power the recognition of an individual at each interaction, and then synchronizes their intent across the marketing ecosystem. Click here to learn more.

Why: You want to connect BlueConic to a marketing platform for which there is no specific BlueConic connection. Many marketing platforms provide RESTful interfaces for other systems to interact with. BlueConic can leverage those interfaces to tie into the other systems using this generic webhook connection. Whenever the value of configured profile properties change in a profile, the BlueConic will trigger a request to the webhook and synchronize information.

 

Concepts

Profiles changes in BlueConic

As your visitors land on your channels and start interacting with them, their BlueConic profiles will get more rich over time. Handing off information to other martech systems helps you leverage this information or even enrich the BlueConic profile even further. The trick is to hand off the right information at the right time. This is why the webhook connection comes with triggers based on profile properties changing values: the hand-off will always happen at the right time for every visitor.

 

Configuring the connection

Setting up a new Webhook connection consists of only a couple of steps. Click "Trigger a request" to start configuring. Simply follow the numbered configuration steps presented:

1. Define the channels

Here you select the channels that can trigger a request, and you can optionally restrict the connection to specific parts of the channel:

 

2. Select BlueConic segments

Here you can select one or more segments. Only visitors that are part of at least one of the segments can trigger the webhook. Select the segment "All Visitors" if you didn't have a specific segment in mind.

 

3. Select BlueConic triggers

The webhook connection will be triggered for a visitor when the value of one or more profile properties changes. Here you determine which profile properties will be monitored for value changes.

4. Configure Webhook request

This is where the actual magic happens; you will have to define how the connection will interact with the RESTful API of the external system. You will have to look up the exact technical details in the API documentation of your external system of choice. We have provided some examples to help you get started.

RESTful APIs by definition work based on web requests. So we have to specify the exact details of the web request that has to be sent:

Request URL
This is the URL of the Webhook as specified in the API documentation of the external system. Sometimes this URL has to contain profile information, in which case you can leverage Mustache tags to insert profile property values. Use the id of a profile property to identify it. For example, to insert the email address use {{{email.0}}}. Note how we use the triple braces {{{ ... }}} to prevent the default HTML escaping behavior of Mustache. Also, we use .0 as a safeguard to make sure we only pick the first value of the email profile property in case it contains multiple values.
Request method
The request method as specified in the API documentation of the external system. Pick one of GET, POST, PUT, PATCH or DELETE.
Request body
The GET method puts all of its parameters in the URL. All other methods use the body of the request to pass on parameters. Use Mustache tags to Construct a request body as described in the API documentation of the external system and use Mustache tags based on the id of profile properties to insert values.
Request headers
The request headers exist of name/value pair as described in the API documentation of your external system of choice. In the header value field you can use Mustache tags based on the id of profile properties to insert values.

 

5. Optionally map the Webhook response to BlueConic profile properties

After a successful Webhook request has been made, the external system might return a JSON response. You can create mapping rules to parse the Webhook response using JsonPath to obtain values and store those values in profile properties.

Click Add mapping to add more mapping rules. You can play around with JsonPath using the Online JsonPath Evaluator. The API documentation of your external system of choice should have example output to play around with.

 

6. Test Webhook

Once you have configured all settings of your connection, you can test the Webhook connection. Enter test values for all the trigger profile properties, then press the [Send test request button] to test your Webhook connection!

Click "Show request" and "Show response" to see what was sent and received from the Webhook.

 

Examples

Here are a few examples for your convenience. Click a service to see its settings.

FullContact

Enrich your contact information using FullContact.

Request Method GET
Request URL https://api.fullcontact.com/v2/person.json?email={{{email.0}}}
Request Headers
Field Name Field Value
X-FullContact-APIKey your API key
Response Mapping
Response Field Profile Property
fullName Name
$.organizations[?(@.current)].name Company
$.organizations[?(@.current)].title Job Title
Slack

Have BlueConic chat you up using the Slack API!

Request Method POST
Request URL https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
Request Body
{
    "text": "{{#surname}}{{firstname.0}} {{surname.0}}{{/surname}} visited the product overview!\n"
}
Request Headers
Field Name Field Value
Content-Type application/json

 

The Webhook Connection is a certified plugin