How to use custom connectors

Prev Next

The Data Activation platform offers many standard integrations with industry-standard platforms. If your platform isn't available as a standard integration, we can create a custom connector specifically tailored to your needs — within the capabilities of both the Data Activation platform and the target platform.

Using a custom connector is as easy as using a standard platform connector, with a few differences highlighted in this article.

Use a custom connector when:

  • Your target platform isn't available as a standard integration

  • You need a tailored integration for audiences and journeys

  • Standard connectors don't meet your specific requirements

Setting up a custom connector

Standard connectors can be set up by selecting Connectors in the left side navigation and selecting the Server-to-Server Connectors.

Custom connectors are configured by the Supermetrics team, and they appear in the Server-to-Server Connectors overview. You can customize the Logo, Name, and Partner number in collaboration with us.

Using a custom connector

A custom connector works the same way as a standard server-to-server connector. You can select it while configuring connectors in your audience or journey.

The main difference is in fetching connector segments where you send profiles. For standard integrations, we fetch this list automatically. With custom connectors, you use a free-format text box named External ID to define the segment or event you want to send to the connected system.

The External ID field is optional. However, if your integration uses this field, leaving the External ID blank will result in errors. The value in the External ID field must match the configuration of the connected system exactly to successfully add profiles to the correct segment, activity, or list. Customers typically use a campaign, audience, list, segment, or event key or name for this field.

Requesting a custom connector

To request a custom connector, reach out to your consultant or partner first. Then send a ticket to support@relay42.com with the following information:

  • API documentation, including endpoint, payload, headers, and authentication method

  • API test credentials

  • Technical contact (client or partner) details

  • Use case description

  • Expected due date

After receiving this information, we review and test the API, then define an ETA for the new custom connector. We then develop the connector and share a testing plan to complete with your consultant or partner before the final go-live.

Data sent through custom connectors

Here's an example of the payload a custom connector receives from the audience and journey engine:

{
  "siteNumber": 1234,
  "partnerNumber": 2001,
  "partnerAudienceId": "2582431",
  "relay42AudienceNumber": 101,
  "partnerIds": ["037f9dcf-e108-481a-8ad2-e6988e1acfa7"],
  "audienceVariables": {"TestVar": "testValue"},
  "profileId": "29401b86-7c96-43d6-a40d-9f0ea670e19f",
  "sourceId": "94844bd8-f129-480d-a1c9-e806d177d15a",
  "data": {"Custom": "Test Custom"}
}

In this JSON objects are defined below:

  • siteNumber: Value specific to your organization

  • profileId: Internal profile identifier

  • partnerIds: Array of profile external identifiers

  • partnerNumber: Type of external identifier to send to the connected system

  • relay42AudienceNumber: Audience identifier

  • audienceVariables: Profile-level information (can be adjusted based on use case)

  • data: Audience-level information (can be adjusted based on use case)

Note

The custom connector uses this input to call the connected system endpoint. Filtering, aggregation, and transformation are possible — this payload won't necessarily be sent as-is to the connected system.