Triggering Event-Based Automations via API

  • 1 minute(s) read
Prev Next

Certain API calls in Mapp Engage can trigger event-based automations. In these cases, the API call itself acts as the triggering event.

For a full list of supported calls and technical details, see the Engage API Documentation.

API 2.0 and Control XML Methods​

The following table lists the API 2.0 and Control XML methods that trigger an automation event.

API Calls

Event

Notes

​groupClone​

​Group Created (S)​


All methods listed here plus ​userCreate​

​Logged on to System (S)​


​messageSendSingle​ 
messageSendTransactional​

​Single Sendout Finished (C)​


​userUpdateProfile​
​userReplaceProfile​
userReplaceProfile​
userReplaceProfileByEmail​

​Profile Data Changed (New) (C)​

The following API calls do not fire this automation: ​membershipUpdateAttributes​

​membershipCreate​

​Member Added to Group (C)​

The following API calls do not fire this automation: ​messageSendSingle​ or ​messageSendTransactional​

​membershipSubscribe
membershipSubscribeByEmail​

​Subscribed to Group (C)​

Note that the automation does not fire if the contact is already a member of the group. This is true for all subscription modes.

With the subscription mode DOUBLE_OPT_IN, the event executes with the API call, but Engage doesn't fire the actual job until the subscription is confirmed.

The following API methods do not fire this automation: ​messageSendSingle​ or ​messageSendTransactional​.

​membershipUnsubscribe​, ​membershipUnsubscribeByEmail​

​Unsubscribed From Group (C)​

The following API methods do not fire this automation: ​membershipDelete​

​relatedDataDeleteRecord​

Related Data: Record Deleted (S)​


​relatedDataCreateRecord​

Related Data: Record Added (S)​

The automation will not fire if the dataset is linked to the user profile via email / mobile / fax.

​relatedDataCreateRecord​

​Related Data: User-Specific Record Added (C)​

The automation will only fire if the dataset is linked to user profile via email / mobile / fax.

The automation will not fire if the dataset is linked with anything other than the email / mobile / fax.

All of the methods listed above can be used as the "login" event.

​Logged on to System (S)​

When defining the event, the field ​User​ should be the designated API user. Otherwise the event will fire on every user login in the user interface.