Online
Bento

Events

Events are the core signal system in Bento. They capture meaningful user actions with detailed context so you can understand behavior, build better segments, and trigger automations. Use events to power workflows and reporting with accurate, real-time data.

Available Endpoints


The Events Model

The events model requires you to pass an event type and email. User fields, details, and the date are optional fields for recording metadata about the event or the visitor.

Properties

  • Name
    typestring
    Description

    The name of the event

  • Name
    emailstring
    Description

    Email of the event user

  • Name
    fieldsobject
    Description

    An object of key/value pairs written to the subscriber's profile fields. Must not be nested.

  • Name
    detailsobject
    Description

    An object of key/value pairs stored as event metadata. Can be nested.

  • Name
    datedatetime
    Description

    Optional timestamp for when the event happened. Omit it to use the time Bento receives the request.


POST/v1/batch/events

Create Events

Sends events to your site. Events create new users if they do not already exist in your account.

Required Attributes

  • Name
    typestring
    Description

    The name of the event

  • Name
    emailstring
    Description

    Email of the event user

Optional Attributes

  • Name
    fieldsobject
    Description

    An object of key/value pairs written to the subscriber's profile fields. Must not be nested.

  • Name
    detailsobject
    Description

    An object of key/value pairs stored as event metadata. Can be nested.

  • Name
    datedatetime
    Description

    Optional timestamp for when the event happened. Use an ISO 8601 value.



Response

Returns the count of events recorded.

  • Name
    resultsinteger
    Description

    Number of events accepted and queued for processing.

  • Name
    failedinteger
    Description

    Number of events Bento rejected from the request.