Configuration- APIs

Setup Access to Receive Relay Push Events

Adding API Component

Step #	Description	Salesforce Marketing Cloud
1	Under Components – click Add Component.
2	Select API Integration – click Next.
3	Select Server to Server – click Next.
4	Under Add Component, scroll down to section Data and for data extensions select Read & Write Permissions and click Save

Relay Custom Journey Activity

Clients can create two custom journey activities as part of the package if they wish to have two components displayed in the journey builder palette – one for production and one for staging. The difference being the URL, which is explained in the steps below.

Step #

Description

Salesforce Marketing Cloud

Under Components – click Add Component
Select the option Journey Builder Activity and click Next

cact journey builder activity

Enter the details for the hosted relay network journey activity


Name	Required field. Enter “Relay Network”
Description	Optional field. “Execute Relay Experience from Marketing Cloud”.
Category	Required field. Select “Custom”.
Endpoint URL	Staging https://api.relaystaging.com/sfmc/jbca Production https://api.relayzone.com/sfmc/jbca

cact hosted activity

Establishing Connectivity with CX Builder

In order to subscribe to Relay Push Events/Web Hooks which flow into the relay_response_log data extension in your Salesforce Marketing Cloud instance, certain Salesforce Marketing Cloud keys must be obtained and configured for setup in Relay CX Builder.

Checklist of Salesforce Marketing Cloud Keys to be configured in CX Builder are:

Client Id
Client Secret
REST Based URI
Authentication Base URI
JSON Web Token (JWT) Signing Secret
Account ID

Step #	Description	Salesforce Marketing Cloud
1	Login to Salesforce Marketing Cloud and go to Setup. In the Quick Find, search for “Installed Packages” Click on Relay Network and obtain the below details: Client Id Client Secret REST Based URI Authentication Based URI JWT Signing Secret
2	Login to Salesforce Marketing Cloud and go to Setup In the Quick Find, search for “Account Settings” Obtain the below details: Account ID
3	Login to CX Builder to Enter the Details and Establish Connectivity Once you are signed in, click on the API Management in the left menu column. Click on the Push API Integration tab. This is the “home page” of the Push API Integration UI, where you will see a list of existing integrations for the selected client (if any exist). Note: If you do not see the API Management module on the left menu, please check that you have either Client Admin or Client User with Integration Permissions in the system
4	To add an integration, click the “ADD INTEGRATION” button. A modal will pop up with a dropdown, where you will select Salesforce Marketing Cloud
5	Enter the details obtained from SFMC on this screen: Name: This is the name of the integration you are creating, and can be named whatever you wish to refer to it as. Version: Select the version of this integration form with which you wish to integrate your client. The latest version is selected by default. Client ID: This is the client id acquired from Salesforce, not the client’s Relay client id, and can be obtained from the client’s Salesforce Marketing Cloud instance. Client Secret: This value can be obtained from the client’s Salesforce Marketing Cloud instance. REST Base URI: This value can be obtained from the client’s Salesforce Marketing Cloud instance. Should resemble a URL and begin with: `https://...` JWT Signing Secret: This value can be obtained from the client’s Salesforce Marketing Cloud instance. Authentication Base URI: This value can be obtained from the client’s Salesforce Marketing Cloud instance. Should resemble a URL and begin with: `https://...` Account ID: This value can be obtained from the client’s Salesforce Marketing Cloud instance.
7	Obtain the Auth Hash from CX Builder At the bottom of this screen, you will see an Auth Hash, use the copy icon to the right to copy this value and save it for the next step where you will add it to SFMC

Setup Access to Relay’s Rest APIs to Trigger Experiences

In order to call the Relay APIs to trigger experiences from your Salesforce Marketing Cloud instance you need to store certain keys in Salesforce Marketing Cloud that have been provided by your Relay Client Success representative.

Checklist of Salesforce Marketing Cloud Keys to be sent to Relay are:

Auth Hash

Data Extension Mapping:

Field	Staging Connection	Production Connection
Metadata Id	1	2
Metadata Name	relayauthhash_staging	relayauthhash_production
Metadata Value	Auth Hash Value from CX Builder Staging	Auth Hash Value from CX Builder Production

Step #	Description	Salesforce Marketing Cloud
1	Store the Auth Hash in Salesforce Marketing Cloud: Login to Salesforce Marketing Cloud, go to the Audience Builder>Contact Builder. Go to and select Data Extensions. Click on relay_network_metadata, click the Records tab. Select Add Record

Step #

Description

Salesforce Marketing Cloud

Store the Auth Hash in Salesforce Marketing Cloud:

Login to Salesforce Marketing Cloud, go to the Audience Builder>Contact Builder.
Go to and select Data Extensions.
Click on relay_network_metadata, click the Records tab.
Select Add Record

Update External Keys

Step #	Description	Salesforce Marketing Cloud
1	Navigate to Email Studio Navigate to Subscribers, and then to Data Extensions
2	Under Data Extensions (subfolder relay network if data extensions are in a sub folder) select the data extension relay_network_metadata
3	Change the external key of the data extension to the data extension name – relay_network_metadata and click DONE. This should update the external key of the data extension. If the external key already matches, there is no action to be taken.
4	Repeat the steps above for each main Data Extension listed below so the external keys match the name of the data extension.

Adding Relay Network Data on the Contact Builder

For the Salesforce Marketing Cloud Journey Builder to pick up the correct values for a ccid it is necessary to add the relay_network_data data extension to the Contact builder attribute group.

Step #

Description

Salesforce Marketing Cloud

Navigate to Audience Builder, then choose Contact Builder.

On the Data Designed, click on Create Attribute Group.

Enter Relay Network as the attribute group name and select the most appropriate icon.

In the data designer, click on Link Data Extension

On the Link Data Extension pop up, navigate to the relay_network_data in the right-hand frame. Select the data extension relay_network_data.
In the left side frame (Customer Data) select Contact Key, and in the right side frame (relay_network_data) select ccid.
In the right side frame (relay_network_data) select a one-to-one join type. Click Save.

In the left side frame (Customer Data) select Contact Key, and in the right side frame (relay_network_data) select ccid.
In the right side frame (relay_network_data) select a one-to-one join type. Click Save.
On the Verify your change pop up, Click Done.