SignBolt Ruby SDK

# Rails config/initializers/signbolt.rb
SignBolt.configure do |config|
  config.api_key = Rails.application.credentials.signbolt[:api_key]
  config.webhook_secret = Rails.application.credentials.signbolt[:webhook_secret]
  config.timeout = 30
  config.max_retries = 3
end

# Or in plain Ruby
require 'signbolt'

client = SignBolt::Client.new(
  api_key: ENV.fetch('SIGNBOLT_API_KEY'),
  base_url: 'https://signbolt.au/api/v1', # default
  timeout: 30,
  max_retries: 3
)

# In a Rails service
class SignBoltService
  def self.client
    @client ||= SignBolt::Client.new(api_key: Rails.application.credentials.signbolt[:api_key])
  end
end

# Rails
# config/routes.rb
Rails.application.routes.draw do
  post '/webhooks/signbolt', to: 'webhooks#signbolt'
end

# app/controllers/webhooks_controller.rb
class WebhooksController < ApplicationController
  skip_before_action :verify_authenticity_token, only: [:signbolt]

  def signbolt
    signature = request.headers['X-SignBolt-Signature']
    body = request.raw_post

    unless SignBoltService.client.webhooks.verify(body: body, signature: signature, secret: Rails.application.credentials.signbolt[:webhook_secret])
      head :unauthorized and return
    end

    event = JSON.parse(body)

    case event['type']
    when 'document.signed'
      document_id = event['data']['documentId']
      signer = event['data']['signerEmail']
      Rails.logger.info "Document #{document_id} signed by #{signer}"
      # Update database, enqueue notification job
      ProcessSignedDocumentJob.perform_later(document_id)

    when 'document.completed'
      document_id = event['data']['documentId']
      Rails.logger.info "Document #{document_id} fully signed"
      # Download final PDF
      DownloadSignedPdfJob.perform_later(document_id)

    when 'document.declined'
      Rails.logger.info "Signer declined: #{event['data']['signerEmail']}"

    when 'document.expired'
      Rails.logger.info "Document #{event['data']['documentId']} expired"
    end

    head :ok
  end
end


# Sinatra
require 'sinatra'
require 'signbolt'
require 'json'

client = SignBolt::Client.new(api_key: ENV.fetch('SIGNBOLT_API_KEY'))
webhook_secret = ENV.fetch('SIGNBOLT_WEBHOOK_SECRET')

post '/webhooks/signbolt' do
  signature = request.env['HTTP_X_SIGNBOLT_SIGNATURE']
  body = request.body.read

  halt 401, { error: 'Invalid signature' }.to_json unless client.webhooks.verify(body: body, signature: signature, secret: webhook_secret)

  event = JSON.parse(body)

  if event['type'] == 'document.completed'
    puts "Document #{event['data']['documentId']} completed"
  end

  { received: true }.to_json
end

require 'signbolt'

client = SignBolt::Client.new(api_key: ENV.fetch('SIGNBOLT_API_KEY'))

# Recent completed documents
def get_recent_signed(client)
  page1 = client.documents.list(status: 'completed', limit: 50)

  puts "Got #{page1.data.size} documents"

  all_docs = page1.data

  while page1.next_cursor
    page1 = client.documents.list(status: 'completed', limit: 50, cursor: page1.next_cursor)
    all_docs.concat(page1.data)
  end

  all_docs
end

# Filter by date range
docs = client.documents.list(
  created_after: Time.utc(2026, 3, 1).iso8601,
  created_before: Time.utc(2026, 4, 1).iso8601,
  limit: 100
)

docs.data.each do |doc|
  puts "#{doc.filename} — signed by #{doc.signer_email} on #{doc.signed_at}"
end

# Iterate all documents using Enumerable
client.documents.list_all(status: 'completed').each do |doc|
  puts doc.filename
end