RTM API Reference (V1)

Updated on October 22, 2023

Events are sent on the RTM Events API WebSocket channel that you can open alongside your REST API channel, which allows you to receive asynchronous replies and events for some of your actions via the REST API.

Endpoint

You may subscribe to events by opening a Socket.IO connection to the WebSocket endpoint.

The RTM API endpoint URL must be acquired from the REST API before connecting via Get Connect Endpoints. As it is dynamic, make sure to fetch it everytime before you connect.

We strongly recommend using our official NodeJS Library or Golang Library to listen to RTM events.

There is a limit on the maximum number of connections that can be simultaneously open with the RTM API (per-token, per-website and per-IP). This limit is quite high and can be revised at any time. Please make sure to teardown any unused connection before opening a new one. Most use cases require a single RTM API connection.

Namespaces

Available RTM event namespaces are listed in the Events section below. Make sure to subscribe to the ones you need to receive in the RTM authentication request, otherwise you won't receive them. Read our guides on how to do that.

Note that if your API token is a plugin tier token, then you will only have access to the RTM events that your token scopes allow, based on the API routes that you have access to. Required scopes and tiers are listed for each event below.

Events

Session Events

Session Update Availability

Event: session:update_availability
Description: session availability changed (eg. online to offline)
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "availability": "online"
}

Session Update Verify

Event: session:update_verify
Description: session verification status changed
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "is_verified": true
}

Session Request Initiated

Event: session:request:initiated
Description: session has been initiated (conversation started)
Tiers: user plugin
Scopes: website:conversation:initiate + write

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f"
}

Session Set Email

Event: session:set_email
Description: an email has been set for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "email": "crisp@crisp.chat"
}

Session Set Phone

Event: session:set_phone
Description: a phone number has been set for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "phone": "+330987654321"
}

Session Set Address

Event: session:set_address
Description: an address has been set for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "address": "Whip-Ma-Whop-Ma-Gate, York"
}

Session Set Subject

Event: session:set_subject
Description: a subject has been set for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "subject": "[IMPORTANT] World Domination Master Plan"
}

Session Set Avatar

Event: session:set_avatar
Description: an avatar has been set for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "avatar": "https://upload.wikimedia.org/wikipedia/commons/5/5a/John_Doe%2C_born_John_Nommensen_Duchac.jpg"
}

Session Set Nickname

Event: session:set_nickname
Description: a nickname has been set for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "nickname": "John Doe"
}

Session Set Data

Event: session:set_data
Description: user custom data has been set for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "data": {
    "key_3": "value_3"
  }
}

Session Set Segments

Event: session:set_segments
Description: user segments have been added to session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "segments": [
    "segment1"
  ]
}

Session Set Block

Event: session:set_block
Description: session was just blocked or unblocked
Tiers: user plugin
Scopes: website:conversation:actions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "is_blocked": true
}

Session Set Opened

Event: session:set_opened
Description: conversation has been opened by an operator (viewed by)
Tiers: user plugin
Scopes: website:conversation:actions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "operator": {
    "user_id": "d790bfc4-d818-4bcf-8bc4-fb826df3ee46",
    "avatar": "https://upload.wikimedia.org/wikipedia/commons/5/5a/John_Doe%2C_born_John_Nommensen_Duchac.jpg",
    "nickname": "Baptiste Jamin"
  }
}

Session Set Closed

Event: session:set_closed
Description: conversation has been closed by a viewing operator
Tiers: user plugin
Scopes: website:conversation:actions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "operator": {
    "user_id": "d790bfc4-d818-4bcf-8bc4-fb826df3ee46",
    "avatar": "https://upload.wikimedia.org/wikipedia/commons/5/5a/John_Doe%2C_born_John_Nommensen_Duchac.jpg",
    "nickname": "Baptiste Jamin"
  }
}

Session Set Participants

Event: session:set_participants
Description: the list of conversation participants has been updated
Tiers: user plugin
Scopes: website:conversation:participants + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "participants": [
    {
      "target": "john.doe@gmail.com",
      "type": "email"
    }
  ]
}

Session Set Mentions

Event: session:set_mentions
Description: an operator mentioned another operator
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "mentions": [
    "9ce29796-7b1a-47f9-8d73-c41a357325ff"
  ]
}

Session Set Routing

