Project

trycourier

0.01
A long-lived project that still receives updates
Ruby library to access the Courier API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

 Project Readme

Courier Ruby SDK

The Courier Ruby SDK provides typed access to the Courier REST API from any Ruby 3.2+ application. It ships with Yard docstrings, RBS and RBI type definitions for Sorbet, and uses net/http with connection pooling.

Installation

Add to your Gemfile:

gem "trycourier", "~> 4.7"

Then run bundle install.

Quick Start

require "bundler/setup"
require "courier"

client = Courier::Client.new

response = client.send_.message(
  message: {
    to: { email: "you@example.com" },
    content: {
      title: "Hello from Courier!",
      body: "Your first notification, sent with the Ruby SDK."
    }
  }
)

puts response.request_id

The client reads COURIER_API_KEY from your environment automatically. You can also pass it explicitly: Courier::Client.new(api_key: "your-key").

Note: The method is send_ (with trailing underscore) because send is a reserved method in Ruby.

Documentation

Full documentation: courier.com/docs/sdk-libraries/ruby