Using Third-Party Cloud Storage

This guide explains how to integrate and use third party cloud storage (such as Google Drive, Box, Dropbox, or SharePoint/OneDrive) when creating a request via the Pigeon API.

Prerequisites

Before you begin using cloud storage with the Pigeon API, ensure that:

Your Pigeon account is connected to a third party storage provider.
You must configure your account with your chosen cloud storage provider.

Contact Support for Setup Instructions.
Reach out to our support team for detailed steps on how to connect your account. Without this configuration, API calls for setting a cloud storage folder will not function properly.

Configuring Your API Request

Once your account is connected, you can create requests that specify a cloud storage folder. In the API request body, include a property named "cloud_storage_folder" and set its value based on the specific cloud storage platform you are using.

Sample Request Body

Below is an example JSON payload for creating a request:

{
  "name": "Test Standard 3",
  "items": [
    {
      "type": "UPLOAD",
      "required": true,
      "name": "Upload"
    },
    {
      "type": "QUESTION",
      "required": false,
      "name": "Question"
    }
  ],
  "cloud_storage_folder": "<cloud storage folder id>",
  "recipients": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      "auth_method": {
        "type": "NONE"
      }
    }
  ]
}

Note: Replace <cloud storage folder id> with the appropriate value for your provider.

Cloud Storage Folder Values by Provider

The value you assign to "cloud_storage_folder" depends on your cloud storage provider:

Google Drive:
Use the folder ID from Google Drive.

Box:
Use the folder ID from Box.

Dropbox:
Set to either the path to the folder or the Dropbox folder ID.

SharePoint/OneDrive:
Use a composite string in the format:

${driveId}~${folderId}

where ${driveId} is your drive identifier and ${folderId} is the folder's unique identifier.

Best Practices and Additional Notes

Double-check the folder value:
Verify that the folder identifier or path is correctly obtained from your cloud provider.

Test your integration:
After setting up your connection and constructing your API request, run tests to ensure that files are correctly routed to the specified cloud storage folder.

Prerequisites#

Configuring Your API Request#

Sample Request Body#

Cloud Storage Folder Values by Provider#

Best Practices and Additional Notes#

Prerequisites

Configuring Your API Request

Sample Request Body

Cloud Storage Folder Values by Provider

Best Practices and Additional Notes