SEsequenzy
Accounts

Trigger account event

Changed on

Records an event on the account timeline and delivers it as a contact event to the chosen recipients (owners by default, falling back to admins when there is no owner; admins includes owners; all every member; none records only). Each delivery runs the normal event pipeline with event.account.* properties. Pass eventId to make retries idempotent. Retries reuse the original recipients and event data, skip completed deliveries, and resume failed work without duplicating events or sequence enrollments.

post/accounts/{externalId}/events

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/accounts/{externalId}/events
  • Auth
    HTTP bearer

Request body

eventstring required
propertiesobject
recipients'owners' | 'admins' | 'all' | 'none'
eventIdstring

Idempotency key scoped to this account, including when accounts share members. Retries keep the original recipients, properties and event time and resume incomplete deliveries.

occurredAtstring date-time

Example request

{
  "event": "trial_ending"
}

Response

Event recorded and delivered

successboolean
recipients'owners' | 'admins' | 'all' | 'none'
recipientCountinteger
truncatedboolean

True when the account has more matching members than the 5,000 fan-out cap.

duplicateboolean

True when a caller-supplied eventId had already been recorded; nothing new was written.

Example response

{
  "account": {
    "id": "acc_abc123",
    "externalId": "org_123",
    "name": "Acme",
    "domain": "acme.com",
    "attributes": {
      "plan": "pro",
      "seats": 5
    }
  }
}

Changes