Skip Navigation
Show nav
Dev Center
  • Get Started
  • Documentation
  • Changelog
  • Search
  • Get Started
    • Node.js
    • Ruby on Rails
    • Ruby
    • Python
    • Java
    • PHP
    • Go
    • Scala
    • Clojure
    • .NET
  • Documentation
  • Changelog
  • More
    Additional Resources
    • Home
    • Elements
    • Products
    • Pricing
    • Careers
    • Help
    • Status
    • Events
    • Podcasts
    • Compliance Center
    Heroku Blog

    Heroku Blog

    Find out what's new with Heroku on our blog.

    Visit Blog
  • Log inorSign up
Hide categories

Categories

  • Heroku Architecture
    • Compute (Dynos)
      • Dyno Management
      • Dyno Concepts
      • Dyno Behavior
      • Dyno Reference
      • Dyno Troubleshooting
    • Stacks (operating system images)
    • Networking & DNS
    • Platform Policies
    • Platform Principles
  • Developer Tools
    • Command Line
    • Heroku VS Code Extension
  • Deployment
    • Deploying with Git
    • Deploying with Docker
    • Deployment Integrations
  • Continuous Delivery & Integration (Heroku Flow)
    • Continuous Integration
  • Language Support
    • Node.js
      • Troubleshooting Node.js Apps
      • Working with Node.js
      • Node.js Behavior in Heroku
    • Ruby
      • Rails Support
      • Working with Bundler
      • Working with Ruby
      • Ruby Behavior in Heroku
      • Troubleshooting Ruby Apps
    • Python
      • Working with Python
      • Background Jobs in Python
      • Python Behavior in Heroku
      • Working with Django
    • Java
      • Java Behavior in Heroku
      • Working with Java
      • Working with Maven
      • Working with Spring Boot
      • Troubleshooting Java Apps
    • PHP
      • Working with PHP
      • PHP Behavior in Heroku
    • Go
      • Go Dependency Management
    • Scala
    • Clojure
    • .NET
      • Working with .NET
  • Databases & Data Management
    • Heroku Postgres
      • Postgres Basics
      • Postgres Getting Started
      • Postgres Performance
      • Postgres Data Transfer & Preservation
      • Postgres Availability
      • Postgres Special Topics
      • Migrating to Heroku Postgres
    • Heroku Key-Value Store
    • Apache Kafka on Heroku
    • Other Data Stores
  • AI
    • Working with AI
    • Heroku Inference
      • Inference API
      • Quick Start Guides
      • Inference Essentials
      • AI Models
    • Vector Database
    • Model Context Protocol
  • Monitoring & Metrics
    • Logging
  • App Performance
  • Add-ons
    • All Add-ons
  • Collaboration
  • Security
    • App Security
    • Identities & Authentication
      • Single Sign-on (SSO)
    • Private Spaces
      • Infrastructure Networking
    • Compliance
  • Heroku Enterprise
    • Enterprise Accounts
    • Enterprise Teams
    • Heroku Connect (Salesforce sync)
      • Heroku Connect Administration
      • Heroku Connect Reference
      • Heroku Connect Troubleshooting
  • Patterns & Best Practices
  • Extending Heroku
    • Platform API
    • App Webhooks
    • Heroku Labs
    • Building Add-ons
      • Add-on Development Tasks
      • Add-on APIs
      • Add-on Guidelines & Requirements
    • Building CLI Plugins
    • Developing Buildpacks
    • Dev Center
  • Accounts & Billing
  • Troubleshooting & Support
  • Integrating with Salesforce
  • Add-ons
  • All Add-ons
  • DocRaptor
DocRaptor

This add-on is operated by DocRaptor

Simple & Robust HTML-to-PDF Conversion

DocRaptor

Last updated October 02, 2020

Table of Contents

  • Add-on provisioning
  • Application integration
  • Document styling and API options
  • Debugging
  • Migrating between plans
  • Canceling DocRaptor
  • Support

The DocRaptor add-on converts HTML into PDF and XLS documents on the fly from your application using DocRaptor’s HTML to PDF cloud API.

