mailkit.journeys.trigger

The mailkit.journeys.trigger function inserts a recipient into a scenario.

The recipient can be inserted into an ON EVENT node or a WAIT node, where this API call can shorten the recipient's wait and the recipient will leave the node immediately upon a successful API call.

API call example:

JSON 

{
   "function": "mailkit.journeys.trigger",
   "id": 12345678,
   "md5": "abc123def456abc123def456abc12345",
   "parameters": {
       "email": "example@example.com",
       "event_tag": "my_event",
       "event_data": {
            "name" : "content1",
            "other_name" : "content2"
        } 
    }
}

XML 

<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
  <methodName>mailkit.journeys.trigger</methodName>
  <params>
    <param>
      <value><int>123456789</int></value>
    </param>
    <param>
      <value><string>abc123def456abc123def456abc12345</string></value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>email</name>
            <value><string>example@example.com</string></value>
          </member>
          <member>
            <name>event_tag</name>
            <value><string>my_event</string></value>
          </member>
          <member>
            <name>event_data</name>
            <value>
              <struct>
                <member>
                  <name>name</name>
                  <value><string>content1</string></value>
                </member>
                <member>
                  <name>other_name</name>
                  <value><string>content2</string></value>
                </member>
              </struct>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodCall>

Values

client_id* = client ID can be found in your Mailkit account's menu Profile/Integration.
client_md5* = MD5 code can be found in your Mailkit account's menu​​​​​​​ Profile/Integration.
email* = the email address of the recipient who:

  • should be inserted into the scenario (using the ON EVENT node)
  • should immediately leave the WAIT node

event_tag* = the event name, which is then defined on the ON EVENT or WAIT node settings​​​​​​​
event_data = data that can be further processed within the event in the scenario​​​​​​​

* required value

Successful call response:

JSON 

{
   "message": "Added into scenario",
   "error_status": 0,
   "status": "OK"
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>message</name>
                        <value>
                            <string>Added into scenario events queue</string>
                        </value>
                    </member>
                    <member>
                        <name>status</name>
                        <value>
                            <string>OK</string>
                        </value>
                    </member>
                    <member>
                        <name>error_status</name>
                        <value>
                            <i4>0</i4>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>

Unsuccesfull call response:

JSON 

{
    "error": "Missing event_tag",
    "error_status": 1
}

XML 

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Missing event_tag</string>
            </value>
        </param>
    </params>
</methodResponse>

Values

Missing event_tag = missing event tag
Missing email = missing email