Creating an API channel inbox
Creating an API channel inboxThe API channel is Konversio's generic integration layer. If you have a source of customer messages that doesn't fit email, WhatsApp, or another built-in channel — a mobile app, a custom web form, an internal tool, a voice transcription pipeline — the API channel is how you connect it.What the API channel is forThe API channel decouples Konversio from specific platforms. You push messages in via HTTP, and Konversio handles the conversation routing, agent assignment, and response flow. Your system receives agent replies via webhook.Typical use cases:Mobile app in-app chat (iOS/Android)Custom web chat built with your own UI instead of the embeddable widgetKiosk or point-of-sale support interfaceAggregating messages from a platform Konversio doesn't natively supportInternal helpdesk where the "user" is another system rather than a humanCreate an API channel inboxGo to Settings → Inboxes → Add InboxSelect API as the channel typeGive the inbox a name and click Create InboxAssign agents as usualAfter creation, the inbox settings page shows:Your Inbox Identifier (a token used to scope API calls to this inbox)Pushing messages inTo create a conversation and send a message into the inbox, use the Konversio public API. You will need:Your Konversio instance URLThe Inbox Identifier from the inbox settingsA contact identifier (you create or look up contacts via the API as well)A minimal flow:Create or find a contact — POST /api/v1/profile or POST /api/v1/accounts/{account_id}/contactsCreate a conversation — POST /api/v1/accounts/{account_id}/conversations with the inbox ID and contact IDCreate a message in that conversation — POST /api/v1/accounts/{account_id}/conversations/{id}/messagesThe full API reference is available at https://your-konversio-instance.com/swagger or in the Konversio developer documentation.All API calls require an agent authentication token (api_access_token), passed as a header or query parameter.Receiving agent replies via webhookWhen an agent replies to a conversation that came in through an API channel inbox, Konversio fires a webhook. Set up a webhook endpoint under Settings → Integrations → Webhooks and subscribe to the message_created event.Your endpoint will receive a POST with the message payload, including the conversation ID, the message content, and metadata. Your application can then deliver the reply to the end user through whatever channel your app uses.Identifying users across sessionsFor conversations to be continuable (returning user picks up where they left off), pass a consistent identifier for each contact when creating or looking up contacts. This is typically a user ID from your own system. Without a stable identifier, each API call creates a new anonymous contact and a new conversation.Example: mobile app support chatA typical mobile app integration:User taps "Contact support" in the appApp backend calls Konversio to create or retrieve a contact using the user's account ID as the identifierApp creates a conversation in the API channel inbox and posts the user's first messageKonversio routes the conversation to an available agentAgent replies in KonversioWebhook fires to your backend, which pushes the reply to the mobile app via push notification or WebSocketUser sees the reply inside the appThe API channel gives you full control over the user-facing UI while Konversio handles the agent-side tooling.