Surge home page
SupportDashboard
Surge

Ruby SDK

Install and authenticate

Add to your Gemfile:

gem "surge_api"
bundle install

Set your API key:

export SURGE_API_KEY=sk_live_your_key_here
require "surge_api"

surge = SurgeAPI::Client.new

Sorbet type signatures are included for typed Ruby projects.

Your first request

message = surge.messages.create(
  "acct_01jrzhe8d9enptypyx360pcmxj",
  to: "+18015551234",
  body: "Your appointment is confirmed for Friday at 2pm."
)

puts message.id      # msg_01j...
puts message.status  # "sent"

Pagination

The SDK provides an auto-paginating enumerator:

# Iterates through all messages
surge.messages.list("acct_01j...").each do |message|
  puts "#{message.id}: #{message.status}"
end

For manual pagination:

page = surge.messages.list_page("acct_01j...", limit: 25)
page.data.each { |m| puts m.id }
puts page.pagination.next_cursor

Retries and timeouts

surge = SurgeAPI::Client.new(
  max_retries: 5,
  timeout: 30 # seconds
)

Error handling

begin
  surge.messages.create(
    "acct_01j...",
    to: "+18015551234",
    body: "Hello"
  )
rescue SurgeAPI::APIStatusError => e
  puts e.status        # 422
  puts e.error.type    # "opted_out"
  puts e.error.message
rescue SurgeAPI::AuthenticationError => e
  puts "Invalid API key"
end

Webhooks

require "surge_api/webhooks"

wh = SurgeAPI::Webhook.new(ENV["SURGE_WEBHOOK_SECRET"])

# Rails example:
class WebhooksController < ApplicationController
  skip_before_action :verify_authenticity_token

  def create
    begin
      event = wh.verify(request.raw_post, request.headers)
    rescue SurgeAPI::WebhookVerificationError
      head :bad_request and return
    end

    case event["type"]
    when "message.received"
      handle_inbound(event["data"])
    when "contact.opted_out"
      handle_opt_out(event["data"])
    end

    head :ok
  end
end