Convoy

This is the official Convoy Ruby SDK. This SDK contains methods for easily interacting with Convoy's API. Below are examples to get you started. For the full API reference, please take a look at our docs.

Installation

Add this line to your application's Gemfile:

gem 'convoy.rb'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install convoy.rb

Generated API client (ConvoyApi)

The convoy_api namespace is generated from Convoy's OpenAPI spec via OpenAPI Generator and covers the full /api/v1 surface with typed models:

require 'convoy_api'

config = ConvoyApi::Configuration.new do |c|
  c.host = 'us.getconvoy.cloud'
  c.base_path = '/api'
  c.access_token = api_key # the client adds the Bearer prefix
end
client = ConvoyApi::ApiClient.new(config)
# Pin the API version this client was generated from.
client.default_headers['X-Convoy-Version'] = '2025-11-24'

events = ConvoyApi::EventsApi.new(client)
events.create_endpoint_event(project_id, ConvoyApi::ModelsCreateEvent.new(
  endpoint_id: 'endpoint-id',
  event_type: 'invoice.paid',
  data: { 'amount' => 100, 'currency' => 'USD' }
))

Note on reading event data from responses: OpenAPI Generator's Ruby runtime stringifies only the top-level keys of freeform object fields, so nested keys arrive as symbols (event.data["nested"][:customer]). Call event.data.transform_values { ... } or a deep-stringify helper if you need uniform string keys.

Do not edit lib/convoy_api/ by hand; regenerate with ./scripts/generate.sh (CI on frain-dev/convoy dispatches this when the spec changes). The hand-written gem code below (Convoy, incl. webhook verify) is never touched by generation.

Usage

Setup Client

To configure your client, provide your base_uri, api_key and project_id, see below:

require 'convoy'

Convoy.ssl = true
Convoy.base_uri = "https://us.getconvoy.cloud/api"
Convoy.api_key = "CO.M0aBe..."
Convoy.project_id = "23b1..."

Your instance URL depends on where your project lives:

• Convoy Cloud (US): https://us.getconvoy.cloud/api
• Convoy Cloud (EU): https://eu.getconvoy.cloud/api
• Self-hosted: https://your-instance/api

Create Endpoint

An endpoint represents a target URL to receive webhook events. You should create one endpoint per user/business or whatever scope works well for you.

endpoint = Convoy::Endpoint.new(
  data: {
    "name": "default-endpoint",
    "description": "Endpoint One",
    "url": "https://example.com/webhooks/convoy"
  }
)

endpoint_response = endpoint.save

Subscribe For Events

After creating an endpoint, we need to susbcribe the endpoint to events.

subscription = Convoy::Subscription.new(
  data: {
    endpoint_id: endpoint_id,
    name: 'ruby subscription'
  }
)

subscription_response = subscription.save

Send Event

To send an event, you'll need to pass the uid from the endpoint we created earlier.

event = Convoy::Event.new(
  data: {
    endpoint_id: endpoint_id,
    event_type: "wallet.created",
    data: {
      status: "completed",
      event_type: "wallet.created",
      description: "transaction successful"
    }
  }
)

event_response = event.save

To fan an event out to all endpoints with the same owner_id, or broadcast to every endpoint in the project:

fanout_response = Convoy::Event.new(
  data: {
    owner_id: "owner-1",
    event_type: "wallet.created",
    data: { status: "completed" }
  }
).fanout

broadcast_response = Convoy::Event.new(
  data: {
    event_type: "wallet.created",
    data: { status: "completed" }
  }
).broadcast

Verify Webhook Signatures

Verify with the raw request body, before parsing it. verify returns true or false for simple signatures, and raises Convoy::SignatureVerificationError for invalid advanced signatures.

webhook = Convoy::Webhook.new("endpoint-secret")

begin
  valid = webhook.verify(request.raw_post, request.headers["X-Convoy-Signature"])
rescue Convoy::SignatureVerificationError
  valid = false
end

head :bad_request and return unless valid

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/convoy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Credits

• Frain

License

The MIT License (MIT). Please see License File for more information.