Add External API Engagement

This page explains how to create an engagement with External API.

Create an Engagement for External API

Create an Engagement from Segments

To create an engagement from segments, follows the steps below:

  • Navigate to Campaigns > Segments.
  • Select the Segment Name, and on the left panel, click External API.
  • Click +Add Engagement.

Create an Engagement from Channels

To create an engagement from channels, follows the steps below:

  • Navigate to Campaigns > Channels.
  • On the left panel, click External API, and click Add Engagement.
  • Select Segment Name from the list.
  • Click Confirm And Proceed To the Next Step.

Configure Engagement Details

To configure the engagement details, follow the steps below:

Add General details

  • Engagement Name (mandatory): Enter a name for the Engagement. It should range between 6-25 characters.
  • API(mandatory): Choose your API.
  • Label (mandatory): Choose a product label from the list. For more information about product labels, refer here.

Add a Goal

Goal Type: Select a goal type from the drop-down list. Set it to none if the goal is not decided yet. For more information about Goals, refer Campaign Channels.

Configure Parameters

URL path parameters: This will be updated automatically based on the URL you configured while adding the external API.

Payload: Paste the payload in the code editor provided. The payload you enter here must be in JSON file format which will be displayed in the following tree view. You can edit the payload and add values by assigning variables using the tree view or the payload editor.

Also, you can map the payload value using the macro from the field given below.

Note: To get the payload value as raw email data, enter @EMAIL@ in the input. To get the payload value as raw mobile data, enter @MOBILE@ in the input. You can set the payload value as a variable by declaring value between {{ value }}

Schedule Settings

Schedule an engagement to send at a later time or trigger it immediately once the engagement goal is achieved. For more information about Engagement Scheduling, refer Campaign Channels

Save

Click Save to save the Engagement.

Note: After you have created an Engagement, you can neither change the name of the engagement nor change the schedule settings.