Contents x
      API Methods for Event-Based Automations
      • 1 Minute to read
      • Print
      • Dark
        Light
      Contents

      API Methods for Event-Based Automations

      • 1 Minute to read
      • Print
      • Dark
        Light
      Article summary

      Certain API methods can be used to trigger an event-based automation. In this case the API call is the event.

      For more information, see ​Event-Based Automation​.

      API 2.0 and Control XML Methods​

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

      Method

      Event

      Notes

      ​groupClone​

      ​Group Created (S)​


      All methods listed here plus ​userCreate​

      ​Logged on to System (S)​


      ​messageSendSingle​ or ​messageSendTransactional​

      ​Single Sendout Finished (C)​


      ​userUpdateProfile​, ​userReplaceProfile​, ​userReplaceProfile​, ​userReplaceProfileByEmail​

      ​Profile Data Changed (New) (C)​

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

      ​membershipCreate​

      ​Member Added to Group (C)​

      The following API methods 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.

      API 1.0 Methods (REST only)​

      The following automation can only be triggered with the following API 1.0 method.

      Method

      Event

      Notes

      ​UpdateRecipientNoMsg​ with the parameter ​Self=True​

      ​UpdateRecipientMsg​ with the parameter ​Self=True​

      ​Registered to System (REST) (C)​

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

      Was this article helpful?
      What's Next