DocRaptor has libraries for PHP, Python, Node.js, Ruby, Java, .NET, and JavaScript/jQuery, though any language can be used by directly implementing the HTTP API.

Add-on provisioning

DocRaptor can be attached to a Heroku application via the add-on page or via the CLI:

$ heroku addons:create docraptor
Creating docraptor on ⬢ sharp-mountain-4005... free
Created docraptor-pointy-98065 as DOCRAPTOR_API_KEY, DOCRAPTOR_URL
Use heroku addons:docs docraptor to view documentation

A list of all plans available can be found here or by running heroku addons:plans docraptor

Application integration

You can get your DocRaptor API key through the CLI:

$ heroku config:get DOCRAPTOR_API_KEY
YOUR_API_KEY_HERE

Then visit the DocRaptor documentation site to get libraries, example code, and API options for PHP, Python, Node.js, Ruby, Java, .NET, and JavaScript/jQuery. Any other language can be easily integrated directly through the REST API.

Document styling and API options

DocRaptor’s documentation site contains detailed style and formatting guides as well as a full API reference. If you’re familiar with traditional open-source HTML to PDF libraries, you may be surprised by DocRaptor’s support for advanced document features, such as page break control, varying sizes and layouts, headers and footers, and accessible PDFs. h

Debugging

Both successful and failed document requests are available within your DocRaptor dashboard. The dashboard by visiting the Heroku Dashboard and selecting the application in question, then select DocRaptor from the Add-ons menu. Alternatively, you can open the dashboard via the CLI:

$ heroku addons:open docraptor
Opening https://addons-sso.heroku.com/apps/your_app_id/addons/your_addon_id...

Most issues can be easily debugged by looking at the document error logs or by reviewing style and formatting guides. For additional assistance, contact DocRaptor support at support@docraptor.com. We’d be happy to assist you in getting the perfect document.

Migrating between plans

Use the heroku addons:upgrade CLI command to migrate to a new plan by upgrading (or downgrading):

$ heroku addons:upgrade docraptor:premium
Changing docraptor-pointy-98065 on sharp-mountain-4005 from docraptor:starter to docraptor:basic... done, $19/month
$ heroku addons:downgrade docraptor:starter
Changing docraptor-pointy-98065 on sharp-mountain-4005 from docraptor:basic to docraptor:starter... done, free

Canceling DocRaptor

You can cancel your DocRaptor plan by destroying the Heroku provisioning:

$ heroku addons:destroy docraptor
 ▸    WARNING: Destructive Action
 ▸    This command will affect the app sharp-mountain-4005
 ▸    To proceed, type sharp-mountain-4005 or re-run this command with --confirm sharp-mountain-4005

> sharp-mountain-4005
Destroying docraptor-pointy-98065 on ⬢ sharp-mountain-4005... done

Support

Billing and Heroku account issues should be submitted via one of the Heroku Support channels. All technical questions and product feedback is welcome by contacting us at support@docraptor.com. We are happy to assist with debugging your documents.

Keep reading

  • All Add-ons

Feedback

Log in to submit feedback.

Zara 4 DQE One

Information & Support

  • Getting Started
  • Documentation
  • Changelog
  • Compliance Center
  • Training & Education
  • Blog
  • Support Channels
  • Status

Language Reference

  • Node.js
  • Ruby
  • Java
  • PHP
  • Python
  • Go
  • Scala
  • Clojure
  • .NET

Other Resources

  • Careers
  • Elements
  • Products
  • Pricing
  • RSS
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku Blog
    • Heroku News Blog
    • Heroku Engineering Blog
  • Twitter
    • Dev Center Articles
    • Dev Center Changelog
    • Heroku
    • Heroku Status
  • Github
  • LinkedIn
  • © 2025 Salesforce, Inc. All rights reserved. Various trademarks held by their respective owners. Salesforce Tower, 415 Mission Street, 3rd Floor, San Francisco, CA 94105, United States
  • heroku.com
  • Legal
  • Terms of Service
  • Privacy Information
  • Responsible Disclosure
  • Trust
  • Contact
  • Cookie Preferences
  • Your Privacy Choices