---
title: "Triggering Event-Based Automations via API"
slug: "api-methods-for-event-based-automations"
updated: 2025-07-29T08:06:22Z
published: 2025-07-29T08:06:22Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Triggering Event-Based Automations via API

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](https://docs.mapp.com/apidocs/introduction-1).

## 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)​](/v1/docs/group-created-s) |  |
| All methods listed here plus ​`userCreate`​ | [​Logged on to System (S)​](/v1/docs/logged-on-to-system-s) |  |
| ​`messageSendSingle`​ `messageSendTransactional`​ | [​Single Sendout Finished (C)​](/v1/docs/single-sendout-finished-c) |  |
| ​`userUpdateProfile`​ ​`userReplaceProfile`​ `userReplaceProfile`​ `userReplaceProfileByEmail`​ | [​Profile Data Changed (New) (C)​](/v1/docs/profile-data-changed-new-c) | The following API calls do not fire this automation: ​`membershipUpdateAttributes`​ |
| ​`membershipCreate`​ | [​Member Added to Group (C)​](/v1/docs/member-added-to-group-c) | The following API calls do not fire this automation: ​`messageSendSingle`​ or ​`messageSendTransactional`​ |
| ​`membershipSubscribe` `membershipSubscribeByEmail`​ | [​Subscribed to Group (C)​](/v1/docs/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)​](/v1/docs/unsubscribed-from-group-c) | The following API methods do not fire this automation: ​`membershipDelete`​ |
| ​`relatedDataDeleteRecord`​ | [Related Data: Record Deleted (S)​](/v1/docs/related-data-record-deleted-s) |  |
| ​`relatedDataCreateRecord`​ | [Related Data: Record Added (S)​](/v1/docs/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)​](/v1/docs/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)​](/v1/docs/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. |