Event: session:set_routing
Description: a routing identifier was set on conversation
Tiers: user plugin
Scopes: website:conversation:routing + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "routing_id": "9ce29796-7b1a-47f9-8d73-c41a357325ff"
}

Session Set State

Event: session:set_state
Description: session state changed (eg. to resolved)
Tiers: user plugin
Scopes: website:conversation:states + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "state": "unresolved"
}

Session Sync Capabilities

Event: session:sync:capabilities
Description: user device just advertised its capabilities on session (eg. browser support for calls)
Tiers: user plugin
Scopes: website:conversation:sessions

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "capabilities": [
    "browsing",
    "call"
  ]
}

Session Sync Geolocation

Event: session:sync:geolocation
Description: current geolocation was just pushed for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "geolocation": {
    "country": "GB",
    "region": "ENG",
    "city": "London",

    "coordinates": {
      "latitude": 51.5074,
      "longitude": -0.1196
    }
  }
}

Session Sync System

Event: session:sync:system
Description: current device system was just pushed for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "system": {
    "os": {
      "name": "macOS",
      "version": "10.15.7"
    },

    "engine": {
      "name": "Blink",
      "version": "93.0.4577.63"
    },

    "browser": {
      "name": "Chrome",
      "version": "93.0.4577.63",
      "major": "93"
    },

    "useragent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/93.0.4577.63 Safari/537.36"
  }
}

Session Sync Network

Event: session:sync:network
Description: current device network was just pushed for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "network": {
    "ip": "23.106.56.52"
  }
}

Session Sync Timezone

Event: session:sync:timezone
Description: current device timezone was just pushed for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "timezone": {
    "offset": 300
  }
}

Session Sync Locales

Event: session:sync:locales
Description: current device locales was just pushed for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "locales": {
    "locales": [
      "en",
      "en-GB"
    ]
  }
}

Session Sync Pages

Event: session:sync:pages
Description: a page was just browsed by user on session
Tiers: user plugin
Scopes: website:conversation:pages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "pages": [
    {
      "page_url": "https://nike.com/",
      "page_title": "Homepage",
      "timestamp: 1640800162400"
    }
  ]
}

Session Sync Events

Event: session:sync:events
Description: events were just pushed from user on session
Tiers: user plugin
Scopes: website:conversation:events + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "events": [
    {
      "text": "product_bought",

      "data": {
        "price": "$200",
        "name": "iPhone 6S"
      },

      "color": "red",
      "timestamp": 1632409219371
    }
  ]
}

Session Sync Rating

Event: session:sync:rating
Description: a user rating was just submitted for session
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",

  "rating": {
    "stars": 5,
    "comment": "The support was super quick and very helpful! Thanks!"
  }
}

Session Sync Topic

Event: session:sync:topic
Description: a topic was just detected from the session messages
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "topic": "Refund Requests"
}

Session Removed

Event: session:removed
Description: session has been removed (ie. conversation was deleted)
Tiers: user plugin
Scopes: website:conversation:sessions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f"
}

Message Events

Message Updated

Event: message:updated
Description: a message has been updated
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "fingerprint": 163240180126629,
  "content": "This is an edited message!"
}

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "fingerprint": 163413612446728,

  "content": {
    "id": "call-date",
    "text": "Pick your date!",

    "choices": [
      {
        "value": "1",
        "icon": "🌸",
        "label": "Today, 1:00PM.",
        "selected": false
      },

      {
        "value": "2",
        "icon": "🌼",
        "label": "Tomorrow, 3:45PM.",
        "selected": true
      }
    ]
  }
}

Message Send

Event: message:send
Description: a message has been sent from a visitor (received by operators)
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "type": "text",
  "origin": "chat",
  "content": "Hello Crisp, this is a message from a visitor!",
  "timestamp": 1632396148646,
  "fingerprint": 163239614854320,
  "from": "user",

  "user": {
    "nickname": "visitor607",
    "user_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f"
  },

  "stamped": true
}

Message Received

Event: message:received
Description: a message has been sent from an operator (received by a visitor)
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "type": "text",
  "from": "operator",
  "origin": "chat",
  "content": "Hello! This is a message from an operator!",
  "fingerprint": 163239623329114,

  "user": {
    "nickname": "John Doe",
    "user_id": "012d1926-8753-4af6-9957-4853bb6fa294"
  },

  "mentions": [],
  "timestamp": 1632396233539,
  "stamped": true
}

