Sign in

v4

OpenAPI 3.1.02026-07-3163216290.7 KB
Events

Send an event

Send events to trigger workflows.

post/v1/events/send

Headers

Idempotency-Keystring

Include a unique ID for this request (maximum 100 characters) to avoid duplicate emails.

The value should be a string of up to 100 characters and should be unique for each request. We recommend using V4 UUIDs or some other method with enough guaranteed entropy to avoid collisions during a 24 hour window.

This endpoint will return a 409 Conflict response if the idempotency key has been used in the previous 24 hours.

Request body

OR

Example request

{
  "email": "alex@company.com",
  "userId": "usr_7f8e9d0c1b2a",
  "eventName": "signup",
  "eventProperties": {
    "planName": "Pro",
    "importDate": "2021-01-01"
  },
  "mailingLists": {
    "cm06f5v0e45nf0ml5754o9cix": true,
    "cm16k73gq014h0mmj5b6jdi9r": false
  }
}

Response

Successful send.

successboolean required

Example response

{
  "success": true
}