ApivomApivom
Get Demo

Salesforce Messaging for In-App and Web (MIAW) API

Salesforce Messaging for In-App and Web (MIAW) — the Service Cloud API behind custom chat clients: unauthenticated, authenticated and continuation access tokens, conversation create/list/close, message and entry posting, transcript download, acknowledgements and the server-sent-events stream — registered in Apivom Atlas as 14 routes on your salesforce-scrt.com endpoint.

What you can do

  • Authorisation: unauthenticated and authenticated access tokens, continuation tokens for long sessions, token revocation (4 routes)
  • Conversations: create, read, list and close a conversation; post messages and typing/read entries; acknowledge entries (8 routes)
  • Transcript: download the full conversation transcript once the session ends
  • Real time: eventrouter server-sent events stream for agent replies, routing and status changes
  • 14 routes (6 read-only) on the per-org salesforce-scrt.com host, documented in the AI integration guide (llms.txt)

Use cases

  • Custom web or in-app chat client — Issue tokens, open conversations and stream agent replies into your own UI instead of the standard Salesforce embedded component.
  • Conversation transcripts in your data platform — Download transcripts when conversations close and store them alongside the customer record for quality review and analytics.
  • Authenticated messaging for logged-in customers — Exchange your identity provider's assertion for an authenticated MIAW token so agents see the verified customer from the first message.

Messaging for In-App and Web is how Service Cloud exposes its Enhanced Messaging channel to a custom client: your website or mobile app requests an access token for a messaging deployment, opens a conversation, posts end-user messages and listens on a server-sent-events stream for agent or bot replies, then pulls the transcript when the conversation closes. Apivom Atlas registers the 14 public routes of the v2 API — token issuance for anonymous and verified users, continuation tokens, conversation lifecycle, entries and acknowledgements, transcript, and the event stream — on the org-specific salesforce-scrt.com host set per request. The deployment's Connected App and developer name are the credential contract. No Apivom product uses MIAW today: Apivom's conversational channels are WhatsApp and the browser, not a Salesforce messaging deployment, and no Apivom workflow reads or writes Service Cloud conversations. The connector is catalogued for customers who already run Enhanced Messaging and want an Apivom-built client or a conversation export wired to it, scoped per customer.

Authentication

A Connected App on your Salesforce org (consumer key + secret) and your My Domain instance URL. The caller runs the OAuth 2.0 flow and sends the access token as Bearer; the instance URL becomes the per-request base URL. Apivom Atlas forwards, logs and stores nothing.

Frequently asked questions

Can I switch this connector on today?

The connector is registered in Apivom Atlas — every route is catalogued, the credential contract is published and the AI integration guide (llms.txt) is live — and your credential can be stored in Apivom Iris. Wiring it into a product workflow (sync, automation, notifications) is done per customer: tell us the use case and we scope it with you.

Does any Apivom product connect to Salesforce Messaging?

Not today. Apivom's conversational products run on WhatsApp and the browser; none has a Service Cloud messaging channel. This connector is registered so a customer-specific bridge could be scoped, but none exists yet.

What do I need on the Salesforce side?

A Service Cloud org with Enhanced Messaging, a Messaging for In-App and Web deployment (its developer name and salesforce-scrt.com endpoint) and, for verified users, the Connected App and identity provider configured for authenticated messaging.

Does Apivom charge per API call for this connector?

No. Connectors are part of your Apivom tenant and are not metered in the Atlas portal. The vendor's own pricing, quotas and rate limits still apply to the account you connect — Apivom paces its calls to stay inside them and shows every call in your tenant's integration log.

Where are my credentials stored and who can see the traffic?

Apivom Atlas is a stateless gateway: it never stores vendor credentials or tokens. The Apivom product that connects keeps the credential encrypted in your tenant database, and every request and response is logged in your tenant only — your data is never shared across tenants.

More Atlas integrations

AI integration guide (llms.txt)

Machine-readable markdown — feed it to your AI assistant as integration instructions.