Message Removed

Event: message:removed
Description: a message has been removed
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "fingerprint": 163240180126629
}

Message Compose Send

Event: message:compose:send
Description: a message is being composed (MagicType from visitor)
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "excerpt": "I am typing someth",
  "timestamp": 1640852923184,
  "type": "start"
}

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "timestamp": 1640852923184,
  "type": "stop"
}

Message Compose Receive

Event: message:compose:receive
Description: a message is being composed (MagicType from operator)
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "excerpt": "I am typing someth",
  "timestamp": 1640852923184,
  "type": "start",

  "user" : {
    "nickname": "Baptiste Jamin",
    "user_id": "012d1926-8753-4af6-9957-4853bb6fa29"
  }
}

Message Acknowledge Read Send

Event: message:acknowledge:read:send
Description: messages sent by visitor were read by an operator
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "origin": "chat",

  "fingerprints": [
    163239614854320
  ]
}

Message Acknowledge Read Received

Event: message:acknowledge:read:received
Description: messages sent by operators were read by visitor
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "origin": "chat",

  "fingerprints": [
    163239623329114
  ]
}

Message Acknowledge Delivered

Event: message:acknowledge:delivered
Description: visitor client acknowledged delivery of an operator message
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "origin": "chat",

  "fingerprints": [
    163239614854320
  ]
}

Message Notify Unread Send

Event: message:notify:unread:send
Description: messages sent by visitor were not read in due time by an operator
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f"
}

Message Notify Unread Received

Event: message:notify:unread:received
Description: messages sent by operators were not read in due time by visitor
Tiers: user plugin
Scopes: website:conversation:messages + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f"
}

People Events

People Profile Created

Event: people:profile:created
Description: a people profile was created
Tiers: user plugin
Scopes: website:people:profiles + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "people_id": "46dae0e8-02c6-41f0-98ae-590b6272d99a",
  "email": "jane@crisp.chat"
}

People Profile Updated

Event: people:profile:updated
Description: a people profile was updated
Tiers: user plugin
Scopes: website:people:profiles + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "people_id": "46dae0e8-02c6-41f0-98ae-590b6272d99a",
  "email": "john@crisp.chat",

  "update": {
    "updated_at": 1632410257914,

    "person": {
      "geolocation": {
        "country": "GB",
        "region": "ENG",
        "city": "London",

        "coordinates": {
          "latitude": 51.5074,
          "longitude": -0.1196
        }
      },

      "locales": [
        "en",
        "en-GB"
      ],

      "nickname": "Crisp",
      "timezone": -60,
      "phone": "330987654321",
      "avatar": "https://upload.wikimedia.org/wikipedia/commons/5/5a/John_Doe%2C_born_John_Nommensen_Duchac.jpg",

      "employment": {
        "domain": "crisp.chat",
        "name": "Crisp",
        "role": "Software Engineer",
        "title": "CTO"
      },

      "address": "Whip-Ma-Whop-Ma-Gate, York",
      "website": "crisp.chat",
      "gender": "male"
    }
  }
}

People Profile Removed

Event: people:profile:removed
Description: a people profile was removed
Tiers: user plugin
Scopes: website:people:profiles + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "people_id": "46dae0e8-02c6-41f0-98ae-590b6272d99a"
}

People Bind Session

Event: people:bind:session
Description: a people profile was bound to session
Tiers: user plugin
Scopes: website:people:profiles + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "people_id": "46dae0e8-02c6-41f0-98ae-590b6272d99a"
}

People Sync Profile

Event: people:sync:profile
Description: people profile was synchronized for session (ie. full data synchronization)
Tiers: user plugin
Scopes: website:people:profiles + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f",
  "people_id": "46dae0e8-02c6-41f0-98ae-590b6272d99a",

  "identity": {
    "person": {
      "geolocation": {
        "country": "GB",
        "region": "ENG",
        "city": "London",

        "coordinates": {
          "latitude": 51.5074,
          "longitude": -0.1196
        }
      },

      "locales": [
        "en",
        "en-GB"
      ],

      "nickname": "Crisp",
      "timezone": -60,
      "phone": "330987654321",
      "avatar": "https://upload.wikimedia.org/wikipedia/commons/5/5a/John_Doe%2C_born_John_Nommensen_Duchac.jpg",

      "employment": {
        "domain": "crisp.chat",
        "name": "Crisp",
        "role": "Software Engineer",
        "title": "CTO"
      }
    },

    "company": {
      "description": "Give your customer experience a human touch.",
      "domain": "crisp.chat",

      "geolocation": {
        "country": "FR",
        "city": "Nantes"
      },

      "legal_name": "Crisp",
      "name": "Crisp",
      "url": "https://crisp.chat/"
    }
  }
}

