pingram

Official Ruby SDK for Pingram. Send notifications via Email, SMS, Push, In-App, and more from your server-side Ruby code.

Requirements

  • Ruby 2.4+
  • Dependencies: see the gem for details (e.g. faraday).

Installation

gem install pingram

Or add to your Gemfile:

gem 'pingram'

Then run bundle install.

Quick start

Use Pingram::Client with your API key, then call send(body) or the namespaced APIs (default_api, account, sender, etc.).

require 'pingram'

client = Pingram::Client.new(api_key: 'pingram_sk_...')

# Send a notification (delegates to the default/sender API)
body = Pingram::SenderPostBody.new(
  notification_id: 'your_notification_id',
  to: { id: 'user_123' }
)
response = client.send(body)

# Or use namespaced APIs: client.default_api, client.account, client.sender, ...

You can override the base URL: Pingram::Client.new(api_key: '...', base_url: 'https://api.example.com').

What can I call?

  • client.send(body) – send a notification (high-level).
  • client.domains, client.account, client.sender, etc. – low-level API objects with methods like domains_list_domains, account_get_account_details, sender_test_email, and so on.

For the full list of methods, see API_REFERENCE.md in the gem or documentation.