Skip to main content

Introduction

What are Extension Webhooks?​

Extensions webhooks allow your client to listen to events easily with just a simple post URL.

There are two different Webhooks available to Developers

Websocket Webhooks

https://ws.chatrpg.com/pubsub/subscribe

  • Chat Messages - chatMessages
  • Chatter Connections (ChatRPG only) - socketConnections
Server Webhooks

https://server.chatrpg.com/pubsub/subscribe

  • Extension Removed - removeExtension
  • Extension Added - addExtension
  • Extension Enabled - enableExtension
  • Extension Disabled - disableExtension

What do I need as a Developer when accessing a Webhook?​

As a developer you will need at minimum two things when accessing a webhook

  • Client ID
  • Client Secret

Streamer ID is required for Websocket Webhooks

  • Streamer ID

You can acquire your Client ID and Client Secret by following these steps:

  • Go to ChatRPG.com
  • Log In
  • Go to the top right and click your profile photo
  • Go to your settings
  • Click "Become a Developer"
  • Wait for Confirmation
  • Add an extension

What are Client IDs and Client Secrets?​

Your Client ID is public - you don't need to worry about exposing this, and you can think of it as a username.

The Client Secret should NEVER be shared. The Client Secret will verify user identities and prove you're the owner of the extension.

When does my Webhook expire?​

After 7 days your webhook will expire.

You'll have to renew it by simply re-registering your URL.