Ruby Client SDK

The OneSignal Ruby client is a server OneSignal SDK for Ruby. Integrate OneSignal with your backend events, data, and more.

Ruby Client SDK

OneSignal - the Ruby gem for the OneSignal

πŸ–€ RubyGems

Click to view the latest release version.


Add this line to your application's Gemfile:

gem 'onesignal', '~> 1.0.1'

And then execute:

$ bundle

Or install with:

$ gem install onesignal

Or install from Github:

$ gem "onesignal", '~> 1.0.1', git: 'git://'

Getting Started

Please follow the installation procedure and then run the following code:

require 'onesignal'

# setup authorization
OneSignal.configure do |config|
  # Configure Bearer authorization: app_key
  config.user_key = 'YOUR_USER_KEY' # Change this
  config.app_key = 'YOUR_APP_KEY'

api_instance =
notification ={app_id: 'YOUR APP ID'}) # Notification

  # Create notification
  result = api_instance.create_notification(notification)
  p result
rescue OneSignal::ApiError => e
  puts "Error when calling DefaultApi->create_notification: #{e}"

Documentation for Authorization


  • Type: Bearer authentication
OneSignal.configure do |config|
  config.app_key = 'APP_KEY' # replace with your app key


  • Type: Bearer authentication
OneSignal.configure do |config|
  config.user_key = 'USER_KEY' # replace with your user key

Documentation for API Endpoints

All URIs are relative to

ClassMethodHTTP requestDescription
OneSignal::DefaultApicancel_notificationDELETE /notifications/{notification_id}Stop a scheduled or currently outgoing notification
OneSignal::DefaultApicreate_appPOST /appsCreate an app
OneSignal::DefaultApicreate_notificationPOST /notificationsCreate notification
OneSignal::DefaultApicreate_playerPOST /playersAdd a device
OneSignal::DefaultApicreate_segmentsPOST /apps/{app_id}/segmentsCreate Segments
OneSignal::DefaultApidelete_playerDELETE /players/{player_id}Delete a user record
OneSignal::DefaultApidelete_segmentsDELETE /apps/{app_id}/segments/{segment_id}Delete Segments
OneSignal::DefaultApiexport_playersPOST /players/csv_export?app_id={app_id}CSV export
OneSignal::DefaultApiget_appGET /apps/{app_id}View an app
OneSignal::DefaultApiget_appsGET /appsView apps
OneSignal::DefaultApiget_notificationGET /notifications/{notification_id}View notification
OneSignal::DefaultApiget_notification_historyPOST /notifications/{notification_id}/historyNotification History
OneSignal::DefaultApiget_notificationsGET /notificationsView notifications
OneSignal::DefaultApiget_outcomesGET /apps/{app_id}/outcomesView Outcomes
OneSignal::DefaultApiget_playerGET /players/{player_id}View device
OneSignal::DefaultApiget_playersGET /playersView devices
OneSignal::DefaultApiupdate_appPUT /apps/{app_id}Update an app
OneSignal::DefaultApiupdate_playerPUT /players/{player_id}Edit device
OneSignal::DefaultApiupdate_player_tagsPUT /apps/{app_id}/users/{external_user_id}Edit tags with external user id