Sign in
Subscribers

Trigger event for subscriber

Triggers an event for a subscriber. Creates the subscriber if they don't exist. Creates the event definition if it doesn't exist.

post/subscribers/events

Request body

emailstring email

Required when creating a new subscriber. Optional when externalId identifies an existing subscriber.

externalIdstring

Customer-owned app/customer/user ID

eventstring required
propertiesobject

Event properties/metadata

customAttributesobject

Optional attributes to set on the subscriber if created

Example request

{
  "email": "user@example.com",
  "externalId": "user_123",
  "event": "purchase.completed",
  "properties": {
    "amount": 9900,
    "currency": "USD",
    "productId": "prod_123"
  }
}

Response

Event triggered successfully

successboolean

Example response

{
  "success": true
}

Changes