Stream one inbox's events
BillionSend extension: the event stream of one inbox, as GET /inboxes/events, ending when the inbox is deleted or expires; it carries inbox.deleted and inbox.expired whatever types names. An inbox-scoped key may stream its own inbox, without the events about held mail.
/inboxes/{inbox_id}/eventsAuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
inbox_idstringrequisThe inbox ID or its email address, such as support@example.com
typesstringComma-separated event names to receive (inbox.email.received, email.received, and the other inbox.* webhook events); every inbox event when omitted
last_event_idstringThe id of the last event the client saw, for clients that cannot set the Last-Event-ID header; the header wins when both are sent
An event stream that stays open. A client that reconnects with Last-Event-ID gets the events it missed (up to 24 hours back, then a stream.gap event) before the live ones
stringMissing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequisAn agent naming an event about held mail
statusCodenumberrequisnamestringrequismessagestringrequisNot found
statusCodenumberrequisnamestringrequismessagestringrequisValidation error
statusCodenumberrequisnamestringrequismessagestringrequisToo many streams open, or the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis