https://github.com/jb3/webhook-discord

A simple Javascript file for nicely formatting Discord webhooks
https://github.com/jb3/webhook-discord

discord discord-webhooks javascript npm-package utility webhooks

Last synced: 7 days ago
JSON representation

A simple Javascript file for nicely formatting Discord webhooks

• Host: GitHub
• URL: https://github.com/jb3/webhook-discord
• Owner: jb3
• License: mit
• Created: 2016-11-18T19:50:20.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-05-21T07:36:47.000Z (over 2 years ago)
• Last Synced: 2024-05-02T02:39:41.153Z (9 months ago)
• Topics: discord, discord-webhooks, javascript, npm-package, utility, webhooks
• Language: JavaScript
• Size: 683 KB
• Stars: 100
• Watchers: 6
• Forks: 38
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Discord Webhooks

![version](https://img.shields.io/npm/v/webhook-discord.svg "Version")

![npm](https://img.shields.io/npm/dt/webhook-discord.svg "Total Downloads")

A simple Javascript file for nicely formatting Discord webhooks

See the full documentation at [jb3.github.io/webhook-discord](https://jb3.github.io/webhook-discord)

## Usage

It's simple

To initialise:

```js

const webhook = require("webhook-discord")

const Hook = new webhook.Webhook("WEBHOOK URL")

```

### Presets

To send an info message:

```js

Hook.info("WEBHOOK NAME","Info")

```

To send a warning message:

```js

Hook.warn("WEBHOOK NAME", "Warning message")

```

To send an error message:

```js

Hook.err("WEBHOOK NAME","Error")

```

To send a success message:

```js

Hook.success("WEBHOOK NAME","Yay we did something right")

```

### Custom messages

To send custom messages, you should make use of the MessageBuilder.

See all the options on the [documentation](https://jb3.github.io/webhook-discord/MessageBuilder.html)

```js

const webhook = require("webhook-discord");

const Hook = new webhook.Webhook("WEBHOOK URL");

const msg = new webhook.MessageBuilder()

                .setName("Username")

                .setColor("#aabbcc")

                .setText("This is my webhook!");

Hook.send(msg);

```

## Installation

Either use npm:

```

npm install webhook-discord

```

Or clone from source:

```

git clone https://github.com/jb3/webhook-discord.git

```

## License

MIT