Zaptickdocs
Resource

Inbox

Human-in-the-loop inbox — list conversations, reply, assign, and resolve.

#About

The inbox is the programmable agent workspace. Use these endpoints to sync conversations into your own support tool or build custom workflows on top of the agent event stream.

#Endpoints

  • GET/conversationsList conversations — filter by status, assignee, label.
  • GET/conversations/:idFetch a single conversation with the last N messages.
  • GET/conversations/:id/messagesPaginate through a conversation's message history.
  • POST/conversations/:id/replySend a reply as the assigned agent (or as bot).
  • PATCH/conversations/:idChange status / assignee / labels.
GET/conversations

List conversations — filter by status, assignee, label.

SDK
TypeScript
const { conversations } = await zaptick.inbox.list({
  status: 'open',
  assigneeId: 'usr_01J3...',
  limit: 20,
});
GET/conversations/:id

Fetch a single conversation with the last N messages.

SDK
TypeScript
const { conversation } = await zaptick.inbox.get('conv_01J3...');
GET/conversations/:id/messages

Paginate through a conversation's message history.

SDK
TypeScript
const { messages, nextCursor } = await zaptick.inbox.listMessages(
  'conv_01J3...',
  { limit: 50 }
);
POST/conversations/:id/reply

Send a reply as the assigned agent (or as bot).

SDK
TypeScript
await zaptick.inbox.reply('conv_01J3...', {
  message: 'Got it — I\'ll check and get back to you in 5.',
});
Request body
JSON
{
  "message": "Got it — I'll check and get back to you in 5.",
  "attachments": []
}
PATCH/conversations/:id

Change status / assignee / labels.

SDK
TypeScript
await zaptick.inbox.update('conv_01J3...', {
  status: 'resolved',
  assigneeId: 'usr_01J3...',
  labels: ['shipping-issue'],
});