Ruby

The Ruby SDK calls the API from your server with your secret key. Supports Ruby 3.1 and later. The send method is push, so Ruby’s own Object#send keeps working.

Install

bundle add pushfleet

Send

Ruby

Ruby

fleet = PushFleet::Client.new(ENV["PUSHFLEET_SECRET_KEY"])
fleet.push(
  to: "user_8f3k",
  title: "Your order shipped",
  body: "Arriving Thursday"
)

Send with a template

Ruby

Ruby

fleet.push(
  to: "user_8f3k",
  template: "order_shipped",
  vars: { eta: "Thu" }
)

Sign user tokens

In live mode your app registers devices with a user token your server signs. The SDK signs it locally, without a request. See identity verification.

Ruby

Ruby

user_token = fleet.users.token("user_8f3k")

Errors and retries

Failed requests raise PushFleet::Error with the API’s code, status and doc link. The SDK retries 429 and 5xx responses with backoff, and sends an idempotency key with every retry so nothing goes out twice.

Every endpoint in the API reference has a Ruby sample.