Docs
Checking Raims account

Changelog

Follow new features, improvements, and fixes in Raims.

All updates

Public API Ruby SDK available on RubyGems

API

The official public API Ruby SDK is available on RubyGems as the raims gem. Install it in your application's environment:

Shell
gem install raims

The SDK requires Ruby 3.3 or later and provides resource services, typed responses, cursor pagination, and webhook verification. The require 'raims' statement stays the same if you installed the gem from GitHub.

For applications using Bundler, add gem 'raims' to Gemfile and run bundle install. To update an existing dependency, use bundle update raims; for installations managed directly through RubyGems, use gem update raims. Test the flows used by your integration before updating the application.

Keep your API key in the backend. The validated credential continues to determine company, environment, and permissions. Read the Ruby SDK guide to install, configure the client, and receive webhooks.