LIVCK Discord Bot Documentation

Overview

The LIVCK Discord Bot allows servers to monitor status pages by subscribing to them. It supports two main event types:

  • NEWS: Announcements visible on the status page.
  • STATUS: Current status of all services.

Servers can manage multiple subscriptions, enabling updates from various status pages within a single channel.

Features

  • Subscriptions: Subscribe to specific status pages and select event types (NEWS, STATUS, or BOTH).
  • Announcements: Automatically post updates from status pages to designated channels.
  • Multiple Subscriptions: Manage multiple status page subscriptions within a server.

Getting Started

Inviting the Bot

To add the LIVCK Discord Bot to your server, use the following invite link:

Invite LIVCK Discord Bot

Ensure you have the necessary permissions to add bots to the server.

Commands

The bot provides the following commands to manage subscriptions:

/livck subscribe

Subscribe to a status page.

Usage:

/livck subscribe url channel events

Parameters:

  • url (required): The URL of the status page to subscribe to.
  • channel (required): The channel where updates will be posted.
  • events (required): The types of events to subscribe to. Choices are:
    • BOTH: Subscribe to both NEWS and STATUS events.
    • STATUS: Subscribe only to STATUS events.
    • NEWS: Subscribe only to NEWS events.

/livck unsubscribe

Unsubscribe from a status page.

Usage:

/livck unsubscribe url or channel

Parameters:

  • url (optional): The URL of the status page to unsubscribe from.
  • channel (optional): The channel from which to remove the subscription.

/livck list

List all subscriptions for the server.

Usage:

/livck list

This command displays all active subscriptions, including the status page URLs, event types, and target channels.

Handling News Events

When a NEWS event is received, the bot processes it as follows:

  • Color Coding:

    • Incident: Red
    • Scheduled: Yellow
    • News: Blurple

  • Embed Structure:

    • Title: The title of the news item.
    • Description: A truncated version (up to 500 characters) of the news content.
    • URL: Link to the full news item.
    • Timestamp: The publication date of the news.
    • Footer: Name of the status page.

Self-Hosting

The LIVCK Discord Bot is open-source and can be self-hosted. The source code is available on GitHub:

GitHub Repository

Follow the instructions in the repository to set up and run the bot on your own infrastructure.

Reporting Bugs

As the bot is currently in beta, users may encounter bugs or issues. To report a bug, please contact us through one of the following channels:

Your feedback is valuable and helps us improve the bot.