Integrating with Braze

What's covered?

What is Connected Content?

Prerequisites

Create your Connected Content call

Completion Events

What is Connected Content?

Braze's Connected Content feature allows you to insert any information accessible via API directly into campaigns sent to your user base. By pulling content from eduMe's publicly accessible APIs, you can strategically deliver eduMe content to your users in real-time.

Prerequisites

To get started with Braze and eduMe, you’ll need the following information:

Choosing between team and group IDs

If your content is visible to a restricted set of teams, you'll need to use teamId, and a team ID value that matches one of the teams listed in the visibility settings of the content.

If your content is visible to all users in a group, or is a standalone survey (not part of a course), use groupId and the ID of the group.

Create your Connected Content call

To generate a seamless link through Braze Connected Content, and to track their progress against your internal user ID in eduMe, use the following format in the URL fields for your link in Braze, updating the values to match your API key, content type, content ID and team or group ID:

{% connected_content
  https://connect.edume.com/braze/getContentLink?contentType={contentType}&contentId={contentId}&teamId={teamId}&braze.externalId={{${user_id}}}
  :headers {
       "X-Api-Key": "YOUR-EDUME-API-KEY"
  }
%}

1. Replace YOUR-EDUME-API-KEY with your eduMe API key found in the eduMe admin panel

   

2. Replace the contentType and contentId with the corresponding values for your content.
3. Replace teamId with the relevant eduMe team ID, or replace teamId with groupId and a relevant group ID. Users who arrive at eduMe through this link will be added to an eduMe team or group of your choosing.
4. Include an appropriate field to map the braze.externalId field to. The above example uses the user_id, which maps to Braze's "External ID", though this also supports custom attributes if your shared ID value is stored elsewhere in Braze. This ID will be available in eduMe reports, allowing you to correlate them with your systems.
5. Lastly, customise and test your message as needed. We recommend you send at least one test message, access the eduMe content, complete the lesson or course, and verify the eduMe analytics are being recorded.

Completion Events

If you would like to send completion events from eduMe to Braze, please follow the steps in this article to set this up.