How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Crisp Realtime (Webhooks + RTM) v1

Crisp realtime surface combining HTTP Web Hooks (signed plugin hooks and unsigned website hooks) and the Socket.IO RTM API. Both deliver the same conversational, people, campaign, browsing, call, identity, status, website, bucket, email, plugin and plan event taxonomy; RTM additionally exposes spam, people-import progress, widget action, and media-listing events.

Crisp Realtime (Webhooks + RTM) v1 is one of 3 APIs that Crisp publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhook, Real-Time, Socket.IO, AsyncAPI, and Messaging. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 85 operations across 84 channels, and defines 23 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through 2 servers: rtm.crisp.chat (wss), {subscriberHost} (https).

85 operations 84 channels 23 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
https://api.crisp.chat/v1/plugin/connect/endpoints
Resource Areas
1

Channels & Operations 85

Across 84 channels, the API surfaces 85 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 85
SUB
/webhook
Receive a Crisp Web Hook callback
receiveCrispWebhook body
SUB
rtm/authentication
Socket.IO event the client emits within ~10s of connecting to authenticate. Server replies with authenticated on success or unauthorized on failure.
onAuthenticationResult body
PUB
rtm/authentication
Socket.IO event the client emits within ~10s of connecting to authenticate. Server replies with authenticated on success or unauthorized on failure.
sendAuthentication body
SUB
rtm/session:update_availability
body
SUB
rtm/session:update_verify
body
SUB
rtm/session:request:initiated
body
SUB
rtm/session:set_email
body
SUB
rtm/session:set_phone
body
SUB
rtm/session:set_address
body
SUB
rtm/session:set_subject
body
SUB
rtm/session:set_avatar
body
SUB
rtm/session:set_nickname
body
SUB
rtm/session:set_origin
body
SUB
rtm/session:set_data
body
SUB
rtm/session:set_segments
body
SUB
rtm/session:set_block
body
SUB
rtm/session:set_opened
body
SUB
rtm/session:set_closed
body
SUB
rtm/session:set_participants
body
SUB
rtm/session:set_mentions
body
SUB
rtm/session:set_routing
body
SUB
rtm/session:set_inbox
body
SUB
rtm/session:set_state
body
SUB
rtm/session:sync:capabilities
body
SUB
rtm/session:sync:geolocation
body
SUB
rtm/session:sync:system
body
SUB
rtm/session:sync:network
body
SUB
rtm/session:sync:timezone
body
SUB
rtm/session:sync:locales
body
SUB
rtm/session:sync:pages
body
SUB
rtm/session:sync:events
body
SUB
rtm/session:sync:rating
body
SUB
rtm/session:sync:topic
body
SUB
rtm/session:removed
body
SUB
rtm/session:error
body
SUB
rtm/message:updated
body
SUB
rtm/message:send
body
SUB
rtm/message:received
body
SUB
rtm/message:removed
body
SUB
rtm/message:compose:send
body
SUB
rtm/message:compose:receive
body
SUB
rtm/message:acknowledge:read:send
body
SUB
rtm/message:acknowledge:read:received
body
SUB
rtm/message:acknowledge:unread:send
body
SUB
rtm/message:acknowledge:delivered
body
SUB
rtm/message:acknowledge:ignored
body
SUB
rtm/message:notify:unread:send
body
SUB
rtm/message:notify:unread:received
body
SUB
rtm/spam:message
RTM-only. Not delivered via Web Hooks.
body
SUB
rtm/spam:decision
RTM-only. Not delivered via Web Hooks.
body
SUB
rtm/people:profile:created
body
SUB
rtm/people:profile:updated
body
SUB
rtm/people:profile:removed
body
SUB
rtm/people:bind:session
body
SUB
rtm/people:sync:profile
body
SUB
rtm/people:import:progress
RTM-only. Not delivered via Web Hooks.
body
SUB
rtm/people:import:done
RTM-only. Not delivered via Web Hooks.
body
SUB
rtm/campaign:progress
body
SUB
rtm/campaign:dispatched
body
SUB
rtm/campaign:running
body
SUB
rtm/browsing:request:initiated
body
SUB
rtm/browsing:request:rejected
body
SUB
rtm/call:request:initiated
body
SUB
rtm/call:request:rejected
body
SUB
rtm/identity:verify:request
body
SUB
rtm/widget:action:processed
RTM-only. Not delivered via Web Hooks.
body
SUB
rtm/status:health:changed
body
SUB
rtm/website:update_visitors_count
body
SUB
rtm/website:update_operators_availability
body
SUB
rtm/website:users:available
body
SUB
rtm/bucket:url:upload:generated
body
SUB
rtm/bucket:url:avatar:generated
body
SUB
rtm/bucket:url:website:generated
body
SUB
rtm/bucket:url:campaign:generated
body
SUB
rtm/bucket:url:helpdesk:generated
body
SUB
rtm/bucket:url:status:generated
body
SUB
rtm/bucket:url:processing:generated
body
SUB
rtm/media:animation:listed
RTM-only. Not delivered via Web Hooks.
body
SUB
rtm/email:subscribe
body
SUB
rtm/email:track:view
body
SUB
rtm/plugin:channel
body
SUB
rtm/plugin:event
body
SUB
rtm/plugin:subscription:updated
body
SUB
rtm/plugin:settings:saved
body
SUB
rtm/plan:subscription:updated
body

Messages & Schemas 23

The contract defines 23 schemas that model the data carried by its messages. The most detailed are AuthenticationPayload (4 properties), WebhookEnvelope (4 properties), RtmEnvelope (3 properties). Each schema is shown below with its type and property counts.

WebhookEnvelope
message
HTTP POST body sent to the subscriber's URL.
AuthenticationRequest
message
Authenticated
message
Unauthorized
message
SessionEvent
message
MessageEvent
message
SpamEvent
message
PeopleEvent
message
CampaignEvent
message
BrowsingEvent
message
CallEvent
message
IdentityEvent
message
WidgetEvent
message
StatusEvent
message
WebsiteEvent
message
BucketEvent
message
MediaEvent
message
EmailEvent
message
PluginEvent
message
PlanEvent
message
WebhookEnvelope
object
4 properties 4 required
RtmEnvelope
object
Generic envelope used by every RTM event. Mirrors the Web Hooks body but is emitted over Socket.IO. Per-event data shapes are documented at https://docs.crisp.…
3 properties 2 required
AuthenticationPayload
object
4 properties 3 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

crisp-asyncapi.yml Raw ↑

Other APIs Crisp publishes across the network.

Crisp Conversations API
Crisp Website API
Where this information came from

This is an independent, third-party profile of Crisp Realtime (Webhooks + RTM) v1, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.