https://github.com/kisakay/guilded-webhook-node
This package is based on discord-webhook-node, ported on Guilded's API
https://github.com/kisakay/guilded-webhook-node
guilded webhook
Last synced: over 1 year ago
JSON representation
This package is based on discord-webhook-node, ported on Guilded's API
- Host: GitHub
- URL: https://github.com/kisakay/guilded-webhook-node
- Owner: Kisakay
- License: mit
- Created: 2023-03-03T14:22:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-03T16:26:44.000Z (over 3 years ago)
- Last Synced: 2024-04-29T09:43:04.256Z (about 2 years ago)
- Topics: guilded, webhook
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/guilded-webhook-node
- Size: 75.2 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guilded Webhook Sender
- [Installation](#installation)
- [Examples](#examples)
- [Basic use](#basic-use)
- [Custom embeds](#custom-embeds)
- [Preset messages](#preset-messages)
- [Custom settings](#custom-settings)
- [Notes](#notes)
- [API](#api)
- [Webhook](#webhook---class)
- [MessageBuilder](#messagebuilder---class)
- [License](#license)
# Origin
The original source code is from here :
www.npmjs.com/package/discord-webhook-node
This modules is just "Discord Webhook Node" for Guilded version.
# Installation
```npm install guilded-webhook-node```
# Examples
## Basic use
```js
const { Webhook } = require('guilded-webhook-node');
const hook = new Webhook("YOUR WEBHOOK URL");
const IMAGE_URL = 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/99/Unofficial_JavaScript_logo_2.svg/1200px-Unofficial_JavaScript_logo_2.svg.png';
hook.setUsername('Guilded Webhook Name');
hook.setAvatar(IMAGE_URL);
hook.send("Hello world!");
```
## Custom embeds
```js
const { Webhook, MessageBuilder } = require('guilded-webhook-node');
const hook = new Webhook("YOUR WEBHOOK URL");
const embed = new MessageBuilder()
.setTitle('My title here')
.setAuthor('Author here', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/99/Unofficial_JavaScript_logo_2.svg/1200px-Unofficial_JavaScript_logo_2.svg.png', 'https://www.google.com')
.setURL('https://www.google.com')
.addField('First field', 'this is inline', true)
.addField('Second field', 'this is not inline')
.setColor('#00b0f4')
.setThumbnail('https://upload.wikimedia.org/wikipedia/commons/thumb/9/99/Unofficial_JavaScript_logo_2.svg/1200px-Unofficial_JavaScript_logo_2.svg.png')
.setDescription('Oh look a description :)')
.setImage('https://upload.wikimedia.org/wikipedia/commons/thumb/9/99/Unofficial_JavaScript_logo_2.svg/1200px-Unofficial_JavaScript_logo_2.svg.png')
.setFooter('Hey its a footer', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/99/Unofficial_JavaScript_logo_2.svg/1200px-Unofficial_JavaScript_logo_2.svg.png')
.setTimestamp();
hook.send(embed);
```
Keep in mind that the custom embed method `setColor` takes in a decimal color/a hex color (pure black and white hex colors will be innacurate). You can convert hex colors to decimal using this website here: [https://convertingcolors.com](https://convertingcolors.com)
## Preset messages
```js
const { Webhook } = require('guilded-webhook-node');
const hook = new Webhook('YOUR WEBHOOK URL');
//Sends an information message
hook.info('**Information hook**', 'Information field title here', 'Information field value here');
//Sends a success message
hook.success('**Success hook**', 'Success field title here', 'Success field value here');
//Sends an warning message
hook.warning('**Warning hook**', 'Warning field title here', 'Warning field value here');
//Sends an error message
hook.error('**Error hook**', 'Error field title here', 'Error field value here');
```
## Custom settings
```js
const { Webhook } = require('guilded-webhook-node');
const hook = new Webhook({
url: "YOUR WEBHOOK URL",
//If throwErrors is set to false, no errors will be thrown if there is an error sending
throwErrors: false,
//retryOnLimit gives you the option to not attempt to send the message again if rate limited
retryOnLimit: false
});
hook.setUsername('Username'); //Overrides the default webhook username
hook.setAvatar('YOUR_AVATAR_URL'); //Overrides the default webhook avatar
```
# Notes
guilded-webhook-node is a promise based library, which means you can use `.catch`, `.then`, and `await`, although if successful will not return any values. For example:
```js
const { Webhook } = require('guilded-webhook-node');
const hook = new Webhook("YOUR WEBHOOK URL");
hook.send("Hello there!")
.then(() => console.log('Sent webhook successfully!'))
.catch(err => console.log(err.message));
```
or using async:
```js
const { Webhook } = require('guilded-webhook-node');
const hook = new Webhook("YOUR WEBHOOK URL");
(async () => {
try {
await hook.send('Hello there!');
console.log('Successfully sent webhook!');
}
catch(e){
console.log(e.message);
};
})();
```
By default, it will handle guilded's rate limiting, and if there is an error sending the message (other than rate limiting), an error will be thrown. You can change these options with the custom settings options below.
# API
## Webhook - class
Constructor
- options (optional) : object
- throwErrors (optional) : boolean
- retryOnLimit (optional) : boolean
Methods
- setUsername(username : string) returns this
- setAvatar(avatarURL : string (image url)) returns this
- async send(payload : string/MessageBuilder)
- async info(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)
- async success(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)
- async warning(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)
- async error(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)
-
## MessageBuilder - class
Methods
- setText(text: string)
- setAuthor(author: string (text), authorImage (optional) : string (image url), authorUrl (optional) : string (link))
- setTitle(title: string)
- setURL(url: string)
- setThumbnail(thumbnail : string (image url))
- setImage(image : string (image url))
- setTimestamp(date (optional) number/date object)
- setColor(color : string/number (hex or decimal color))
- setDescription(description : string)
- addField(fieldName : string, fieldValue: string, inline (optional) : boolean)
- setFooter(footer : string, footerImage (optional) : string (image url))
# License
MIT