nopjmp/discord-webhooks

A simple Discord webhook client library.

0.4.0 2024-04-20 21:11 UTC

This package is auto-updated.

Last update: 2024-11-20 23:20:04 UTC


README

Discord webhooks is a simple client for Discord's webhook API.

Motivation

While this is probably "yet another" library for Discord's webhook system, I wanted to make my own. Discord doesn't support BitBucket's webhook system and the Slack compatible endpoint doesn't send a message.

Getting Started

You can either copy the PHP file directly into your project or preferable just use composer.

Composer require command

composer require nopjmp/discord-webhooks

Usage

It is fairly easy to use. I'll throw in an example.

use \DiscordWebhooks\Client;
use \DiscordWebhooks\Embed;

$webhook = new Client('DISCORD_WEBHOOK_URL');
$embed = new Embed();

$embed->description('This is an embed');

$webhook->username('Bot')->message('Hello, Human!')->embed($embed)->send();

Example of sending files:

$webhook->addFile("/path/to/file")
        ->addStringFile("Hello World!", "hello_world.txt")
        ->send();

License

The project is MIT licensed. To read the full license, open LICENSE.md.

Contributing

Pull requests and issues are open!