Docs powered by Archbee

Model: BatchEvent

1 min

Model Parameters

BatchEvent
- typestring<helplineDisplay | helplineClick>required
  Example
  helplineDisplay
  Description
  The kind of event being recorded.
  Allowed
  helplineDisplayhelplineClick
- helplineIdstring
  Example
  crisis-text-line
  Description
  Id of the helpline. Required, except on a display event that records that no helpline was shown.
- sessionIdstringrequired
  Example
  3f0c8a2e-1d4b-4c9a-9e2f-7a1b2c3d4e5f
  Description
  Client-generated session identifier.
- timestampstring<date-time>required
  Example
  2026-07-05T12:34:56Z
  Description
  ISO 8601 timestamp of when the event occurred.
  Format
  date-time
- contactMethodstring<phone | sms | onlineChat | website | tty | whatsapp | reportingForm>
  Example
  phone
  Description
  How the user reached the helpline. Required for click events; not used for display events.
  Allowed
  phonesmsonlineChatwebsitettywhatsappreportingForm
- noDisplayboolean
  Description
  For display events only: record that the API was queried but no helpline was shown. Mutually exclusive with the helpline id.

Docs powered by Archbee