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 Automations 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
Data may also be included in the Event call – this data gets passed as input data to the Action Script on any Automation triggered by the Event (see the section on Automation using Automations 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
Other API Help Pages
Introduction
IntroductionActions
Read a Record | Update a Record | Add a Record | List Records | Evaluate a Template | Execute an Action Script | Apply a Blueprint | Get a Blueprint | Add a File | Get a File | Get/Set a Persistent Setting Value | Get Category Values | Get Group Memberships of a User | Get Members of a Group | Load Data | Get Metadata for a Record Type | Get Metadata on Calculation Functions | Trigger an Event | Get Usage Statistics | Validate a Calculation | Validate a Filter ExpressionDiscussion Topics
Linking Records | Automation - Automations and EventsReturn to Developer Help