OMomnisend
Events

Send Customer event

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

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

<br><a href="https://www.postman.com/omnisend-api/workspace/omnisend/overview" target="_blank">Open Postman collection</a>

post/events

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/events
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: events.write
    • or API key in header Authorization

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

eventIDstring

UUID of the event (v4, v5, v6, v7). Along with 'eventTime' used for historical event deduplication (not working on real-time events used for automations). If not provided, it will be generated automatically.

eventNamestring

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

eventTimestring

ISO 8601 timestamp. Accepts RFC 3339 (e.g. "2021-07-01T00:00:00Z") and the space-separated form "YYYY-MM-DD HH:MM:SS±HH:MM" (e.g. "2021-07-01 00:00:00+02:00"). Timestamps earlier than UTC midnight 10 years before the current date are rejected. Optional; defaults to current time.

eventVersionstring

Required ONLY for recommended events. Check event documentation to find what version you need to specify for each event. For custom events you should leave it empty.

originstring

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".

propertiesobject

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.

Example request

{
  "contact": {
    "address": "123 Main St.",
    "birthdate": "1990-01-01",
    "city": "New York",
    "country": "United States",
    "countryCode": "US",
    "email": "john.smoth@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+1234567890",
    "postalCode": "10001",
    "state": "NY",
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  "eventID": "9afca57b-d157-478b-adde-b9506322b16f",
  "eventName": "my custom event",
  "eventTime": "2021-07-01T00:00:00Z",
  "origin": "api"
}

Response

Accepted

Changes

No recorded changes to this operation across all 2 revisions of this API.