Configuring transactional messaging

To send a transactional message with Adobe Campaign, your first need to describe the structure of the event data.

Event configuration must be performed by an administrator following the steps below.

NOTE

The configuration can vary depending on the type of transactional message you want to send. For more on this, refer to Transactional event specific configurations.

Once the event is published:

Creating an event

To get started, create the event corresponding to your needs.

IMPORTANT

Only users holding the Administration role and being part of the All organizational unit have the appropriate rights to create an event configuration.

  1. Click the Adobe Campaign logo, in the top left corner, then select Marketing plans > Transactional messages > Event configuration.

  2. Click the Create button.

  3. Give a Label and an ID to the event. The ID field is mandatory and should begin with the prefix “EVT”. If you do not use this prefix, it is automatically added once you click Create.

    IMPORTANT

    The ID must not exceed 64 characters, including the EVT prefix.

  4. Select the channel that will be used to send your transactional messages Email, Mobile (SMS) or Mobile application (push notification).

    NOTE

    Only one channel can be used for each event configuration. Once the event is created, you cannot change the channel.

  5. Select the targeting dimension corresponding to the desired event configuration and click Create.

    Event-based transactional messages target data contained in the event itself, whereas profile-based transactional messages target data contained in the Adobe Campaign database. For more on this, refer to Transactional event specific configurations.

NOTE

The number of created real-time events can have an impact on your platform. To ensure optimal performance, make sure you delete real-time events that you do not need anymore. See Deleting an event.

Defining the event attributes

In the Fields section, define the attributes that will be integrated into the event content and will then be able to be used to personalize the transactional message.

The steps for adding and modifying fields are the same as for custom resources.

NOTE

If you want to create a multilingual transactional message, define an additional event attribute with the AC_language ID. This only applies to event transactional messages. After the event is published, the steps for editing the content of a multilingual transactional message are the same as for a multilingual standard email. See Creating a multilingual email.

Defining data collections

You can add to the event content a collection of elements, each element itself including several attributes.

This collection can be used in a transactional email to add product listings to the content of the message, for example a list of products - with the price, reference number, quantity, etc. for each product of the list.

  1. In the Collections section, click the Create element button.

  2. Add a label and an ID for your collection.

  3. Add all the fields you want to display in the transactional message for each product of the list.

    In this example, we added the following fields:

  4. The Enrichment tab allows you to enrich each item of the collection. This will enable you to personalize the elements of the corresponding product listing with information from the Adobe Campaign database or from other resources that you created.

NOTE

The steps for enriching the elements of a collection are the same as described in the Enriching the event section. Note that enriching the event will not allow you to enrich a collection: you need to add an enrichment to the collection itself in the Collections section.

Once the event and the message are published, you will be able to use this collection in your transactional message.

Here is the API preview for this example:

Related topics:

Enriching the event

You can enrich the transactional message content with information from the Adobe Campaign database in order to personalize your messages. From the last name or CRM ID of each of your recipients, for example, you can recover data such as their address or date of birth or any other custom field added in the Profile table, in order to personalize the information that is sent to them.

It is possible to enrich the transactional message content with information from extended Profile and services Ext API. For more information, refer to Extending the API: Publishing the extension

This information can also be stored in new resources. In that case, the resource must be linked to the Profile or Service resources either directly, or via another table. For example, in the configuration below, it is possible to enrich the transactional message content with information from the Product resource like the product category or ID, if the Product resource is linked to the Profile resource.

For more on resource creation and publishing, refer to this page.

  1. In the Enrichment section, click the Create element button.

  2. Select the resource with which you want to link your message. In this case, choose the Profile resource.

  3. Use the Create element button to link a field from the selected resource to one of the fields you previously added to the event (see Defining the event attributes).

  4. In this example, we reconcile the Last name and the First name fields with the corresponding fields in the Profile resource.

    You can also enrich the transactional message content using the Service resource. For more on services, see this section.

  5. If you are creating or editing a profile-based event, in the Targeting enrichment section, select the enrichment that will be used as the message target during the delivery execution.

    NOTE

    Selecting a targeting enrichment based on the Profile resource is mandatory for profile-based events.

Once the event and the message are published, this link will allow you to enrich the content of the transactional message.

Related topics:

Previewing and publishing the event

Before being able to use the event, you must preview and publish it.

  1. Click the API preview button to see a simulation of the REST API that will be used by your website developer before it is published. Once the event is published, this button also allows you to see a preview of the API in production. See Integrating the triggering of the event in a website.

    NOTE

    The REST API varies according to the selected channel and the selected targeting dimension. For more details on the various configurations, refer to Transactional event specific configurations.

  2. Click Publish to start publication.

    The API that will be used by your website developer is deployed and the transactional events can now be sent.

  3. You can view the publication logs in the corresponding tab.

    IMPORTANT

    Each time you modify the event, you must click Publish again to generate the updated REST API that will be used by your website developer.

    Once the event has been published, a transactional message linked to the new event is automatically created.

  4. You can directly access this transactional message through the link located in the left-hand side area.

