Skip to main content
POST
Trigger Account Event

Trigger Account Event

Records the event on the account timeline and delivers it to the chosen recipients as a normal contact event, so sync rules, sequence triggers and matching-field enrollment run per person. Each delivery carries event.account.externalId, event.account.name, event.account.role and the account attributes.

Request

string
required
Your organization ID.
string
required
Event name, for example trial_ending, plan_changed, seat_limit_reached.
object
Event properties, available as event.<name> in sequences.
string
default:"owners"
owners (falls back to admins when the account has no owner), admins (owners and admins), all (every member) or none (timeline only).
string
Idempotency key scoped to this account. Accounts can reuse an ID even when they share members. Retries reuse the original recipients, properties and event time, even if account membership changes. Completed deliveries are skipped; failed deliveries resume without duplicating contact events or sequence enrollments. Recipients deleted since the event was recorded are reported with skipped: "contact_deleted" and are not retried. The response carries duplicate: true.
string
ISO 8601 timestamp of when the event happened. Defaults to now.

Responses