How to use the RTM API

This article explains when to use the Crisp RTM API for real-time integration events.

The RTM API runs over WebSocket and lets integrations receive asynchronous events from Crisp. It is often used together with the REST API: REST performs actions, while RTM receives real-time events and acknowledgements.

When to use the RTM API

Use the RTM API when your integration needs a live event stream, such as receiving new messages, tracking asynchronous confirmations, or reacting immediately to conversation changes.

A common architecture is:

REST API → sends requests and changes Crisp data
RTM API → receives real-time events and acknowledgements
Web Hooks → provide a simpler HTTP alternative for many event-driven workflows

For most simple automations, Web Hooks are easier to operate. Use RTM when you specifically need a persistent real-time connection.

Developer documentation

Use these Developer Hub resources:

RTM API quickstart → setup and authentication
RTM API reference → endpoints, namespaces, scopes, and event details
Web Hooks quickstart → compare with HTTP-based event delivery

Updated on: 03/05/2026

Was this article helpful?

Thank you!