PHPackages                             getkirby/discord - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail &amp; Notifications](/categories/mail)
4. /
5. getkirby/discord

ActiveKirby-plugin[Mail &amp; Notifications](/categories/mail)

getkirby/discord
================

Simple Discord webhook wrapper

1.1.0(1y ago)20MITPHPPHP ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0CI passing

Since Jan 16Pushed 1y ago4 watchersCompare

[ Source](https://github.com/getkirby/discord)[ Packagist](https://packagist.org/packages/getkirby/discord)[ Docs](https://getkirby.com)[ Fund](https://getkirby.com/buy)[ RSS](/packages/getkirby-discord/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (7)Versions (4)Used By (0)

Kirby Discord plugin
====================

[](#kirby-discord-plugin)

A simple wrapper to send Discord channel webhooks

Installation
------------

[](#installation)

### Download

[](#download)

Download and copy this repository to `/site/plugins/discord`.

### Composer

[](#composer)

```
composer require getkirby/discord

```

### Git submodule

[](#git-submodule)

```
git submodule add https://github.com/getkirby/discord.git site/plugins/discord

```

How it works?
-------------

[](#how-it-works)

You need to setup a webhook for your channel on Discord first.

1. Click on the "Edit Channel" icon right next to the channel name in the sidebar
2. Go to "Integrations"
3. Go to "Webhooks"
4. Create a new webhook
5. Copy the webhook URL

```
use Kirby\Discord\Discord;

Discord::submit(
  webhook: 'https://discord.com/api/webhooks/xxx/xxx',
  username: 'kirbybot',
  avatar: 'https://example.com/avatar.jpg',
  title: '🔥 Message Title',
  color: '#ebc747',
  description: 'Here goes some nice text',
  author: [
    'name' => 'Ron Swanson',
    'url'  => 'https://example.com',
    'icon' => 'https://example.com/someicon.png'
  ],
  fields: [
    [
      'name'  => 'This is a custom field',
      'value' => 'Add any value here'
    ],
    [
      'name'  => 'This is another one',
      'value' => 'https://canbeanurl.com'
    ],
  ],
  footer: 'Some text for the footer'
);
```

Check out this awesome webhook embed visualizer  to get an idea what each parameter does.

Important

Make sure to keep your webhook URL private. It's recommended to put it into a custom domain config that is not checked into git or store it in an ENV variable.

```
// site/config/config.mydomain.com.php
return [
  'discord' [
    'mywebhook' => 'https://discord.com/api/webhooks/xxx/xxx'
  ]
];
```

Add the custom domain config to your .gitignore and install it manually on your server.

Access the webhook URL:

```
Discord::submit(
  webhook: option('discord.mywebhook'),
  // see additional params above
);
```

What’s Kirby?
-------------

[](#whats-kirby)

- **[getkirby.com](https://getkirby.com)** – Get to know the CMS.
- **[Try it](https://getkirby.com/try)** – Take a test ride with our online demo. Or download one of our kits to get started.
- **[Documentation](https://getkirby.com/docs/guide)** – Read the official guide, reference and cookbook recipes.
- **[Issues](https://github.com/getkirby/kirby/issues)** – Report bugs and other problems.
- **[Feedback](https://feedback.getkirby.com)** – You have an idea for Kirby? Share it.
- **[Forum](https://forum.getkirby.com)** – Whenever you get stuck, don't hesitate to reach out for questions and support.
- **[Discord](https://chat.getkirby.com)** – Hang out and meet the community.
- **[Mastodon](https://mastodon.social/@getkirby)** – Follow us in the Fediverse.
- **[Bluesky](https://bsky.app/profile/getkirby.com)** – Follow us on Bluesky.
- **[Bluesky](https://bsky.app/profile/getkirby.com)** – Spread the word.

---

License
-------

[](#license)

MIT

Credits
-------

[](#credits)

- [Kirby Team](https://getkirby.com)

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance41

Moderate activity, may be stable

Popularity3

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 94.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

486d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/da0d3433a1b7637495d024760cdce2fb9e4174d1a3f80d707626f95c81724534?d=identicon)[bastianallgeier](/maintainers/bastianallgeier)

![](https://www.gravatar.com/avatar/38dee61adefb0d9fae59254a74cdaf33d8b4fcac96b451b9f9c46e0ab3ec1279?d=identicon)[distantnative](/maintainers/distantnative)

![](https://www.gravatar.com/avatar/e89dc1e09ef4dbe7986140a861a0a2630011c6b8ad62f26e67e0ef10eb2f501c?d=identicon)[texnixe](/maintainers/texnixe)

![](https://www.gravatar.com/avatar/910e459690c98761ff47c8f5b0af29b440005ed926b2f386a2aeb033030d35e8?d=identicon)[lukasbestle](/maintainers/lukasbestle)

---

Top Contributors

[![bastianallgeier](https://avatars.githubusercontent.com/u/24532?v=4)](https://github.com/bastianallgeier "bastianallgeier (35 commits)")[![distantnative](https://avatars.githubusercontent.com/u/3788865?v=4)](https://github.com/distantnative "distantnative (2 commits)")

---

Tags

cmsdiscordkirbykirby4kirby5notificationwebhooknotificationcmswebhookdiscordkirbykirby5kirby4

###  Code Quality

TestsPest

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/getkirby-discord/health.svg)

```
[![Health](https://phpackages.com/badges/getkirby-discord/health.svg)](https://phpackages.com/packages/getkirby-discord)
```

###  Alternatives

[laravel-notification-channels/discord

Laravel notification driver for Discord.

2371.3M11](/packages/laravel-notification-channels-discord)[guanguans/notify

Push notification SDK(AnPush、Bark、Chanify、DingTalk、Discord、Gitter、GoogleChat、IGot、Lark、Mattermost、MicrosoftTeams、NowPush、Ntfy、Push、Pushback、PushBullet、PushDeer、PushMe、Pushover、PushPlus、QQ、RocketChat、ServerChan、ShowdocPush、SimplePush、Slack、Telegram、WeWork、WPush、XiZhi、YiFengChuanHua、ZohoCliq、ZohoCliqWebHook、Zulip).

682104.9k7](/packages/guanguans-notify)[beebmx/kirby-courier

Courier offers a convenient and painless solution for creating emails tailored for your Kirby website.

403.0k2](/packages/beebmx-kirby-courier)[snoeren-development/laravel-discord-webhook-channel

Send notifications to a Discord webhook.

1549.8k1](/packages/snoeren-development-laravel-discord-webhook-channel)[wagnerwagner/merx

A toolkit to create online shops with Kirby

1152.7k](/packages/wagnerwagner-merx)[beebmx/kirby-env

Enable env variables to Kirby

2037.9k2](/packages/beebmx-kirby-env)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