People Import Progress

Event: people:import:progress
Description: people batch import is progressing
Tiers: user

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "people_id": "46dae0e8-02c6-41f0-98ae-590b6272d99a",
  "progress": 4,

  "count": {
    "skipped": 1,
    "remaining": 10200
  },

  "items": {
    "skipped": [
      {
        "identifier": null,
        "reason": "empty_profile"
      }
    ]
  }
}

People Import Done

Event: people:import:done
Description: people batch import is done
Tiers: user

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "people_id": "46dae0e8-02c6-41f0-98ae-590b6272d99a",
  "error": false
}

Campaign Events

Campaign Progress

Event: campaign:progress
Description: the campaign delivery is progressing (eg. campaign is 10% sent)
Tiers: user

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "campaign_id": "d6e9d2ca-8ee0-4b43-bbce-88fe8a0e73ce",
  "progress": 100
}

Campaign Dispatched

Event: campaign:dispatched
Description: the campaign was dispatched
Tiers: user

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "campaign_id": "d6e9d2ca-8ee0-4b43-bbce-88fe8a0e73ce"
}

Campaign Running

Event: campaign:running
Description: the campaign running state has changed (either false or true)
Tiers: user

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "campaign_id": "d6e9d2ca-8ee0-4b43-bbce-88fe8a0e73ce",
  "running": false
}

Browsing Events

Browsing Request Initiated

Event: browsing:request:initiated
Description: MagicBrowse request initiated by visitor browser
Tiers: user plugin
Scopes: website:conversation:browsing + write

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "browsing_id": "browsing_85424ecf-f59c-4ada-910f-90f86f18b4c2",
  "browsing_token": "1231ddad3frcf7c77",
  "session_id": "e56e3f73-5f34-4329-a5f7-75aa289d0272"
}

Browsing Request Rejected

Event: browsing:request:rejected
Description: MagicBrowse request rejected by visitor browser (eg. browser has privacy settings)
Tiers: user plugin
Scopes: website:conversation:browsing + write

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "e56e3f73-5f34-4329-a5f7-75aa289d0272"
}

Call Events

Call Request Initiated

Event: call:request:initiated
Description: call was initiated (accepted by user)
Tiers: user plugin
Scopes: website:conversation:calls + write

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "e56e3f73-5f34-4329-a5f7-75aa289d0272",
  "call_id": "c038c3c4-8daa-44c1-a4b9-02b1ee4ca477"
}

Call Request Rejected

Event: call:request:rejected
Description: call was rejected (declined by user)
Tiers: user plugin
Scopes: website:conversation:calls + write

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "e56e3f73-5f34-4329-a5f7-75aa289d0272",
  "call_id": "c038c3c4-8daa-44c1-a4b9-02b1ee4ca477"
}

Event: widget:action:processed
Description: widget action processed result (success or failure)
Tiers: user

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "session_id": "e56e3f73-5f34-4329-a5f7-75aa289d0272",
  "plugin_id": "e4b63265-f2d2-4768-b8f0-bc1496ea561e",
  "correlation_id": "10c595c3-7d85-4b6d-9f1e-f63508ff4bce",
  "outcome": "success",

  "result": {
    "key_1": "Arbitrary value generated from the plugin hook",
    "key_2": "Arbitrary value generated from the plugin hook"
  }
}

Status Events

Status Health Changed

Event: status:health:changed
Description: the status page health has changed (either: healthy, sick or dead)
Tiers: user

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "health": "dead",

  "nodes": [
    {
      "label": "Primary load balancers",
      "replica": "tcp://edge-3.pool.net.crisp.chat:80"
    }
  ]
}

Website Events

Website Update Visitors Count

Event: website:update_visitors_count
Description: website visitor counter changed (eg. a visitor came online)
Tiers: user plugin
Scopes: website:visitors + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "visitors_count": 10
}

Website Update Operators Availability

