Skip to main content

Overview

The Salesforce MIAW API allows you to sync conversations from Salesforce Messaging for In-App and Web (MIAW) into Open.cx. When a new message arrives in a MIAW conversation, Salesforce sends a webhook event to Open.cx, which triggers a conversation sync.

Authentication

All endpoints require an API key with the salesforce-miaw:write scope. Pass it as a Bearer token in the Authorization header:
curl -X POST https://api.open.cx/salesforce/miaw/webhook \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"event": "message:new", "session_id": "your-session-id"}'

Supported Events

EventDescription
message:newA new message was sent in a MIAW conversation