Skip to main content

Custom integration

A custom integration in BlueConic Experiences lets you send experience response data to any external platform via HTTP POST request. Use it to connect to platforms that don't have a native Experiences integration but accept inbound webhooks — for example, a CRM, loyalty tool, email service provider, or custom data pipeline. Once active, the integration fires automatically when an experience is submitted, passing the payload you define to the target endpoint.


Before you begin

  • Confirm the target platform accepts inbound HTTP POST requests.

  • Obtain the endpoint URL and authentication credentials (API key, bearer token, or username and password) from the target platform.

  • Review the target platform's required payload schema before building your request payload.


Set up a custom integration

To add a custom integration to an experience:

  1. In BlueConic Experiences, go to Integrations.

  2. Select Custom Integration.

  3. In the Integration Setup window, complete the configuration sections described below.

  4. Select Save, or select + Add New Instance to save and add another instance.


Configure the integration
General

Enter a name for the integration in the Integration Name field.

Auth method

Select the authentication method required by the target platform:

  • API Key — passes the key as a header or query parameter

  • Bearer Token — passes the token as an authorization header

  • Basic Auth — uses a username and password

  • OAuth 2.0 — uses a password grant flow

  • No Auth — sends unauthenticated requests

Credentials

Enter the Endpoint URL for the target platform (for example, https://api.example.com/v1/events). Then enter the credentials that correspond to your selected auth method.

Request payload

Build the JSON payload to send with each submission:

  1. Use the snippet buttons to insert available placeholders into the payload body: {{ email }}, {{ first_name }}, {{ last_name }}, {{ campaign_id }}, and {{ campaign_name }}.

  2. In the Payload body field, enter a valid JSON object or array. Reference placeholders using double curly braces, for example:

    {"email":"{{email}}","first_name":"{{first_name}}"}

You can also reference mapped attributes from the Mappings section using the same double-curly-brace syntax.

Data handling

Configure how the integration processes and shares data using the toggles below.

Toggle

Description

Default

Active

Enables data sharing. Turn this on to activate the integration.

On

Send in preview

Sends data while the experience is in preview mode.

Off

Include UIDs

Attaches a unique identifier to each record.

Off

Require opt-in

Limits data processing to users who have opted in.

Off

Region

Select the data region that applies to your endpoint: US, EU, or All Regions.

Mappings

Select + Add mapping to map additional experience attributes to fields in the target platform payload.

Additional options

Expand the additional options to configure advanced settings, including formatting, data structure, filtering, payload customization, and privacy controls. Click Save.


Next steps

  • Submit a test experience response and verify the payload reaches the target endpoint before activating in production.

  • If the target platform requires a specific payload schema, validate your JSON against it before turning on the integration.

  • To use the same custom integration across multiple experiences, see Manage multiple integration instances.


FAQ

Can I connect to a platform that doesn't have a native integration?

  • Yes. Any platform that accepts inbound HTTP POST requests can receive data from a custom integration.

What data can I include in the payload?

  • You can include standard experience attributes (email, first name, last name, campaign ID, campaign name) and any additional attributes you map in the Mappings section.

Can I add multiple instances of the same custom integration?

  • Yes. Select + Add New Instance when saving to configure multiple instances.

Did this answer your question?