GRiMbot documentation

System Status

This is the hosted copy of the GRiMbot technical manual. Use the table of contents to open any page in the manual.

System Status

System Status checks and manages the two Twitch account authorizations used by GRiMbot. It can also request EventSub subscription registration and display raw GRiMbot health details.

Open GRiMbar > System > System Status.

System Status is not the general connection monitor. Use Connection Status to check Twitch Chat, OBS browser sources, integrations, and plugin connection providers.

What the two accounts do

Account Purpose
Bot account Posts Chat Messages and runs supported moderation and shoutout actions. The bot account must be a moderator in the channel for actions that require moderator access.
Broadcaster account Runs actions that require the channel owner and provides broadcaster authorization for channel operations.

Each account card displays one of these states:

State Meaning
Working The authorization is valid and no required Twitch permissions are missing.
Missing permissions The authorization is valid, but Twitch has not granted every permission GRiMbot requires.
Needs authorizing The account is not configured or its authorization is not valid.

The card can also show the signed-in Twitch login, token expiry time, missing permissions, and an error returned by the status check.

Re-authorize an account

  1. Find the account that is not marked Working.
  2. Click Re-authorize bot… or Re-authorize broadcaster….
  3. Complete the Twitch sign-in in the new browser tab.
  4. Approve the permissions shown by Twitch.
  5. Return to System Status.
  6. Click Refresh status if the account card has not updated.
  7. Confirm that the account is marked Working.

Twitch grants new permissions only during a fresh sign-in. Automatic token renewal can keep an existing authorization active, but it cannot add a permission that was not approved.

The redirect address displayed near the top of the window must match a Redirect URL configured for the Twitch application. A mismatch causes Twitch sign-in to fail.

Finish sign-in by hand

Use this procedure only when Twitch accepts the authorization but the callback page cannot be reached.

  1. Leave the failed callback tab open.
  2. Copy its complete address from the browser address bar.
  3. In Finish sign-in by hand, select Bot or Broadcaster to match the account used in the Twitch tab.
  4. Paste the complete callback address into Pasted address.
  5. Click Finish sign-in.
  6. Confirm the success message.
  7. Check that the matching account card is marked Working.

The authorization code in the callback address expires quickly. Start a new re-authorization if System Status reports that it could not complete authorization.

Do not share a callback address. It contains a short-lived authorization code.

Re-register EventSub

GRiMbot attempts EventSub registration after Twitch authorization. EventSub carries Twitch events such as follows, subscriptions, cheers, and Raids.

Re-register events when Twitch events stop arriving or after approving new permissions.

  1. Click Re-register events.
  2. Wait for the result list.
  3. Review the status shown for each event type.
  4. Click Refresh status after the registration attempt if you also need updated account cards.

An EventSub failure does not mean every GRiMbot connection is down. Read the reported result, correct account authorization first, and run Re-register events again.

Technical details

The Technical details panel displays the raw response from the GRiMbot health endpoint. Copy it only when a support procedure asks for health details. Review the text before sharing it.

Control reference

Control Result
Account Chooses which account is completed from a pasted callback address.
Pasted address Accepts the complete Twitch callback address.
Finish sign-in Sends the selected account and callback address to GRiMbot.
Re-authorize bot… Starts a new Twitch authorization for the bot account.
Re-authorize broadcaster… Starts a new Twitch authorization for the broadcaster account.
Re-register events Requests EventSub subscription registration.
Refresh status Reloads account authorization and health information.

Failure handling

Problem Action
Twitch rejects the redirect address Make the Twitch application's Redirect URL match the address displayed in System Status, then start authorization again.
Callback page cannot be reached Use Finish sign-in by hand with the complete callback address.
Authorization code expired Start re-authorization again and complete the handoff promptly.
Account reports missing permissions Re-authorize that account and approve Twitch's permission list.
Twitch events do not arrive Confirm both required accounts are Working, then click Re-register events.
Status cannot load Open Connection Status. If the GRiMbOS request itself is unavailable, restore the GRiMbot service before retrying.

Boundaries

System Status does not check whether EventSub subscriptions are currently registered. The Re-register events result reports the outcome of that request.

System Status does not monitor OBS browser source presence, plugin integrations, or general service connectivity. It does not sign you out of the GRiMbOS admin session. Twitch account authorization and GRiMbOS admin authentication are separate.