In order for the event to trigger sending a transactional message, you must modify and publish the message that was just created. See Event transactional messages.

You also have to integrate this trigger event into your website. See Integrating the triggering of the event in a website.

Once Adobe Campaign starts receiving events related to this event configuration, the Latest transactional events link under the History section enables you to access the latest events sent by your third-party service and processed by Adobe Campaign.

The events (in JSON format) are listed from the most recent to the oldest. This list allows you to check data such as the content or the status of an event, for control and debugging purpose.

Unpublishing an event

The Unpublish button lets you cancel the publication of the event, which deletes from the REST API the resource corresponding to the event that you previously created. Now, even if the event is triggered through your website, the corresponding messages are not sent anymore and they are not stored in the database.

NOTE

If you have already published the corresponding transactional message, the transactional message publication is also canceled. See Unpublishing a transactional message.

Click the Publish button to generate a new REST API.

Transactional messaging publication process

The chart below illustrates the transactional messaging publication process.

For more on publishing, pausing and unpublishing a transactional message, see this section.

Deleting an event

Once an event has been unpublished, or if an event has not been published yet, you can delete it from the event configuration list. To do this:

  1. Click the Adobe Campaign logo, in the top left corner, then select Marketing plans > Transactional messages > Event configuration.

  2. Hover the mouse over the event configuration of your choice and select the Delete element button.

    NOTE

    Make sure the event configuration has the Draft status, otherwise you will not be able to delete it. The Draft status applies to an event that has not been published yet or that has been unpublished.

  3. Click the Confirm button.

IMPORTANT

Deleting an event configuration that has been published and already used will also delete the corresponding transactional message(s) and its sending and tracking logs.

Searching transactional events

To access and search the transactional events already created, follow the steps below.

  1. Click the Adobe Campaign logo, in the top left corner, then select Marketing plans > Transactional messages > Event configuration.

  2. Click the Show search button.

  3. You can filter on the Publication status. This allows you to display only the published events for example.

  4. You can also filter the events using the Last event received. For example, if you enter 10, only the event configurations with the last event received 10 days ago or more will be displayed. This enables you to display which events have been inactive for a given period.

    NOTE

    The default value is 0. All events are then displayed.

Integrating the triggering of the event in a website

Once you have created an event, you will have to integrate the triggering of this event into your website.

In the example described in the Transactional messaging operating principle section, you want a “Cart abandonment” event to be triggered whenever one of your clients leaves your website before purchasing the products in their cart. To do this, your website web developer must use the Adobe Campaign Standard REST API.

See the REST API Documentation.

Transactional event specific configurations

Transactional event configuration may vary depending on the type of transactional message you want to send (event or profile), and the channel that will be used.

The following sections detail what specific configuration should be set according to the desired transactional message. For more on the general steps to configure an event, refer to Creating an event.

Event-based transactional messages

To send an event-based transactional message, you first need to create and configure an event targeting the data contained in the event itself.
For more information, see Engaging with transactional messaging.

  1. When creating the event configuration, select the Real-time event targeting dimension (see Creating an event).

  2. Add fields to the event, in order to be able to personalize the transactional message (see Defining the event attributes).

  3. Enrich the transactional message content if you want to use additional information from the Adobe Campaign database (see Enriching the transactional message content).

    NOTE

    Event-based transactional messaging is supposed to use only the data that are in the sent event to define the recipient and the message content personalization. However, you can enrich the content of your transactional message using information from the Adobe Campaign database.

  4. Preview and publish the event (see Previewing and publishing the event).

    When previewing the event, the REST API contains an attribute specifying the email address or mobile phone according to the selected channel.

    Once the event has been published, a transactional message linked to the new event is automatically created. In order for the event to trigger sending a transactional message, you must modify and publish the message that was just created, see Event transactional messages.

  5. Integrate the event into your website (see Integrating the triggering of the event in a website).

Profile-based transactional messages

To send a profile-based transactional message, you first need to create and configure an event targeting data contained in the Adobe Campaign database.

  1. When creating the event configuration, select the Profile event targeting dimension (see Creating an event).

  2. Add fields to the event, in order to be able to personalize the transactional message (see Defining the event attributes). You must add at least one field to create an enrichment. You do not need to create other fields such as First name and Last name as you will be able to use personalization fields from the Adobe Campaign database.

  3. Create an enrichment in order to link the event to the Profile resource (see Enriching the transactional message content). Creating an enrichment is mandatory when using a Profile targeting dimension.

  4. Preview and publish the event (see Previewing and publishing the event).

    When previewing the event, the REST API does not contain an attribute specifying the email address or the mobile phone as it will be retrieved from the Profile resource.

    Once the event has been published, a transactional message linked to the new event is automatically created. In order for the event to trigger sending a transactional message, you must modify and publish the message that was just created, see Sending a profile transactional message.

  5. Integrate the event into your website (see Integrating the triggering of the event in a website).

