API – Trigger an Event

action – event

This call is used to trigger a custom event against a specific record. See the section on Automation using Rules and Events for further discussion on the use of this mechanism.

Sample Request

{ "account": *** your account id ***, "apikey": "*** your api key ***", "action": "event", "recordurl": "person/12345", "event": "mycustomevent" }

Sample Response

{ "success": true }

Data may also be included in the Event call – this data gets passed as input data to the Action Script on any Rule triggered by the Event (see the section on Automation using Rules and Events for a discussion of this as a worked example).

Sample Request

{ "account": *** your account id ***, "apikey": "*** your api key ***", "action": "event", "recordurl": "person/12345", "event": "mycustomevent", "data": { "vOldDomain": "defunct.com", "vNewDomain": "newdom.com" } }

Sample Response

{ "success": true }