Send an event

post

https://api.ycloud.com/v2/event/events

Sends an occurrence of a previously defined custom event. For contact events, identify the contact using one of a contact ID, phone number, or Meta username.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

eventName

string

required

Name of the event.
One of the custom event names you previously defined.

occurTime

date-time

The time at which the event occurred, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z,
if not provided, the current time will be used.

objectId

string

required

ID of the object that the event is associated with.
For events defined with objectType as CONTACT, provide the numeric ID of an existing contact in your account.
A numeric objectId takes precedence over contactPhoneNumber and contactUsername. If that contact is not found, the request fails without trying another identifier.

contactPhoneNumber

string

The contact's phone number in E.164 format for events defined with objectType as CONTACT.
Used when no numeric objectId is provided. Looks up a contact in your account by phone number and creates one if no match exists.
Takes precedence over contactUsername.

contactUsername

string

The Meta username of an existing contact in your account for events defined with objectType as CONTACT. Provide the username saved on the contact, without the leading @.
Used when neither a numeric objectId nor a non-blank contactPhoneNumber is provided.
If no matching contact exists, the request fails. A username does not automatically create a contact.

properties

object

The properties of the custom event.

Response

200

Successfully accepted the event. Returns an empty JSON object.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here!