Events API documentation

What is Events API

Events API allows users to receive notifications about events like chat messages, private messages, tips, etc. Any programming language can be used to connect to this API from a 3rd party server.

Authorization

Events API access is controlled by :token_url:. You can create multiple access tokens and delete them to remove access.

Make sure to select Events API scope to gain access to this API.

After deleting a token, please wait up to one minute for API access to get revoked.

Warning

With these credentials, participating third party services can connect features and services for your room, such as toy controls. Please only provide your access token to services that you trust, as it does grant access to tip information and private messages.

How to use it

Connect to the longpoll JSON event feed

Method Types

• broadcastStart
• broadcastStop
• chatMessage
• fanclubJoin
• follow
• mediaPurchase
• privateMessage
• roomSubjectChange
• tip
• unfollow
• userEnter
• userLeave

Object Types

• Objects
  • broadcaster
  • media
  • message
  • subject
  • tip
  • user

Changelog