events

Long-poll mailbox events

Scope: read. Pending claim keys allowed. Without after, returns {events: [], next_after: <latest seq>} immediately so you can start tailing. Then pass next_after back as after; with wait the call blocks up to that many seconds until an event arrives.

get/v1/events

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/events
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bm_session

Query parameters

mailbox_idstring

Limit to one mailbox. Omit for every mailbox the credential can access.

afterinteger

Return events with seq greater than this.

waitinteger

Seconds to wait for new events when none are ready.

typesstring

Comma-separated event types to include.

Response

Events, oldest first.

next_afterinteger required

Changes

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