Event: website:update_operators_availability
Description: website operator availability changed, ignores availability schedule (eg. operator is using a Crisp app)
Tiers: user plugin
Scopes: website:operators + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "user_id": "7bef5d48-0e4a-4f49-ac58-a82d132a9f05",

  "availability": {
    "type" : "online"
  }
}

Website Users Available

Event: website:users:available
Description: website availability changed (eg. support went offline)
Tiers: user plugin
Scopes: website:availability + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "available": true
}

Bucket Events

Bucket URL Upload Generated

Event: bucket:url:upload:generated
Description: an upload URL was generated for a file upload (signed URL, usable once)
Tiers: user plugin
Scopes: bucket:url + write

{
  "from": "operator",
  "id": "1640854425557",
  "identifier": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b",

  "resource": {
    "type": "website",
    "id": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b"
  },

  "policy": {
    "size_limit": 12000000
  },

  "type": "upload",

  "url": {
    "resource": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png",
    "signed": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LANNS8LAY5I17G5BIGCJ%2F20211130%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2021130T085345Z&X-Amz-Expires=900&X-Amz-Signature=12d54bd6ad0edea06babe0bde927cg86f8eef9b4241daeb4facdbf8a423a2068&X-Amz-SignedHeaders=host"
  }
}

Bucket URL Avatar Generated

Event: bucket:url:avatar:generated
Description: an upload URL was generated for an avatar upload (signed URL, usable once)
Tiers: user plugin
Scopes: bucket:url + write

{
  "from": "operator",
  "id": "1640854425557",
  "identifier": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b",

  "resource": {
    "type": "website",
    "id": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b"
  },

  "policy": {
    "size_limit": 12000000
  },

  "type": "upload",

  "url": {
    "resource": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png",
    "signed": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LANNS8LAY5I17G5BIGCJ%2F20211130%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2021130T085345Z&X-Amz-Expires=900&X-Amz-Signature=12d54bd6ad0edea06babe0bde927cg86f8eef9b4241daeb4facdbf8a423a2068&X-Amz-SignedHeaders=host"
  }
}

Bucket URL Website Generated

Event: bucket:url:website:generated
Description: an upload URL was generated for a website upload (signed URL, usable once)
Tiers: user plugin
Scopes: bucket:url + write

{
  "from": "website",
  "id": "1640854425557",
  "identifier": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b",

  "resource": {
    "type": "website",
    "id": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b"
  },

  "policy": {
    "size_limit": 12000000
  },

  "type": "upload",

  "url": {
    "resource": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png",
    "signed": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LANNS8LAY5I17G5BIGCJ%2F20211130%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2021130T085345Z&X-Amz-Expires=900&X-Amz-Signature=12d54bd6ad0edea06babe0bde927cg86f8eef9b4241daeb4facdbf8a423a2068&X-Amz-SignedHeaders=host"
  }
}

Bucket URL Campaign Generated

Event: bucket:url:campaign:generated
Description: an upload URL was generated for a campaign file upload (signed URL, usable once)
Tiers: user plugin
Scopes: bucket:url + write

{
  "from": "website",
  "id": "1640854425557",
  "identifier": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b",

  "resource": {
    "type": "website",
    "id": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b"
  },

  "policy": {
    "size_limit": 12000000
  },

  "type": "upload",

  "url": {
    "resource": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png",
    "signed": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LANNS8LAY5I17G5BIGCJ%2F20211130%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2021130T085345Z&X-Amz-Expires=900&X-Amz-Signature=12d54bd6ad0edea06babe0bde927cg86f8eef9b4241daeb4facdbf8a423a2068&X-Amz-SignedHeaders=host"
  }
}

Bucket URL Helpdesk Generated

Event: bucket:url:helpdesk:generated
Description: an upload URL was generated for a helpdesk file upload (signed URL, usable once)
Tiers: user plugin
Scopes: bucket:url + write

{
  "from": "website",
  "id": "1640854425557",
  "identifier": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b",

  "resource": {
    "type": "website",
    "id": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b"
  },

  "policy": {
    "size_limit": 12000000
  },

  "type": "upload",

  "url": {
    "resource": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png",
    "signed": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LANNS8LAY5I17G5BIGCJ%2F20211130%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2021130T085345Z&X-Amz-Expires=900&X-Amz-Signature=12d54bd6ad0edea06babe0bde927cg86f8eef9b4241daeb4facdbf8a423a2068&X-Amz-SignedHeaders=host"
  }
}

