Skip to content

Inbox

Receive Webhook Short

Create a work chat via public webhook inbox (simplified URL without org slug).

Parameters

NameInTypeRequiredDescription
agent_slugpathstringyes
codepathstringyes

Responses

StatusDescriptionBody
201Successful ResponseInboxResponse
422Validation ErrorHTTPValidationError

POST /api/inbox/{org_slug}/{agent_slug}/{code}

Section titled “POST /api/inbox/{org_slug}/{agent_slug}/{code}”

Receive Webhook

Create a work chat via public webhook inbox. No authentication required.

Accepts two content types:

  • application/json: JSON body with title, description, links, file_urls
  • multipart/form-data: form field metadata (JSON string) + file parts

Parameters

NameInTypeRequiredDescription
agent_slugpathstringyes
codepathstringyes
org_slugpathstringyes

Responses

StatusDescriptionBody
201Successful ResponseInboxResponse
422Validation ErrorHTTPValidationError

Receive Hitl Reply

Ingest a human’s email reply to a HITL request (no auth — token + secret).

Resolves the signed reply-address token back to the originating request. If it is still pending, the reply becomes the HITL response and the chat resumes; if it was already answered, the reply continues the conversation as a new message.

Parameters

NameInTypeRequiredDescription
tokenpathstringyes

Responses

StatusDescriptionBody
200Successful ResponseInboxResponse
422Validation ErrorHTTPValidationError