Event-based transactional push notifications

To be able to send transactional push notifications, you need to configure Adobe Campaign accordingly. See Push configuration.

To send an anonymous transactional push notification to all users who have opted in to receive notifications from your mobile application, you first need to create and configure an event targeting the data contained in the event itself. The corresponding steps are presented below.

The event must contain the three following elements:

  • A registration token, which is the user ID for one mobile application and one device. It may not correspond to any profile from the Adobe Campaign database.
  • A mobile application name (one for all devices - Android and iOS). This is the ID of the mobile application configured in Adobe Campaign that will be used to receive push notifications on the users’ devices. For more on this, refer to this page
  • A push platform (“gcm” for Android or “apns” for iOS).
  1. When creating the event configuration, select the Mobile application channel and the Real-time event targeting dimension (see Creating an event).

  2. Add fields to the event, in order to be able to personalize the transactional message (see Defining the event attributes).

  3. Enrich the transactional message content if you want to use additional information from Adobe Campaign database (see Enriching the transactional message content).

    NOTE

    Event-based transactional messaging is supposed to use only the data that are in the sent event to define the recipient and the message content personalization. However, you can enrich the content of your transactional message using information from the Adobe Campaign database.

  4. Preview and publish the event (see Previewing and publishing the event).

    When previewing the event, the REST API contains the “registrationToken”, “application” and “pushPlatform” attributes that will be used to target the delivery.

    Once the event has been published, a transactional push notification linked to the new event is automatically created. To modify and publish the message that was just created, see Sending a transactional push notification targeting an event.

  5. Integrate the event into your website (see Integrating the triggering of the event in a website).

Profile-based transactional push notifications

To send a transactional push notification to the Adobe Campaign profiles who have subscribed to your mobile application, you first need to create and configure an event targeting the Adobe Campaign database.

  1. When creating the event configuration, select the Mobile application channel and the Profile targeting dimension (see Creating an event).

    By default, the transactional push notification will be sent to all mobile applications to which the recipients subscribed. To send the push notification to a specific mobile application, select it in the list. The other mobile applications will be targeted by the message but will be excluded from the sending.

  2. Add fields to the event, if you want to personalize the transactional message (see Defining the event attributes).

    NOTE

    You must add at least one field to create an enrichment. You do not need to create other fields such as First name and Last name as you will be able to use personalization fields from the Adobe Campaign database.

  3. Create an enrichment in order to link the event to the Profile resource (see Enriching the transactional message content). Creating an enrichment is mandatory when using a Profile targeting dimension.

  4. Preview and publish the event (see Previewing and publishing the event).

    When previewing the event, the REST API does not contain an attribute specifying the registration token, the application name and the push platform as they will be retrieved from the Profile resource.

    Once the event has been published, a transactional push notification linked to the new event is automatically created. To modify and publish the message that was just created, see Sending a transactional push notification targeting a profile.

  5. Integrate the event into your website (see Integrating the triggering of the event in a website).

Configuring an event to send a follow-up message

A follow-up message is a predefined marketing delivery template that can be used in a workflow to send messages to the recipients of a specific transactional message. For more on this, see Follow-up messages.

  1. Use the same event configuration that you created to send an event transactional message. See Event-based transactional messages.

  2. When configuring your event, check the Create follow-up delivery template for this event box before publishing the event.

  3. Preview and publish the event (see Previewing and publishing the event).

    Once the event has been published, a transactional message and a follow-up delivery template linked to the new event are automatically created. For more on using follow-up messages, see Sending a follow-up message.

Use case: configuring an event to send a transactional message

In this example, we want to configure an event in order to send confirmation messages after each purchase on our website with the following prerequisites:

As we want to identify our client via his CRM ID, first make sure that the Profile resource has been extended with this new field.

In the same way, a custom resource corresponding to purchases must have been created and published, and must be linked to the Profile resource. This way, you will be able to retrieve information from this resource to enrich the message content.

For more on resource creation and publishing, refer to this page.

  1. Create a new event using the Email channel and the Profile targeting dimension (see Creating an event).

  2. Define the attributes that will be available to personalize the transactional message. In our case, add the “CRM ID” and the “Product identifier” fields (see Defining the event attributes).

  3. To enrich the message content with information regarding the client’s previous purchases, create an enrichment targeting the Purchase resource (see Enriching the transactional message content).

  4. Create a join condition between the “Product identifier” field that was previously added to the message, and the corresponding field from the Purchase resource.

  5. Preview and publish the event (see Previewing and publishing the event).

  6. Integrate the event in your website (see Integrating the triggering of the event in a website).

On this page