Browse the docs

Events (journeys)

Tell the panel something happened in your system — a booking, a cancellation. Every journey switched on for that event sends its utility templates at the set times. Journeys that are off send nothing, now or later.

Base address: https://app.ezreach.in/api/v1

POST/api/v1/events

Report an event

Permission:events:writeIdempotency-Key

Starts the journeys listening for this event name, for one person (to + key) or up to 500 (people[]).

Body

  • eventrequired

    string

    The event name a journey listens for, e.g. rsvp.confirmed.

  • keyrequired

    string

    Your id for this booking. The same key again is the same booking (nothing is sent twice).

  • torequired

    string

    The person's WhatsApp number (E.164).

  • group

    string

    Your id for the thing booked, to cancel or move everybody at once.

  • at

    ISO date

    When it starts. Required when a journey has steps before it starts or after it ends.

  • endsAt

    ISO date

    When it ends (else 3 hours after it starts).

  • data

    Record<string, string>

    Values for the templates' blanks, e.g. event_name, when, where (≤ 30 keys).

  • people

    { to, key, contact?, data?, optInEvidence? }[]

    Instead of to + key: up to 500 people at once.

  • optInEvidence

    string

    Only for a person the panel does not know yet: how they agreed to offers (≤ 200 characters). They then start Subscribed. Without it a new person starts on “No offers”: updates about their booking only.

  • accountId

    string

    The WhatsApp number to send from, when the journey is set to all numbers (else the default number). A journey set to one number always uses it.

Request

curl -X POST "https://app.ezreach.in/api/v1/events" \
  -H "Authorization: Bearer $EZREACH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "event": "rsvp.confirmed",
  "key": "rsvp_8812",
  "group": "event_7e3c",
  "to": "+919876543210",
  "contact": {
    "name": "Rohan"
  },
  "at": "2026-09-27T17:00:00+05:30",
  "endsAt": "2026-09-27T20:00:00+05:30",
  "data": {
    "event_name": "Traitors - Trust no one",
    "when": "Sat, 27 Sep at 5:00 PM",
    "where": "DLF Phase 1, Gurugram"
  }
}'

Response

202 Accepted
{
  "data": {
    "accepted": true,
    "journeys": [
      {
        "automationId": "cm4j0urn3y0001",
        "name": "Event booking journey",
        "people": 1,
        "steps": [
          {
            "index": 0,
            "label": "Right away",
            "dueAt": "2026-09-25T10:00:00.000Z",
            "status": "PENDING"
          },
          {
            "index": 1,
            "label": "24 hours before it starts",
            "dueAt": "2026-09-26T11:30:00.000Z",
            "status": "PENDING"
          }
        ]
      }
    ],
    "ignored": [],
    "duplicates": 0,
    "invalid": []
  }
}

Errors

  • 422EVENT_TIME_REQUIRED

    A journey has timed steps and no at was sent.

  • 422ACCOUNT_MISMATCH

    accountId names another number than the one the journey sends from. Nothing is stored.

  • 503RESTART_NEEDED

    The panel must be restarted after its last update before journeys work.

  • A reminder is never sent late: a step whose time has passed (booked too late, or the panel was offline) is skipped with its reason.
  • Timed steps are kept out of 10 pm to 8 am (workspace time) unless the journey step says otherwise: a reminder moves to 9 pm the evening before (or 8 am when that has passed and is still before the start); a feedback message waits for 8 am.
  • A person the panel does not know yet is added on “No offers” (updates about their booking, never campaigns), unless you send optInEvidence. An existing contact's choice is never changed by a booking.
  • With no journey switched on for the event, the answer is 200 with journeys: [] and a note. Nothing is sent.
POST/api/v1/events/cancel

Cancel a booking or an event

Permission:events:write

Steps not sent yet become cancelled. Send exactly one of key or group.

Body

  • key

    string

    One booking.

  • group

    string

    Everybody booked for one event.

  • reason

    string

    Shown on the journey's bookings.

Request

curl -X POST "https://app.ezreach.in/api/v1/events/cancel" \
  -H "Authorization: Bearer $EZREACH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "group": "event_7e3c",
  "reason": "Event cancelled by the host"
}'

Response

200 OK
{
  "data": {
    "cancelled": 12
  }
}
POST/api/v1/events/reschedule

Move a booking or an event

Permission:events:write

Steps not sent yet get new times; a step whose new time has already passed is skipped ("rescheduled into the past").

Body

  • key

    string

    One booking.

  • group

    string

    Everybody booked for one event.

  • atrequired

    ISO date

    The new start.

  • endsAt

    ISO date

    The new end.

  • data

    Record<string, string>

    Merged into the booking's values (e.g. a new "when").

Request

curl -X POST "https://app.ezreach.in/api/v1/events/reschedule" \
  -H "Authorization: Bearer $EZREACH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "group": "event_7e3c",
  "at": "2026-09-28T17:00:00+05:30",
  "data": {
    "when": "Sun, 28 Sep at 5:00 PM"
  }
}'

Response

200 OK
{
  "data": {
    "moved": 11,
    "skipped": 1
  }
}
GET/api/v1/events/{key}

Look up a booking

Permission:events:read

Every journey step of one booking and what happened to it (reached, read, failed, awaiting confirmation).

Path parameters

  • keyrequired

    string

    Your booking key.

Request

curl "https://app.ezreach.in/api/v1/events/rsvp_8812" \
  -H "Authorization: Bearer $EZREACH_API_KEY"

Response

200 OK
{
  "data": {
    "key": "rsvp_8812",
    "group": "event_7e3c",
    "contact": {
      "phone": "+919876543210",
      "name": "Rohan"
    },
    "journeys": [
      {
        "name": "Event booking journey",
        "steps": [
          {
            "index": 0,
            "label": "Right away",
            "status": "SENT",
            "delivery": "read"
          }
        ]
      }
    ]
  }
}