https://github.com/dbots-pkg/dbothook.js

A webhook receiver for all botlists.
https://github.com/dbots-pkg/dbothook.js

api discord discordapp discordbots webhook webhook-receiver

Last synced: 6 days ago
JSON representation

A webhook receiver for all botlists.

• Host: GitHub
• URL: https://github.com/dbots-pkg/dbothook.js
• Owner: dbots-pkg
• License: mit
• Created: 2020-04-01T06:00:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-19T09:00:58.000Z (almost 2 years ago)
• Last Synced: 2024-04-26T12:21:45.596Z (7 months ago)
• Topics: api, discord, discordapp, discordbots, webhook, webhook-receiver
• Language: JavaScript
• Homepage: https://dbothook.js.org
• Size: 1.84 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  


    

  

  
A webhook receiver for all botlists.

  


    

    

    

    

    


    

    

  

  


    

  



# Table of Contents

- [About](#about)

- [Installing](#installing)

- [Example](#example)

- [Supported Services](#supported-services)

- [Contribution](#contribution)

- [Other Links](#other-links)

## About

`dbothook` helps [Discord](https://discordapp.com) bot developers recieve webhook events from multiple bot lists. You can create an express application straight from the hook or integrate endpoints into an existing application.

## Installing

You can install dbothook by running this command:

```sh

# Stable

npm i dbothook

yarn add dbothook

# Master

npm i dbots-pkg/dbothook.js#master

yarn add ssh://github.com/dbots-pkg/dbothook.js#master

```

## Example

```js

const DBotHook = require('dbothook');

const hook = new DBotHook({

    authSecrets: {

        topgg: '…',

        discordboats: '…',

        discordbotlist: '…',

        botsfordiscord: '…'

    }

});

hook.listen(5478);

hook.on('called', event => {

  // Give them some perks...

});

// This should open endpoints for each bot list

// For example, you can set your webhook URL to "https://some.site/topgg" and start collecting requests.

```

## Supported Services

| Service | Key | Returns `botId`? | Returns `username` & `discriminator`? |

| :-- | :-- | :-: | :-: |

| [Arcane Bot Center](https://arcane-center.xyz/) | `arcanebotcenter` | ✅ | ✅ |

| [Botlist.space](https:/botlist.space/) | `botlistspace` | ✅ | ✅ |

| [Bots For Discord](https://botsfordiscord.com/) | `botsfordiscord` | ✅ | ❌ |

| [Discord Boats](https://discord.boats/) | `discordboats` | ✅* | ✅ |

| [Discord Bot List](https://discordbotlist.com/) | `discordbotlist` | ❌ | ✅ |

| [Glenn Bot List](https://glennbotlist.xyz/) | `glennbotlist` | ✅ | ❌ |

| [List My Bots](https://listmybots.com/) | `listmybots` | ✅ | ❌ |

| [Mythical Bots](https://mythicalbots.xyz/) | `mythicalbots` | ❌ | ❌ |

| [Top.GG](https://top.gg/) | `topgg` | ✅ | ❌ |

*The bot ID from Discord Boats events will be recieved from the URL or the avatar URL in the payload. If your bot has a vanity URL (assuming Discord Boats posts that) and does not have an avatar, the bot ID will be `null`.

## Contribution

Any contribution may be useful for the package! Make sure when making issues or PRs that the issue has not been addressed yet in a past issue/PR.

## Other Links

- [NPM](https://npmjs.org/package/dbothook)

- [Yarn](https://yarn.pm/dbothook)

- [JSDelivr](https://www.jsdelivr.com/package/npm/dbothook)

- [David (Dependency Watcher)](https://david-dm.org/dbots-pkg/dbothook.js)

- [dbots GitHub Organization](https://github.com/dbots-pkg)