Documentation Campaign Campaign Standard Documentation

Configuring a transactional event

Last update: February 20, 2024

Topics:
Transactional Messaging

CREATED FOR:

Intermediate
User

To send a transactional message with Adobe Campaign, you first need to describe the structure of the event data by creating and configuring an event.

IMPORTANT

Only Functional administrators have the appropriate rights to create and edit event configurations.

The configuration varies depending on the type of transactional message you want to send, and on the channel that will be used. For more on this, see Specific configurations.

Once configuration is done, the event must be published. See Publishing a transactional event.

Creating an event

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

Click the Adobe logo, in the top-left corner, then select Marketing plans > Transactional messages > Event configuration.
Click the Create button.
Enter a Label and an ID for 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.
Select the channel that will be used to send your transactional messages Email, Mobile (SMS) or Push notification. Only one channel can be used for each event and it cannot be changed afterwards.
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 Specific configurations.

NOTE

The number of transactional events can have an impact on your platform. To ensure optimal performance, make sure you delete unused events. 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.

In the Collections section, click the Create element button.
Add a label and an ID for your collection.
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:
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, see 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 creating and publishing resources, see this section.

In the Enrichment section, click the Create element button.
Select the resource with which you want to link your message. In this case, choose the Profile resource.
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).

NOTE
If you define a condition that could enable to select several recipients (such as a field that can have the same value for several profiles), no more than one profile will be targeted.
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.
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
Creating a enrichment and selecting a targeting enrichment based on the Profile resource are 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:

Searching transactional events

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

Click the Adobe logo, in the top-left corner, then select Marketing plans > Transactional messages > Event configuration.
Click the Show search button.
You can filter on the Publication status. This allows you to display only the published events for example.
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.

Specific configurations

Transactional event configuration may vary depending on the type of transactional message you want to send (event or profile), and on 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

You can send event transactional messages targeting an event. This type of transactional messages does not contain profile information: the delivery target is defined by the data contained in the event itself.

To send an event-based transactional message, you first need to create and configure an event targeting the data contained in the event itself.

When creating the event configuration, select the Real-time event targeting dimension (see Creating an event).
Add fields to the event, in order to be able to personalize the transactional message (see Defining the event attributes).
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, if you want to use additional information from the Adobe Campaign database, you can enrich the transactional message content (see Enriching the transactional message content).
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, mobile phone, or push notification specific attributes, 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.
Integrate the event into your website (see Integrate the event triggering).

Profile-based transactional messages

You can send transactional messages based on customer profiles, which allows you to apply marketing typology rules, include the unsubscribe link, add the message to the global delivery reporting and leverage it in the customer journey.

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

When creating the event configuration, select the Profile event targeting dimension (see Creating an event).
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.
Create an enrichment in order to link the event to the Profile resource (see Enriching the event) and select this enrichment as the Targeting enrichment.

IMPORTANT
This step is mandatory for profile-based events.
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, mobile phone, or push notification specific attributes, 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…
Integrate the event into your website (see Integrate the event triggering).

Transactional push notifications

You can send two types of transactional push notifications:

An anonymous transactional push notification to all users who have opted in to receive notifications from your mobile application. See Configuring event-based transactional push notifications.
A transactional push notification to the Adobe Campaign profiles who have subscribed to your mobile application. See Configuring profile-based transactional push notifications.

IMPORTANT

To be able to send transactional push notifications, you need to configure Adobe Campaign accordingly. See Configuring a mobile application.

Follow-up messages

You can send a follow-up message to the customers who received a specific transactional message.

The steps to configure an event allowing to send a follow-up message are detailed in this section.

recommendation-more-help