Salesforce Marketing Cloud

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

System limitations

The Salesforce Marketing Cloud connector can process a maximum of 7 transactions per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Actions

This section lists all the actions supported by the Salesforce Marketing Cloud connection.

GetJourneyPublicationStatus action

This action gets the status of a journey publication.

Input parameters of the GetJourneyPublicationStatus action

Output parameters of the GetJourneyPublicationStatus action

This action returns the status 200 (OK) with a response body indicating all results.

For example on how to configure the GetJourneyPublicationStatus action, see Examples.

FireEntryEvent action

Fire the entry event that initiates the journey.

Input parameters of the FireEntryEvent action

Output parameters of the FireEntryEvent action

This action returns the status 200 (OK) with a response body indicating all results

For example on how to configure the FireEntryEvent action, see Examples.

StopJourney action

Stops a running journey

Input parameters of the StopJourney action

Output parameters of the StopJourney action

This action returns the status 200 (OK) with a response body indicating all results

For example on how to configure the StopJourney action, see Examples.

PublishJourney action

PublishJourney Action Publishes a journey version asynchronously

Input parameters of the PublishJourney action

Output parameters of the PublishJourney action

This action returns the status 200 (OK) with a response body indicating all results

For example on how to configure the PublishJourney action, see Examples.

CreateTriggeredSend action

CreateTriggeredSend Action Creates a triggered send object which represents a specific instance of a triggered email send

Input parameters of the CreateTriggeredSend action

Output parameters of the CreateTriggeredSend action

This action returns the status 200 (OK) with a response body indicating all results

For example on how to configure the CreateTriggeredSend action, see Examples.

SendTransactionalMessageToRecipient action

SendTransactionalMessageToRecipient Action Sends a message to a single recipient via a send definition

Input parameters of the SendTransactionalMessageToRecipient action

Output parameters of the SendTransactionalMessageToRecipient action

This action returns the status 200 (OK) with a response body indicating all results

For example on how to configure the SendTransactionalMessageToRecipient action, see Examples.

Examples

This section describes how to perform some of the entity operations and actions in this connector.

Example - Get the status of a journey publication

1. In the Configure connector task dialog, click Actions.
2. Select the GetJourneyPublicationStatus action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "StatusId": "3acf1f54-5c9e-4719-b7f7-bfc2e5caf10a"
   }
   

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

 [{
  "Status": "PublishCompleted",
  "Message": null
}] 

Example - Fire an entry event to initiate a journey

1. In the Configure connector task dialog, click Actions.
2. Select the FireEntryEvent action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "ContactKey": "Email",
     "EventDefinitionKey": "APIEvent-4d84e619-a629-6b17-945f-9a6e78a1982c",
     "Data": "{\"Email\": \"usr1@test.com\"}"
   }
   

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

 [{
  "EventInstanceId": "0d6f6dd1-1aaa-4eec-9727-f99550ab68f9"
}]

Example - Stop a running journey

1. In the Configure connector task dialog, click Actions.
2. Select the StopJourney action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "JourneyId": "37D2789E-2B1D-433E-8E18-8F47E4D8E865",
     "JourneyVersion": 1.0
   }
   

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

  [{
  "Success": true
}] 

Example - Publish a journey version

1. In the Configure connector task dialog, click Actions.
2. Select the PublishJourney action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "JourneyId": "0868BF36-3107-460E-9EF1-09633A0592E8",
     "JourneyVersion": 1.0
   }
   

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

 [{
  "StatusId": "acb1734d-483e-400a-97d7-0501b94f03b2"
}]  

Example - Create a trigger to initiate a journey

1. In the Configure connector task dialog, click Actions.
2. Select the CreateTriggeredSend action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Key": "BU27_SendDefinition1",
     "ToAddress": "usr1@test.com",
     "SubscriberKey": "107",
     "SubscriberAttributes": "{\"FirstName\": \"John\", \"LastName\": \"P\"}"
   }
   

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

 [{
  "Success": "True",
  "RecipientSendId": "5d06edb1-d07c-48ad-a1f2-d6350eb863f8",
  "Messages": "Queued"
}]  

Example - Send a message to a single recipient

1. In the Configure connector task dialog, click Actions.
2. Select the SendTransactionalMessageToRecipient action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "MessageKey": "T9999009",
     "DefinitionKey": "Send-Definition-SFMC-Demo-2",
     "RecipientContactKey": "107",
     "RecipientTo": "usr1@test.com",
     "Attributes": "FirstName :John"
   }
   

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

[{
  "RequestId": "d8fb9e9e-3ae2-412f-b01e-d198433cfc16"
}] 

Example - List records in an entity

This example lists the records in the Assets entity.

1. In the Configure connector task dialog, click Entities.
2. Select Assets from the Entity list.
3. Select the LIST operation, and then click Done.
4. In the Task Input section of the Connectors task, you can set the filterClause as per your requirement.

   For example, setting the filter clause to Location='US' and region='us-east1', lists only those records in the US location whose region is us-east1.

Example - Get a record from an entity

This example fetches a single record from the Assets entity.

1. In the Configure connector task dialog, click Entities.
2. Select Assets from the Entity list.
3. Select the GET operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 49851 in the Default Value field.

   Here, 49851 is the primary key of the Assets entity.

Example - Delete a record from an entity

This example deletes a record from the Assets entity.

1. In the Configure connector task dialog, click Entities.
2. Select Assets from the Entity list.
3. Select the DELETE operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 49851 in the Default Value field.

Example - Create a record in an entity

This example creates a record in the DataExtensionObject_Custom entity.

1. In the Configure connector task dialog, click Entities.
2. Select DataExtensionObject_Custom from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "StudentName":"John",
       "StudentID":"1",
       "Rank":"1"}

   If the integration is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

    {
         "StudentID": 1
       } 

Example - Update a record in an entity

This example updates a record in the Journeys entity.

1. In the Configure connector task dialog, click Entities.
2. Select Journeys from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Name": "SFMC_CRETAE_JOURNEY_V1"
   }

5. Set the entity ID to the entity of the Journeys . To set the entity ID, click entityId and then enter 0868BF36-3107-460E-9EF1-09633A0592E8 in the Default Value field.

   If the integration is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

   {
     "Id": "0868bf36-3107-460e-9ef1-09633a0592e8"
   }

Use the Salesforce Marketing Cloud connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

• To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
• To understand how to create and use the Connectors task in Application Integration, see Connectors task.