Welcome

Contributing
Getting Support
User guides
Administrator guides
- Account Settings
- Authentication
  - CAS
  - Ldap
  - Oauth
  - SAML
    - Oracle Cloud
  - WordPress
- Database-Migration
- Email
- File Upload
- Import
  - CSV
  - HipChat
    - Cloud
    - Enterprise
  - Slack
    - SlackBridge
- Integrations
  - Zapier
    - Using Zaps
  - AppVeyor
  - Azure Alerts
  - BitBucket
  - DeadSimpleScreenSharing
  - Gif.pimenta
  - GitHub
  - GitLab
  - Google-Calendar
  - Guggy
  - Jenkins
  - Jira
  - MicroBadger
  - NextCloud and WebDAV
  - NewRelic
  - nixstats
  - PagerDuty
  - Prometheus
  - RunDeck
  - Sentry
  - Telegram
  - Travis CI
  - Trello
  - Uptime Robot
- Google Cloud
  - Auto Translate
- Setting Up Video Conferencing
- Livechat
  - Livechat Queues
  - Omnichannel Integration
- Notifications
  - Push Notifications
- Permissions
- Custom Fields
- Plug-ins
  - Drupal
  - Pidgin
- Create the First Admin
- Restoring an Admin
- Retention Policies
- Settings Via Env Vars
- Youtube Broadcasting
Developer guides
- Quick Start
- Installation
- Branches and Releases
- Code Styleguide
  - less
- Deeplink
- Deprecation
- Iframe Integration
- Embedded Layout
- Internationalization
- Livechat API
- Mobile Apps
- Developing Apps
  - Getting Started
- Realtime-API
- Rest API
  - Assets
    - setAsset
    - unsetAsset
  - Authentication
    - facebook
    - google
    - login
    - logout
    - me
    - twitter
  - Channels
    - addAll
    - addModerator
    - addOwner
    - archive
    - close
    - counters
    - create
    - delete
    - files
    - getAllUserMentionsByChannel
    - getIntegrations
    - history
    - info
    - invite
    - join
    - kick
    - leave
    - list.joined
    - list
    - members
    - messages
    - moderators
    - open
    - removeModerator
    - removeOwner
    - rename
    - roles
    - setAnnouncement
    - setCustomFields
    - setDefault
    - setDescription
    - setJoinCode
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Chat
    - delete
    - getMessage
    - getMessageReadReceipts
    - pinMessage
    - postMessage
    - react
    - reportMessage
    - search
    - starMessage
    - sendMessage
    - unPinMessage
    - unStarMessage
    - update
  - Commands
    - get
    - list
    - run
  - Groups
    - addAll
    - addModerator
    - addOwner
    - archive
    - close
    - counters
    - create
    - delete
    - files
    - getIntegrations
    - history
    - info
    - invite
    - kick
    - leave
    - list
    - listAll
    - members
    - messages
    - moderators
    - open
    - removeModerator
    - removeOwner
    - rename
    - roles
    - setAnnouncement
    - setCustomFields
    - setDescription
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Im
    - close
    - counters
    - create
    - files
    - history
    - list.everyone
    - list
    - members
    - messages
    - messages.others
    - open
    - setTopic
  - Integration
    - create
    - history
    - list
    - remove
  - Livechat
    - agent
    - config
    - custom-fields
    - department
    - message
    - room
    - sms-incoming
    - users
    - video-call
    - visitor
  - Miscellaneous
    - directory
    - info
    - shield.svg
    - spotlight
    - statistics
    - statistics.list
  - Permissions
    - list
    - update
  - Roles
    - create
    - list
    - addUserToRole
  - Push
    - push.token
    - deletePushToken
  - Rooms
    - cleanHistory
    - favorite
    - get
    - info
    - leave
    - saveNotification
    - upload
  - Settings
    - get
    - get-by-id
    - oauth
    - public
    - service-configuration
    - update
  - Subscriptions
    - get
    - getOne
    - read
    - unread
  - Users
    - create
    - createToken
    - delete
    - deleteOwnAccount
    - forgotPassword
    - generatePersonalAccessToken
    - getAvatar
    - getPersonalAccessTokens
    - getPresence
    - get-preferences
    - getUsernameSuggestion
    - info
    - list
    - regeneratePersonalAccessToken
    - register
    - removePersonalAccessToken
    - resetAvatar
    - setAvatar
    - set-preferences
    - update
    - updateOwnBasicInfo
  - pimentaLIVE [Video Conference]
    - pimentalive-update-timeout
  - Voice Calls
    - voice.call
    - voice.call.feedback
    - voice.call.ping
    - voice.call.history
  - Offset and Count and Sort Info
  - Query and Fields Info
  - Personal Access Tokens
- Schema Definition
- Testing
- Troubleshooting
- UI and Theming
  - Colors
  - Components
  - Themes
- Pimenta Call
  - Class
  - Messages
Bots
Community Cookbook
- Remote Video Monitoring

GraphQL API Subscription

You can subscribe (Websocket protocol) to listen to events, by a GraphQL subscription. You should listen the event on the same port defined in the admin panel, in the GraphQL subscription port field. (General -> GrahQL API -> GraphQL Subscription Port)

Events available:

chatMessageAdded

Contribute to our growth with your feedback