Prerequisites and considerations

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

In order to successfully integrate your Conversation API project and apps with your Salesforce account, you must ensure that the following prerequisites are met.

Salesforce prerequisites

In order to successfully connect a Conversation API project to a Salesforce account, and use the Omnichannel connector with Marketing Cloud, you must have:

• A license for the Salesforce Marketing Cloud service.

• A corporate or enterprise edition of Marketing Cloud.

• A Marketing Cloud Org set up.

• An account with Marketing Cloud administrator privileges readily available.

Note that, at this time, the Omnichannel Connector app only supports Multi-Step journeys.

Conversation API prerequisites

In order to successfully connect a Conversation API project to a Salesforce account, and use the Omnichannel connector with Marketing Cloud, you must have:

• At least one Conversation API app with at least one configured channel. For information on how to create a Conversation API app and configure a channel on that app, see this Getting started guide.

• At least one omni-channel template or channel-specific template. Templates can be created using the API or the Message Composer functionality of the Sinch Build Dashboard. Additionally, you may create new omni-channel templates during the configuration of the Omni Channel message activity.

  Note:

  Omnichannel Connector support for the explicit channel message functionality of the Conversation API is currently under development.

• A Conversation API webhook that is configured to deliver information to the Omnichannel Connector app. This requires that you set the appropriate values for Target URL and Triggers.

  • Set the Target URL to https://sfmc-omni-connector.prod.sinch.com/omnientry/webhook/{{MID}}, where {{MID}} is your current Organization ID. Your MID is displayed in your accound drop-down menu at the top of your Salesforce Marketing Cloud page.

    Note:

    If your organization has sub-organizations, and your Omnichannel Connector solution(s) is/are associated with those sub-organizations, you must set the {{MID}} value to the MID of the sub-organization (NOT the MID of the parent organization).

  • Select the MESSAGE_DELIVERY, MESSAGE_INBOUND, and CONTACT_CREATE webhook triggers from the Triggers drop-down list.

    Note:

    You can create up to five webhooks per Conversation API app.

Production requirements

In order for your Omnichannel Connector app/solution to be available for production use, you must provide Sinch's provisioning service with the following pieces of information:

• The name of your organization.

• The Marketing Organization ID of your organization's Marketing Cloud solution. Note that this value may be the same as the Enterprise ID.

• The Enterprise ID of your organizations's Marketing Cloud solution. Note that this value may be the same as the Marketing Organization ID.

• A contact name and email for the account associated with your Marketing Cloud solution.

• Your Sinch Account ID.

Endpoint considerations

The Omnichannel Connector app makes use of several of Sinch's endpoints. These include: