Messages

Wait for the next message

Long-poll. timeout (1–60 s, default 30), since (ISO, default now), from, subject, direction (default inbound), channel, type, include_unscreened, include_held (true/false, see Screening). Returns { data: Message | null }: the oldest message after since, or null on timeout. When the workspace screens agent mail, inbound mail is returned once it is screened, never while it is held. include_unscreened + include_held together = everything.

Permission: messages:read.

get/v1/inboxes/{id}/messages/wait

Request

  • Base URL: https://api.agentboxd.com
  • URL: https://api.agentboxd.com/v1/inboxes/{id}/messages/wait
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

timeoutnumber
sincestring
fromstring
subjectstring
direction'inbound' | 'outbound'
channel'agent' | 'email' | 'mixed'
type'message' | 'task' | 'event'
include_unscreened'true' | 'false'
include_held'true' | 'false'

Response

OK

object required

Changes

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