Discord::Notifier

Requires Ruby 2.3 or later

A light wrapper around sending Discord webhooks and embeds.

Installation

Add this line to your application's Gemfile:

gem 'discord-notifier'

And then execute:

$ bundle

Usage

Configuration

You can set defaults for Discord Notifier to use. For descriptions of what the fields do, refer to the Discord webhook documentation.

Discord::Notifier.setup do |config|
  config.url = 'WEBHOOK_URL'
  config.username = 'My Webhook Username'
  config.avatar_url = ''

  # Defaults to `false`
  config.wait = true
end

If you're using Rails, place this in config/initializers/discord_notifier.rb.

Standard Message

To send a standard string message, use

Discord::Notifier.message('Discord Notifier Webhook Notification')

Embeds

To create and send an embed, use

embed = Discord::Embed.new do
  title "Discord Ruby Notification"
  author name: "Webhook Bot",
         avatar_url: 'AUTHOR_AVATAR'

  footer text: 'Notification via DiscordNotifier Gem',
         icon_url: 'ICON_URL'
end

Discord::Notifier.message(embed)

For a list of embed fields and parameters you can use, refer to the official documentation. Please note that not all embed types and fields are supported through webhooks. You can read more about the exceptions here.

This gem provides the following API methods when creating an Embed:

title(str)

description(str)

url(str)

timestamp(datetime)

color(str)

Needs to be a hex string, ex #008000