---
title: "TurboDocx Ruby SDK"
description: "Install and configure the TurboDocx Ruby SDK, then open the TurboSign, Deliverable, TurboWebhooks or TurboQuote guide."
url: "https://docs.turbodocx.com/docs/SDKs/ruby"
---

# TurboDocx Ruby SDK

> Install and configure the TurboDocx Ruby SDK, then open the TurboSign, Deliverable, TurboWebhooks or TurboQuote guide.

The official TurboDocx SDK for Ruby applications. Build document generation and digital signature workflows with a simple synchronous API and comprehensive error handling. Available on RubyGems as `turbodocx-sdk`.

## Installation

**gem**

```bash
gem install turbodocx-sdk
```

**Bundler**

Add to your `Gemfile`:

```ruby
gem "turbodocx-sdk"
```

Then run:

```bash
bundle install
```

## Requirements

- Ruby 2.7+
- No runtime dependencies (uses the standard library's `net/http`)

---

## Configuration

```ruby
require "turbodocx_sdk"

# Configure globally (recommended)
TurboDocxSdk::TurboSign.configure(
  api_key:      ENV["TURBODOCX_API_KEY"],   # Required: Your TurboDocx API key
  org_id:       ENV["TURBODOCX_ORG_ID"],    # Required: Your organization ID
  sender_email: "contracts@yourcompany.com", # Required: Reply-to address for signature emails
  sender_name:  "Your Company"               # Recommended: Sender name shown in emails
  # base_url:   "https://api.turbodocx.com"  # Optional: Override base URL
)
```

:::tip Authentication
Authenticate using `api_key`. API keys are recommended for server-side applications.
:::

### Environment Variables

```bash
# .env
TURBODOCX_API_KEY=your_api_key_here
TURBODOCX_ORG_ID=your_org_id_here
TURBODOCX_SENDER_EMAIL=contracts@yourcompany.com
TURBODOCX_SENDER_NAME=Your Company
```

:::warning API Credentials Required
`api_key` and `org_id` are **required** for all API requests. TurboSign additionally **requires `sender_email`** (set it on `configure`, per call, or via the `TURBODOCX_SENDER_EMAIL` environment variable): `configure` raises a `TurboDocxSdk::ValidationError` without it. `sender_name` is optional but strongly recommended. To get your credentials, follow the **[Get Your Credentials](https://docs.turbodocx.com/docs/SDKs.md#1-get-your-credentials)** steps from the SDKs main page.
:::

---

## Product guides

Each product guide opens on the Ruby tab:

- [TurboSign](https://docs.turbodocx.com/docs/SDKs/turbosign.md?language=ruby): send documents for signature, track status, download signed PDFs and audit trails
- [Deliverable](https://docs.turbodocx.com/docs/SDKs/deliverable.md?language=ruby): generate documents from templates
- [TurboWebhooks](https://docs.turbodocx.com/docs/SDKs/webhooks.md?language=ruby): receive real-time signature events
- [TurboQuote](https://docs.turbodocx.com/docs/SDKs/quote.md?language=ruby): create, send and download quotes

## Resources

- [GitHub Repository](https://github.com/TurboDocx/SDK/tree/main/packages/ruby-sdk)
- [RubyGems Package](https://rubygems.org/gems/turbodocx-sdk)
- [API Reference](https://docs.turbodocx.com/docs/TurboSign/API-Signatures.md)
- [Webhook Configuration](https://docs.turbodocx.com/docs/TurboSign/Webhooks.md)