PandaDoc
Create, list, and send documents with PandaDoc.
On this page
Connect
Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.
- In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
- For every project in a workspace: Workspace settings, Integrations.
- Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.
Call it from a workflow
Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.
// .workflow.js (native ctx)
export async function run(ctx) {
const res = await ctx.integrations.invoke("pandadoc", "createAttachment", {
"document_id": "<document_id>",
"source": "<file url>"
});
if (!res.success) throw new Error(res.error);
ctx.log.info("PandaDoc answered", { output: res.output });
}// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";
export default defineWorkflow({
id: "pandadoc-createattachment",
name: "PandaDoc: Create Attachment",
description: "Calls PandaDoc when a row is created.",
trigger: { type: "entity_event", entity: "tickets", event: "created" },
async run(ctx, event) {
const res = await ctx.integrations.call("pandadoc", {
"action": "createAttachment",
"document_id": "<document_id>",
"source": "<file url>"
}) as { success: boolean; error?: string };
if (!res.success) throw new Error(res.error);
},
});curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/pandadoc/createAttachment" \
-H "Authorization: Bearer $APP_KEY" \
-H "content-type: application/json" \
-d '{"props":{"document_id":"<document_id>","source":"<file url>"}}'Actions
createAttachmentin catalog
Create Attachment. Adds an attachment to a document.
| Input | Type | Description |
|---|---|---|
document_idrequired | id (picked from your account) | Select a document from your PandaDoc workspace |
sourcerequired | text | URL link to the file to be attached to the document |
nameoptional | text | Optional name to set for the uploaded file. |
createDocumentFromTemplatein catalog
Create Document from Template. Creates a document from a PandaDoc Template.
| Input | Type | Description |
|---|---|---|
template_uuidrequired | id (picked from your account) | Select a template from your PandaDoc workspace |
namerequired | text | Name the document you are creating |
recipientsrequired | array | List of recipients to whom the document will be sent |
fieldsoptional | object (depends on other props) | Template Fields |
tokensoptional | array | Pass values for the variables in the template |
folder_uuidoptional | id (picked from your account) | Select a folder from your PandaDoc workspace |
tagsoptional | array | Tag the document for filtering and organization |
metadataoptional | object | Additional data in key-value format to associate with document |
createOrUpdateContactin catalog
Create or Update Contact. Creates a new or update an existing contact.
| Input | Type | Description |
|---|---|---|
contact_idoptional | id (picked from your account) | Select a contact to update. Leave empty to create a new contact. |
emailoptional | text | An email address of the contact |
first_nameoptional | text | Contact's first name |
last_nameoptional | text | Contact's last name |
companyoptional | text | Contact's company name |
job_titleoptional | one of "CEO" | "CTO" | "CFO" | "COO" | "President" | "Vice President" | "Director" | "Manager" | "Sales Manager" | "Sales Representative" | "Account Manager" | "Business Development Manager" | Select a common job title or choose "Other" to enter a custom title |
custom_job_titleoptional | text | Enter a custom job title (only used if "Other" is selected above) |
industryoptional | one of "Technology" | "Software" | "Financial Services" | "Healthcare" | "Manufacturing" | "Retail" | "E-commerce" | "Education" | "Consulting" | "Real Estate" | "Construction" | "Legal Services" | Select an industry or choose "Other" to enter a custom industry |
custom_industryoptional | text | Enter a custom industry (only used if "Other" is selected above) |
phoneoptional | text | A phone number |
countryoptional | one of "United States" | "Canada" | "United Kingdom" | "Australia" | "Germany" | "France" | "Spain" | "Italy" | "Netherlands" | "Sweden" | "Norway" | "Denmark" | Select a country or choose "Other" to enter a custom country |
custom_countryoptional | text | Enter your country name (only used if "Other" is selected above) |
stateoptional | one of "Alabama" | "Alaska" | "Arizona" | "Arkansas" | "California" | "Colorado" | "Connecticut" | "Delaware" | "Florida" | "Georgia" | "Hawaii" | "Idaho" | Select a state/province or choose "Other" to enter a custom value |
custom_stateoptional | text | Enter your state/province name (only used if "Other" is selected above) |
street_addressoptional | text | A street address |
cityoptional | text | A city name |
postal_codeoptional | text | A postal code |
downloadDocumentin catalog
Download Document. Downloads a document as PDF.
| Input | Type | Description |
|---|---|---|
document_idrequired | id (picked from your account) | Select a document from your PandaDoc workspace |
separate_filesoptional | boolean | Download document bundle as a zip archive of separate PDFs (1 file per section) |
watermark_textoptional | one of "CONFIDENTIAL" | "DRAFT" | "COPY" | "SAMPLE" | "FOR REVIEW ONLY" | "INTERNAL USE ONLY" | "PROPRIETARY" | "PRELIMINARY" | "FINAL" | "APPROVED" | "VOID" | "DUPLICATE" | Select common watermark text or choose "Custom" to enter your own |
custom_watermark_textoptional | text | Enter custom watermark text (only used if "Custom" is selected above) |
watermark_coloroptional | one of "#FF0000" | "#0000FF" | "#00FF00" | "#000000" | "#808080" | "#FF7F00" | "#800080" | "custom" | Select a watermark color or use custom HEX code |
custom_watermark_coloroptional | text | Enter a custom HEX color code (e.g., #FF5733). Only used if "Custom HEX Code" is selected above. |
watermark_font_sizeoptional | number | Font size of the watermark text |
watermark_opacityoptional | number | Opacity of the watermark (0.0 to 1.0) |
findDocumentin catalog
Find Document(s). Finds documents based various filter.
| Input | Type | Description |
|---|---|---|
qoptional | text | Search documents by name or reference number |
idoptional | text | Search for document by its specific ID |
statusoptional | one of "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | Filter documents by status |
status__neoptional | one of "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | Exclude documents with this status |
template_idoptional | id (picked from your account) | Filter by parent template (cannot be used with Form) |
form_idoptional | id (picked from your account) | Select a form from your PandaDoc workspace |
folder_uuidoptional | id (picked from your account) | Select a folder from your PandaDoc workspace |
contact_idoptional | id (picked from your account) | Select a contact from your PandaDoc workspace |
membership_idoptional | id (picked from your account) | Select a workspace member |
tagoptional | one of "contract" | "proposal" | "quote" | "invoice" | "agreement" | "nda" | "employment" | "vendor" | "client" | "urgent" | "priority" | "review" | Select a common tag or choose "Custom" to enter your own |
custom_tagoptional | text | Enter a custom tag (only used if "Custom" is selected above) |
created_fromoptional | date-time (ISO) | Include only documents created on or after this date |
created_tooptional | date-time (ISO) | Include only documents created before this date |
completed_fromoptional | date-time (ISO) | Include only documents completed on or after this date |
completed_tooptional | date-time (ISO) | Include only documents completed before this date |
modified_fromoptional | date-time (ISO) | Include only documents modified on or after this date |
modified_tooptional | date-time (ISO) | Include only documents modified before this date |
deletedoptional | boolean | Return only deleted documents |
countoptional | number | Number of documents to return (default: 50, max: 100) |
pageoptional | number | Page number for pagination (starts with 1) |
getDocumentAttachmentsin catalog
Get Document Attachment. Retrieves details of a specific attachment from a document.
| Input | Type | Description |
|---|---|---|
document_idrequired | id (picked from your account) | Select a document from your PandaDoc workspace |
attachment_idrequired | id (picked from your account) | Select an attachment from the document |
custom_api_call
Custom API Call. Make a custom API call to a specific endpoint
| Input | Type | Description |
|---|---|---|
urlrequired | object (depends on other props) | url |
methodrequired | one of "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD" | Method |
headersrequired | object | Authorization headers are injected automatically from your connection. |
queryParamsrequired | object | Query Parameters |
body_typeoptional | one of "none" | "json" | "form_data" | "raw" | Body Type |
bodyoptional | object (depends on other props) | Body |
response_is_binaryoptional | boolean | Enable for files like PDFs, images, etc. |
failsafeoptional | boolean | No Error on Failure |
timeoutoptional | number | Timeout (in seconds) |
followRedirectsoptional | boolean | Follow redirects |
getDocumentDetails
Get Document. Retrieves comprehensive document data.
| Input | Type | Description |
|---|---|---|
document_idrequired | id (picked from your account) | Select a document from your PandaDoc workspace |
Details
- Id
pandadoc- Category
- Other
- Tags
- documents, proposals, contracts, e-signature
- Package
@activepieces/piece-pandadoc@0.1.4- Tier
- Community