Send Customer event

post https://api.omnisend.com/v5/events

With this endpoint you can send customer events to Omnisend. Customer events are used to track customer behavior and trigger automations based on that behavior.
You can either format and send custom customer events or use predefined events.

Scopes:
events.write

Open Postman collection

Body Params

event information

contact

object

Contact information, contact will be created or updated based on the data provided here

eventID

string

UUID(v4) of the event. Used for event deduplication. If not provided, it will be generated automatically

eventName

string

Check event documentation to find what event names you need to specify for each event

eventTime

string

RFC3339 format if not provided, current time will be used

eventVersion

string

Check event documentation to find what version you need to specify for each event. For custom events you can leave it empty

origin

string

It should be based on the source of event API. If you are building platform or app integration it should have dedicated origin. Otherwise it should be "api".

properties

object

Event properties, you can check events guides section to see what recommended properties you should provide for each event. Not providing recommending properties can result some of the features not working properly.

Response

202

Accepted

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.omnisend.com/v5/events \
3
     --header 'content-type: application/json'

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