Bucket URL Status Generated

Event: bucket:url:status:generated
Description: an upload URL was generated for a status file upload (signed URL, usable once)
Tiers: user plugin
Scopes: bucket:url + write

{
  "from": "website",
  "id": "1640854425557",
  "identifier": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b",

  "resource": {
    "type": "website",
    "id": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b"
  },

  "policy": {
    "size_limit": 12000000
  },

  "type": "upload",

  "url": {
    "resource": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png",
    "signed": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LANNS8LAY5I17G5BIGCJ%2F20211130%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2021130T085345Z&X-Amz-Expires=900&X-Amz-Signature=12d54bd6ad0edea06babe0bde927cg86f8eef9b4241daeb4facdbf8a423a2068&X-Amz-SignedHeaders=host"
  }
}

Bucket URL Processing Generated

Event: bucket:url:processing:generated
Description: an upload URL was generated for a processing/import upload (signed URL, usable once)
Tiers: user plugin
Scopes: bucket:url + write

{
  "from": "website",
  "id": "1640854425557",
  "identifier": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b",

  "resource": {
    "type": "website",
    "id": "b9a1ca05-d2e1-477a-9c1a-b4691f0f591b"
  },

  "policy": {
    "size_limit": 12000000
  },

  "type": "upload",

  "url": {
    "resource": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png",
    "signed": "https://storage.crisp.chat/users/upload/operator/12grgrae444ede/screenshot-2021-11-30-at-11551_10f1s7p.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LANNS8LAY5I17G5BIGCJ%2F20211130%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=2021130T085345Z&X-Amz-Expires=900&X-Amz-Signature=12d54bd6ad0edea06babe0bde927cg86f8eef9b4241daeb4facdbf8a423a2068&X-Amz-SignedHeaders=host"
  }
}

Media Events

Media Animation Listed

Event: media:animation:listed
Description: requested animation/GIF list is being returned
Tiers: user

{
  "id": 1640855025536,

  "results": [
    {
      "type": "image/gif",
      "url": "https://media4.giphy.com/media/LDA66XOr7qo5776eAs/100.gif"
    },

    {
      "type": "image/gif",
      "url": "https://media2.giphy.com/media/EZICHGrSD5QEFCxMiC/100.gif"
    },

    {
      "type": "image/gif",
      "url": "https://media0.giphy.com/media/3oz8xEvL2TuxPeJp16/100.gif"
    }
  ]
}

Email Events

Event: email:subscribe
Description: a user subscribed or unsubscribed to emails
Tiers: user plugin
Scopes: website:people:subscriptions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "email": "crisp@crisp.chat",
  "subscribed": true
}

Email Track View

Event: email:track:view
Description: a user viewed an email
Tiers: user plugin
Scopes: website:people:subscriptions + read

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "type": "session",
  "identifier": "session_657c6ba7-12fa-48e9-ab3c-12c55df87dac",
  "mode": "received"
}

Plugin Events

Plugin Channel

Event: plugin:channel
Description: generic channel for plugins
Tiers: user plugin

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "plugin_id": "3046ebf2-79d7-4075-8833-484a4d4a073e",
  "identifier": "f6e57321-fafc-4af2-9710-a2ced1f75577",
  "namespace": "custom-event",

  "payload": {
    "key_1": "Arbitrary value generated from the plugin"
  }
}

Plugin Event

Event: plugin:event
Description: a generic plugin event has been fired (eg. used for third-party Web Hooks through the chatbot plugin)
Tiers: user plugin

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "plugin_id": "d2fe8f2b-6fef-46f4-9aff-2d2b55989c87",
  "urn": "urn:crisp.im:bot:0",
  "name": "chatbot-fired",

  "data": {
    "customer-role": "sales",
    "session_id": "session_36ba3566-9651-4790-afc8-ffedbccc317f"
  }
}

Plugin Settings Saved

Event: plugin:settings:saved
Description: plugin settings saved
Tiers: user plugin

{
  "website_id": "42286ab3-b29a-4fde-8538-da0ae501d825",
  "plugin_id": "d2fe8f2b-6fef-46f4-9aff-2d2b55989c87",

  "settings": {
    "access_token": "d177b0ef-458e-46b2-a05c-e279299c0c87",
    "page_name": "Nike"
  }
}