https://github.com/MeowTaiga/discord-ping

🔔 Get a webhook ping for your code! Want to know exactly when something happens and keep a log of it for free? use discord! Log when someone views your site, makes a purchase, whenever any action takes place! 💕
https://github.com/MeowTaiga/discord-ping

Last synced: about 2 months ago
JSON representation

🔔 Get a webhook ping for your code! Want to know exactly when something happens and keep a log of it for free? use discord! Log when someone views your site, makes a purchase, whenever any action takes place! 💕

• Host: GitHub
• URL: https://github.com/MeowTaiga/discord-ping
• Owner: MeowTaiga
• Created: 2020-11-09T16:11:43.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-09T17:36:45.000Z (almost 4 years ago)
• Last Synced: 2024-06-12T03:15:03.323Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 4.88 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# discord-ping

Get a ping to one of your discord channels! Set unique actions, so you get notified when something happens on your website straight to your discord server.

## What this does

get notifications on your phone, have interactions with users about website updates, possiblities are endless.

![Showcase](https://i.imgur.com/vaFiBkI.png)

## Installation

```bash

npm i @aisaka/discord-ping

```

## Usage

```

import {pingDiscord} from '@aisaka/discord-ping'

...

const options = {

    title: `Your Embed title`, //big title on your discord message

    desc: `Something happened on my sight!`, //embed description field

    location: true, //true default

    color: '#2a2a2a' //Color of your message, blue by default

}

pingDiscord(YOUR_WEBHOOK_URL, options);

...

```

## Getting a discord webhook URL

Go into a server you have webhook permissions for, and follow the screen shots below.

![Step one](https://i.imgur.com/z0qLDfU.png)

![Step two](https://i.imgur.com/r1nUGCX.png)

![Step three](https://i.imgur.com/PrXMUXN.png)

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)