External Activity
After you set up an extension, submit a request to create an activity type record. Then, submit a request to pass prospect activities to Account Engagement as they occur.
Keep these considerations in mind when working with External Activity.
- Before you work with external activities, review the considerations in Salesforce Help.
- The
DeveloperName
field from the MarketingAppExtension endpoint maps to the extension field on the external-activities endpoint used to submit the activity. - The DeveloperName field from the MarketingAppExtActivity endpoint maps to the type field on the external-activities endpoint used to submit the activity.
- To submit activities, the
IsActive
field on the activity type and extension must be set toTrue
. To set theIsActive
field, select Active in Automations on each record in Setup. - We recommend waiting to make an activity type active until you’re ready to begin using them.
- Activities are only submitted to the business unit assigned to the extension. Changing the business unit can affect your integration.
To work with external activities, authenticate to Account Engagement API and Tooling API using OAuth. Make sure that the appropriate OAuth Scopes are set up in your connected app:
- Access Account Engagement services (pardot_API)
- Manage user data via APIs (API)
To minimize the number of times you have to authenticate, grant new access tokens as they expire by adding the Perform requests on your behalf anytime (refresh_token, offline_access) scope.
To add an activity type to your marketing app extension, send a POST request to the MarketingAppExtActivity
endpoint. In this example, we configure an activity type “registered” for the extension we set up in the Marketing App Extensions section.
A successful request returns an 201 Created
response.
To submit activity data, send a POST request to the /api/v5/external-activities
endpoint.
- The extension value in the example is the DeveloperName returned from the Marketing App Extension response.
- The type value in the example is the DeveloperName returned from the Marketing App Extension Activity Type response.