Events

Ingest a custom event for automations

Starts a run on every active automation whose trigger matches the event name, resumes runs waiting for this event, and cancels runs for the same person whose automation lists it in trigger.cancel_on_events. An automation that matches but declines to enroll the same person again (trigger.once_per_contact or trigger.cooldown_days) is counted in skipped_enrollments and explained in enrollment_skips.

post/events

Request

  • Base URL: https://api.supersendtx.com
  • URL: https://api.supersendtx.com/events
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional idempotency key for replay-safe retries. Keys are kept for 24 hours; after that the same key is accepted as a new event. Use it to collapse retries, not to make an event fire once per person.

Request body

OR

Response

Event accepted for automation processing, with counts of runs started, resumed, cancelled, and skipped

matched_automationsinteger required

Active automations whose trigger matched and that started a run for this event. Automations that matched but declined to enroll this person again are counted in skipped_enrollments instead.

resumed_runsinteger required

Waiting runs resumed by this event (wait_for_event steps)

cancelled_runsinteger required

Active runs cancelled because this event matched trigger.cancel_on_events

skipped_enrollmentsinteger required

Automations whose trigger matched but that did not enroll this person again because of trigger.once_per_contact or trigger.cooldown_days. 0 when none were skipped.

Changes

No recorded changes to this operation across all 1 revision of this API.