Dropbox

Automatically store rendered files in your Dropbox folders

Updated Oct 27, 2026

The Orshot Dropbox integration allows you to automatically save generated files directly to your Dropbox account. When enabled, every render (images, PDFs, videos) via the API can be stored in a specified Dropbox folder, making it easy to organize, share, and access your generated content.

Connecting Dropbox#

Connecting Dropbox in Orshot

In Orshot, open Integrations from the workspace sidebar
Find Dropbox and click Connect
Authorize Orshot to access your Dropbox account
Click the gear icon on the Dropbox card and pick a folder under Save renders to

Using Dropbox in API Requests#

While Automatic saving is on in the Dropbox settings, every render is uploaded to Dropbox. You do not need to add connections to your API request.

To control the upload or set custom options, add the connections parameter to your render request.

If you send connections, Orshot uses only that list and skips the automatic uploads. A request that lists only Dropbox stops uploads to any other connected storage for that render. Send "connections": [] to skip all uploads for one render, or add "disabled": true to an entry to skip it.

JSON

{
  "templateId": 25,
  "modifications": {
    "headline": "Hello World"
  },
  "response": {
    "type": "url",
    "format": "png"
  },
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox"
    }
  ]
}

Specifying a Custom Folder#

Override the default folder by specifying a folder path:

JSON

{
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "folder": "/Marketing/Campaign-2024"
    }
  ]
}

Custom File Names#

Use response.fileName to set a custom name for the uploaded file. Orshot keeps letters, numbers, - and _ (up to 50 characters) and adds a short random suffix so files never overwrite each other, for example marketing-banner-001-Ab12C.png. Without a name, files are called orshot-<templateId>-<date>-<suffix>.<ext>.

JSON

{
  "templateId": 25,
  "modifications": { "headline": "Hello" },
  "response": {
    "type": "url",
    "format": "png",
    "fileName": "marketing-banner-001"
  },
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "folder": "/Banners"
    }
  ]
}

API Response Examples#

Successful Upload#

JSON

{
  "data": {
    "content": "https://storage.orshot.com/cloud/w-50/renders/images/abc123.png",
    "type": "url",
    "format": "png",
    "responseTime": 1234.56
  },
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "path": "/Marketing/Campaign-2024/orshot-25-2026-10-27-Ab12C.png",
      "status": "success"
    }
  ]
}

Multi-Page Upload#

When rendering multi-page templates, each page is uploaded separately:

JSON

{
  "data": [
    {
      "page": 1,
      "pageId": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "content": "https://storage.orshot.com/cloud/w-50/renders/images/abc123.png"
    },
    {
      "page": 2,
      "pageId": "b2c3d4e5-6f78-9012-bcde-f23456789012",
      "content": "https://storage.orshot.com/cloud/w-50/renders/images/def456.png"
    }
  ],
  "format": "png",
  "type": "url",
  "responseTime": 3166.01,
  "totalPages": 2,
  "renderedPages": 2,
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "path": [
        { "page": 1, "path": "/Orshot Renders/orshot-25_page_1-2026-10-27-Ab12C.png" },
        { "page": 2, "path": "/Orshot Renders/orshot-25_page_2-2026-10-27-Xy34Z.png" }
      ],
      "status": "success"
    }
  ]
}

Upload Failed (with Warning)#

Connection issues return warnings but don't block the render:

JSON

{
  "data": {
    "content": "https://storage.orshot.com/cloud/w-50/renders/images/abc123.png",
    "type": "url",
    "format": "png",
    "responseTime": 1234.56
  },
  "warnings": [
    {
      "title": "Failed to upload to dropbox: Token expired",
      "details": ""
    }
  ],
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "path": null,
      "status": "error",
      "error": "Token expired"
    }
  ]
}

Dropbox Not Connected#

JSON

{
  "data": {
    "content": "https://storage.orshot.com/cloud/w-50/renders/images/abc123.png",
    "type": "url",
    "format": "png",
    "responseTime": 1234.56
  },
  "warnings": [
    {
      "title": "Failed to upload to dropbox: Dropbox is not connected. Connect it in workspace settings.",
      "details": ""
    }
  ],
  "connections": [
    {
      "type": "storage",
      "provider": "dropbox",
      "path": null,
      "status": "error",
      "error": "Dropbox is not connected. Connect it in workspace settings."
    }
  ]
}

Connection Parameters#

Parameter	Type	Required	Description
`type`	string	No	Optional. Defaults to `"storage"`
`provider`	string	Yes	Must be `"dropbox"`
`folder`	string	No	Custom folder path. Uses default folder if not specified
`disabled`	boolean	No	Set to `true` to skip this entry

Notes#

Non-blocking: Dropbox upload failures won't block your render. You'll still get the image URL
Automatic refresh: Access tokens are automatically refreshed when they expire
Folder creation: Folders are created automatically if they don't exist
Supported formats: PNG, JPG, JPEG, WebP, AVIF, PDF, MP4, WebM, MOV, MKV, GIF

Need Help?#

Contact support at hi@orshot.com or use the chat button in your Orshot dashboard

Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key

Image, PDF and video generation via API
Visual editor with AI and smart layouts
Zapier, Make, MCP and 40+ integrations
White-label embed for your own app
100 free credits a month, no credit card required