Events
Send event
Send events to trigger emails in Loops.
POST
/
api
/
v1
/
events
/
send
Request
Body
Provide either an
If both are provided, the system will look for a contact with either a matching
email
or userId
value or both to identify the contact.If both are provided, the system will look for a contact with either a matching
email
or userId
value. If a contact is found for one of the values (e.g. email
), the other value (e.g. userId
) will be updated. If a contact is not found, a new contact will be created using both email
and userId
values.email
string
The contact’s email address.
userId
string
The contact’s unique user ID. This must already have been added to your contact in Loops.
eventName
string
requiredThe name of the event.
eventProperties
object
An object containing event property data for the event. Values can be of type string
, number
, boolean
or date
. Read more about event properties
Contact properties
You can also include contact properties in your request body, which will update the contact in Loops. Properties can be of type string
, number
, boolean
or date
(see allowed date formats).
{
"email": "[email protected]",
"eventName": "signup",
"firstName": "Bob",
"plan": "pro",
}
To empty or reset the value of a property, send a null
value.
Response
success
boolean
requiredmessage
string
Was this page helpful?