Skip to content

xhyrom-utils/github-status-webhook

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Join Hyro's Coffe for latest updates.

Discord API Status Webhook

Table of Contents

  1. Introduction
  2. Getting started
  3. Creating a webhook
  4. Configuration
  5. Run it!

Introduction

This project uses the discord.js library to create a webhook which can display past and current status-changes of the official Discord API. The information is taken from discordstatus.com, the official Discord API's status page.

The resulting messages look like this:

result

Getting started

Clone this repository by running the following commands:

git clone https://github.com/Laennart/discord-api-status-webhook.git
cd discord-api-status-webhook/

Creating a webhook

  1. Navigate to your discord server and choose a channel where you want the updates to be displayed.
  2. Go into the channels settings and navigate to the Integrations menu. channel-settings
  3. Click on "Create Webhook", give it a name and save your changes. create-webhook
  4. Copy the Webhook URL into the config file.

Configuration

Before you can start using the webhook you have to create a config.json file in the root directory of the project. Now paste your Webhook URL into the config file.

{
  "url": "Webhook-Url",
  "ignoreDays": 30
}

Run it!

Now we can start the webhook by typing the following into the terminal:

npm install
npm run start

For future use you could set up a script to run the webhook periodically (e.g. with cron).

About

Discord Webhook to display the github's status.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%