Hogsend
CLI Reference

hogsend events

Stream a user's event history, or send an event into the data plane to trigger journeys and buckets.

hogsend events has two modes. In read mode it streams the event history for a single user, newest first (wrapping GET /v1/admin/events?userId=<userId>). In send mode (hogsend events send <name>) it pushes a new event through the data-plane ingest pipeline.

hogsend events <userId> [options]      # read — stream a user's history
hogsend events send <name> [options]   # send — push an event into the data plane

Read mode

hogsend events <userId> streams the event history for a single user, newest first. It wraps GET /v1/admin/events?userId=<userId>.

hogsend events <userId> [options]

Arguments

ArgumentDescription
<userId>The user (distinct) id to fetch events for. Required.

Options

OptionDescription
--event <name>Filter to a single event name.
--from <iso>Only events at/after this ISO-8601 timestamp.
--to <iso>Only events at/before this ISO-8601 timestamp.
--limit <n>Max events to return (1–100, default 50).
--offset <n>Pagination offset (default 0).
--jsonEmit machine-readable JSON only.
-h, --helpShow this help.

The --url, --admin-key, and --json flags are the shared global flags handled by the router. See the CLI Reference for full connection details.

Examples

hogsend events user_123
hogsend events user_123 --event signup --limit 10
hogsend events user_123 --from 2026-01-01T00:00:00Z --json

Send mode

hogsend events send <name> pushes an event through the data-plane ingest pipeline (POST /v1/events) to trigger journeys and update contacts. The event name is a required positional, and you must pass at least one of --email or --user-id.

hogsend events send <name> [options]

Arguments

ArgumentDescription
<name>The event name to ingest (e.g. signup). Required.

Options

OptionDescription
--email <addr>Recipient/identity email. At least one of --email / --user-id is required.
--user-id <id>External (distinct) id. At least one of --email / --user-id is required.
--prop <key=value>Event property; repeatable. Value parsed as JSON, falling back to a string.
--props <json>Event properties as one JSON object.
--contact-prop <k=v>Contact property to merge onto the contact; repeatable.
--contact-props <json>Contact properties as one JSON object.
--list <id>Subscribe the contact to a list; repeatable.
--unlist <id>Unsubscribe the contact from a list; repeatable.
--idempotency-key <k>Dedup key (sent as the Idempotency-Key header).
--timestamp <iso>Override the event timestamp (ISO-8601).

eventProperties (--prop/--props) are stored on the event and feed trigger.where / exitOn evaluation; contactProperties (--contact-prop/--contact-props) merge onto the contact record. The two bags are never merged together.

Send mode writes to the data plane, so it uses the --data-key (ingest-scoped) bearer token rather than --admin-key. See the CLI Reference for full connection details.

Examples

hogsend events send signup --user-id user_123 --prop plan=pro
hogsend events send purchase --email a@b.com --props '{"amount":49}' --json

Next steps

On this page