TurboDocx

https://docs.turbodocx.com
Admin
TurboDocx is a document automation platform that provides tools for template generation, document...
Tokens:93,322
Snippets:407
Trust Score:6.7
Update:11 months ago
Show doc for...
Tokens:
Raw
### Turbodocx Template Browsing Workflow Example (Node.js)

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

Demonstrates a complete workflow for browsing templates, including filtering by query and limiting results. This example showcases the integration of the `browseTemplates` function.

```javascript
const fetch = require('node-fetch');

// Configuration - Update these values
const API_TOKEN = "YOUR_API_TOKEN";
const ORG_ID = "YOUR_ORGANIZATION_ID";
const BASE_URL = "https://api.turbodocx.com";

/**
 * Step 1: Browse Templates and Folders
 */
async function browseTemplates(options = {}) {
  try {
    const {
      limit = 25,
      offset = 0,
      query = '',
      showTags = true,
      selectedTags = []
    } = options;

    // Build query parameters
    const params = new URLSearchParams({
      limit: limit.toString(),
      offset: offset.toString(),
      showTags: showTags.toString()
    });

    if (query) params.append('query', query);

    // Add selected tags (multiple values)
    selectedTags.forEach(tag => {
      params.append('selectedTags[]', tag);
    });

    const url = `${BASE_URL}/template-item?${params.toString()}`;

    const response = await fetch(url, {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${API_TOKEN}`,
        'x-rapiddocx-org-id': ORG_ID,
        'User-Agent': 'TurboDocx API Client'
      }
    });

    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }

    const result = await response.json();
    console.log(`Found ${result.data.totalRecords} templates/folders`);

    return result.data;
  } catch (error) {
    console.error('Error browsing templates:', error);
    throw error;
  }
}

// Example usage - Complete browsing workflow
async function exampleBrowsingWorkflow() {
  try {
    console.log('=== Path B: Browse and Select Template ===');

    // Step 1: Browse all templates
    console.log('\n1. Browsing templates...');
    const browseResult = await browseTemplates({
      limit: 10,
      query: 'contract',
      showTags: true
    });
    // Further processing of browseResult would go here
    console.log('Browsing complete. First 10 results for "contract":');
    console.log(browseResult.results.slice(0, 5)); // Log first 5 for brevity

  } catch (error) {
    console.error('Workflow failed:', error);
  }
}

exampleBrowsingWorkflow();

```

--------------------------------

### Quick Coordinate Example

Source: https://docs.turbodocx.com/docs/TurboSign/API%20Signatures

Example payload demonstrating the use of exact coordinates for placing signature fields instead of text anchors.

```APIDOC
## Quick Coordinate Example

### Description
This example shows a payload using exact coordinates (`x`, `y`, `width`, `height`) to define the position and size of signature fields on a document page. This is an alternative to using text anchors.

### Method
*Method not specified in the provided context, but implied to be part of a larger request (e.g., adding fields to a document).

### Endpoint
*Endpoint not specified in the provided context.*

### Request Body Example
```json
[
  {
    "recipientId": "5f673f37-9912-4e72-85aa-8f3649760f6b",
    "type": "signature",
    "page": 1,
    "x": 100,
    "y": 200,
    "width": 200,
    "height": 80,
    "pageWidth": 612,
    "pageHeight": 792
  },
  {
    "recipientId": "5f673f37-9912-4e72-85aa-8f3649760f6b",
    "type": "date",
    "page": 1,
    "x": 350,
    "y": 300,
    "width": 150,
    "height": 30,
    "pageWidth": 612,
    "pageHeight": 792
  }
]
```

### Request Body Fields
- **recipientId** (string) - The ID of the recipient for whom the field is intended.
- **type** (string) - The type of field (e.g., `signature`, `date`).
- **page** (integer) - The page number where the field should be placed (1-based).
- **x** (number) - The x-coordinate of the top-left corner of the field.
- **y** (number) - The y-coordinate of the top-left corner of the field.
- **width** (number) - The width of the field.
- **height** (number) - The height of the field.
- **pageWidth** (number) - The total width of the page.
- **pageHeight** (number) - The total height of the page.

```

--------------------------------

### Example: Generate and Download a Deliverable using JavaScript

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

Demonstrates the complete workflow of generating a complex deliverable and then downloading it. This example utilizes `generateDeliverable` and `downloadDeliverable` functions, requiring `templateId` and `deliverableData` as inputs.

```javascript
/**
 * Example usage with realistic data
 */
async function exampleGenerateDeliverable() {
  try {
    // This would come from either Path A (upload) or Path B (browse/select)
    const templateId = "0b1099cf-d7b9-41a4-822b-51b68fd4885a";

    const deliverableData = {
      name: "Employee Contract - John Smith",
      description: "Employment contract for new senior software engineer",
      variables: createComplexVariables(),
      tags: ["hr", "contract", "employee", "engineering"],
      fonts: '[{"name":"Arial","usage":269}]',
      defaultFont: "Arial",
      replaceFonts: true,
      metadata: {
        sessions: [
          {
            id: "cf1cd4b9-6fdc-47e3-b59d-594cd6564501",
            starttime: "2024-01-15T14:12:10.721Z",
            endtime: "2024-01-15T14:13:45.724Z"
          }
        ],
        createdBy: "HR Department",
        documentType: "Employment Contract",
        version: "v1.0"
      }
    };

    console.log('=== Final Step: Generate Deliverable ===');
    const deliverable = await generateDeliverable(templateId, deliverableData);

    // Download the generated file
    console.log('
=== Download Generated File ===');
    await downloadDeliverable(deliverable.id, `${deliverable.name}.docx`);

    return deliverable;

  } catch (error) {
    console.error('Deliverable generation failed:', error.message);
  }
}
```

--------------------------------

### TurboDocx Upload New Template Response Example

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

Provides an example of the successful response when a new template is uploaded and created via the TurboDocx API. It includes details about the uploaded template, such as its name, description, fonts, and a unique identifier.

```json
{
  "data": {
    "results": {
      "template": {
        "name": "Employee Contract Template",
        "description": "Standard employee contract with variable placeholders",
        "fonts": [
          {
            "name": "Arial",
            "usage": 269
          },
          {
            "name": "Calibri",
            "usage": 45
          }
        ],
        "defaultFont": "Arial",
        "orgId": "2d66ecf0-a749-475d-9403-9956d0f67884",
        "createdBy": "9d829e80-1135-4a97-93ea-cc2a1eecc9da",
        "createdOn": "2025-09-19T15:45:47.000Z",
        "updatedOn": "2025-09-19T15:45:47.000Z",
        "isActive": 1,
        "id": "31cc4cce-4ed7-4f3b-aa80-0b9a4f995412",
        "variables": null,
        "projectspaceId": null,
        "templateFolderId": null,
        "metadata": null
      },
      "redirectUrl": "/templates/31cc4cce-4ed7-4f3b-aa80-0b9a4f995412/generate"
    }
  }
}
```

--------------------------------

### Effective AI Prompt Examples (Python)

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/ai-variable-generation

These examples illustrate effective AI prompt engineering for generating specific and context-rich outputs. They demonstrate how to provide clear instructions, context, format requirements, tone, and audience specifications to improve the quality of AI-generated content. These prompts can be used with various AI services.

```python
# Good prompt  
aiHint=Generate a professional project timeline with 5 key milestones, including dates, deliverables, and success criteria for a 6-month software development project

# Poor prompt  
aiHint=make a timeline
```

```python
# Good prompt  
aiHint=Create an executive summary in bullet point format highlighting Q4 revenue (target: $2M), customer acquisition metrics, and year-over-year growth percentages

# Poor prompt  
aiHint=summarize the data
```

```python
# Good prompt  
aiHint=Write a formal, executive-level summary suitable for board presentation, focusing on strategic implications and ROI metrics

# Poor prompt  
aiHint=write a summary
```

```python
'aiHint=Acting as a senior financial analyst, review the quarterly data and provide insights on revenue trends, cost optimization opportunities, and market positioning recommendations'
```

```python
'aiHint=Generate a risk assessment with three sections: 1) High-priority risks with mitigation strategies, 2) Medium-priority risks with monitoring plans, 3) Risk summary and overall assessment'
```

```python
'aiHint=Based on the attached sales data, calculate month-over-month growth rates, identify top-performing products, and recommend strategies for underperforming segments'
```

--------------------------------

### Get Templates and Folders using cURL

Source: https://docs.turbodocx.com/docs/API/get-templates-and-folders

This snippet demonstrates how to fetch templates and folders using a cURL command. It makes a GET request to the /template-item endpoint with specified headers for authentication and content negotiation.

```cURL
curl -L -X GET 'https://api.turbodocx.com/template-item' \
-H 'Accept: application/json'
```

--------------------------------

### Example Usage: TemplateWorkflowManager (JavaScript)

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

This section demonstrates how to instantiate and use the `TemplateWorkflowManager` class. It shows how to call different demo workflows like `demoPathB`, `demoPathA` (commented out, requires a file path), and `demoComparison` (commented out). The code is executed directly when the script is run.

```javascript
const workflow = new TemplateWorkflowManager(API_TOKEN, ORG_ID, BASE_URL);

  try {
    // Demo Path B (Browse existing templates)
    await workflow.demoPathB();

    // Uncomment to demo Path A (requires template file):
    // await workflow.demoPathA('./path/to/your/template.docx');

    // Uncomment to run full comparison:
    // await workflow.demoComparison();

  } catch (error) {
    console.error('Workflow demo failed:', error.message);
  }
}

// Export for use in other modules
module.exports = {
  TemplateWorkflowManager
};

// Run examples if script is executed directly
if (require.main === module) {
  runExamples();
}
```

--------------------------------

### GET /template-item

Source: https://docs.turbodocx.com/docs/API/get-templates-and-folders

Retrieves a list of templates and folders from Turbodocx. Supports filtering and pagination via query parameters.

```APIDOC
## GET /template-item

### Description
Retrieves a list of templates and folders. This endpoint allows you to fetch items from your Turbodocx account, supporting optional query parameters for filtering and pagination.

### Method
GET

### Endpoint
/template-item

### Query Parameters
- **limit** (integer) - Optional - The maximum number of items to return.
- **showTags** (boolean) - Optional - If true, includes tags associated with the items.

### Headers
- **x-rapiddocx-org-id** (string) - Required - Your organization ID.
- **authorization** (string) - Required - Your API key or token.
- **accept** (string) - Optional - Specifies the desired response format, e.g., `application/json`.
- **accept-language** (string) - Optional - Specifies the preferred language for the response.
- **dnt** (integer) - Optional - Do Not Track setting.
- **if-none-match** (string) - Optional - Used for caching purposes.
- **origin** (string) - Optional - The origin of the request.
- **referer** (string) - Optional - The referer URL.

### Request Example
```json
{
  "example": "curl -L -X GET 'https://api.turbodocx.com/template-item' \n-H 'Accept: application/json' \n-H 'Authorization: Bearer YOUR_API_KEY' \n-H 'X-Rapiddocx-Org-Id: YOUR_ORG_ID'"
}
```

### Response
#### Success Response (200)
- **items** (array) - A list of template and folder objects.
  - **id** (string) - The unique identifier for the item.
  - **name** (string) - The name of the template or folder.
  - **type** (string) - The type of the item (e.g., 'template', 'folder').
  - **tags** (array) - A list of tags associated with the item (if `showTags` is true).

#### Response Example
```json
{
  "example": "{\n  \"items\": [\n    {\n      \"id\": \"tpl_abc123\",\n      \"name\": \"Invoice Template\",\n      \"type\": \"template\",\n      \"tags\": [\"finance\", \"billing\"]\n    },\n    {\n      \"id\": \"folder_xyz789\",\n      \"name\": \"Financial Documents\",\n      \"type\": \"folder\"\n    }\n  ]\n}"
}
```
```

--------------------------------

### GET /template/{TemplateID}

Source: https://docs.turbodocx.com/docs/API/get-template-by-id

Retrieves a specific template using its unique ID. This endpoint is useful for fetching template details for further processing or display.

```APIDOC
## GET /template/{TemplateID}

### Description
Retrieves a specific template using its unique ID.

### Method
GET

### Endpoint
/template/{TemplateID}

### Parameters
#### Path Parameters
- **TemplateID** (string) - Required - The unique identifier of the template.

#### Query Parameters
- **showTags** (boolean) - Optional - If true, includes tags in the response.

#### Headers
- **authorization** (string) - Required - Authentication token.
- **x-rapiddocx-org-id** (string) - Required - Organization ID.
- **accept** (string) - Optional - Acceptable response content types (e.g., application/json).
- **accept-language** (string) - Optional - Preferred language for the response.
- **dnt** (boolean) - Optional - Do Not Track header.
- **if-none-match** (string) - Optional - Used for caching.
- **origin** (string) - Optional - Originating request URL.
- **referer** (string) - Optional - Referer URL.

### Request Example
```json
{
  "example": "curl -L -X GET 'https://api.turbodocx.com/template/:TemplateID' \
-H 'Accept: application/json'"
}
```

### Response
#### Success Response (200)
- **templateId** (string) - The ID of the template.
- **templateName** (string) - The name of the template.
- **content** (string) - The content of the template.

#### Response Example
```json
{
  "templateId": "tpl_123abc",
  "templateName": "Invoice Template",
  "content": "<html><body><h1>Invoice</h1><p>Date: {{date}}</p></body></html>"
}
```
```

--------------------------------

### Debugging Tips

Source: https://docs.turbodocx.com/docs/TurboSign/API%20Signatures

A list of debugging tips to help troubleshoot integration issues, including logging, step-by-step testing, using tools like Postman, network checks, and JSON validation.

```APIDOC
## Debugging Tips

  1. **Enable request logging**: Log all API requests and responses
  2. **Test step by step**: Isolate issues by testing each step individually
  3. **Use Postman**: Import examples and test manually before coding
  4. **Check network**: Verify connectivity to `turbodocx.com`
  5. **Validate JSON**: Ensure request bodies are valid JSON format
```

--------------------------------

### List Templates with Query Parameters

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

This example demonstrates how to list templates using query parameters for filtering and pagination. It supports parameters like limit, offset, query string, and tag selection. The response includes a list of templates and folders, along with the total number of records.

```URL
?limit=25&offset=0&query=contract&showTags=true&selectedTags[]=tag-123
```

--------------------------------

### Financial Report Analysis Example

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/ai-variable-generation

Example demonstrating how to generate an executive summary from a quarterly financial spreadsheet using a cURL request.

```APIDOC
## POST /ai/generate-with-file (Financial Report Analysis Example)

### Description
This example shows how to use the `/ai/generate-with-file` endpoint to generate an executive summary from a quarterly financial spreadsheet. It includes uploading the file and providing metadata for sheet selection.

### Method
POST

### Endpoint
https://api.turbodocx.com/ai/generate/variable/one

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **FileResource-[id]** (file) - Required - The Excel file containing the financial data.
- **fileResourceMetadata** (string) - Required - JSON string with metadata for the file, e.g., `{"12345":{"selectedSheet":"Summary","hasMultipleSheets":true}}`.
- **name** (string) - Required - Name for the generated variable, e.g., 'Financial Performance Summary'.
- **placeholder** (string) - Required - Placeholder for the generated content, e.g., '{FinancialSummary}'.
- **aiHint** (string) - Required - Instruction for AI, e.g., 'Create a concise executive summary highlighting revenue growth, profit margins, and key financial metrics from the Q4 data'.
- **richTextEnabled** (boolean) - Optional - Set to `true` for rich text output.

### Request Example
```bash
curl 'https://api.turbodocx.com/ai/generate/variable/one' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'x-rapiddocx-org-id: YOUR_ORG_ID' \
  -H 'Content-Type: multipart/form-data' \
  -F 'FileResource-12345=@Q4-financials.xlsx' \
  -F 'fileResourceMetadata={"12345":{"selectedSheet":"Summary","hasMultipleSheets":true}}' \
  -F 'name=Financial Performance Summary' \
  -F 'placeholder={FinancialSummary}' \
  -F 'aiHint=Create a concise executive summary highlighting revenue growth, profit margins, and key financial metrics from the Q4 data' \
  -F 'richTextEnabled=true'
```

### Response
#### Success Response (200)
- **generatedContent** (string) - The generated executive summary.

#### Response Example
```json
{
  "generatedContent": "Executive summary of Q4 financial performance..."
}
```
```

--------------------------------

### Demo Full Workflow Comparison (JavaScript)

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

This function orchestrates a comparison between 'Path A' and 'Path B' workflows. It logs the start of the demo and attempts to run both paths, handling potential errors. Note that 'Path A' requires a template file to be provided.

```javascript
async demoComparison() {
    console.log('🚀 DEMO: Complete Workflow Comparison');
    console.log('====================================\n');

    try {
      console.log('Testing both paths with the same template type...\n');

      // Run Path B first (browse existing)
      const pathBResult = await this.demoPathB();

      console.log('\n' + '='.repeat(60) + '\n');

      // For Path A, we'd need a template file
      console.log('📝 Path A requires a template file to upload.');
      console.log('   Example: await workflow.demoPathA("./contract-template.docx")');

      return { pathB: pathBResult };

    } catch (error) {
      console.error('Demo comparison failed:', error.message);
    }
  }
```

--------------------------------

### Contract Key Terms Extraction Example

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/ai-variable-generation

Example demonstrating extraction of key terms and dates from a legal document using a cURL request.

```APIDOC
## POST /ai/generate-with-file (Contract Key Terms Extraction Example)

### Description
This example demonstrates extracting key terms and dates from a legal document (PDF in this case) using the `/ai/generate-with-file` endpoint. It shows how to specify the AI's task and the desired output format.

### Method
POST

### Endpoint
https://api.turbodocx.com/ai/generate/variable/one

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **FileResource-[id]** (file) - Required - The document file (e.g., PDF, DOCX).
- **name** (string) - Required - Name for the generated variable, e.g., 'Contract Terms'.
- **placeholder** (string) - Required - Placeholder for the generated content, e.g., '{ContractTerms}'.
- **aiHint** (string) - Required - Instruction for AI, e.g., 'Extract contract duration, payment terms, key obligations, and important deadlines in a structured format'.
- **richTextEnabled** (boolean) - Optional - Set to `false` for plain text output in this example.

### Request Example
```bash
curl 'https://api.turbodocx.com/ai/generate/variable/one' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'x-rapiddocx-org-id: YOUR_ORG_ID' \
  -H 'Content-Type: multipart/form-data' \
  -F 'FileResource-67890=@service-agreement.pdf' \
  -F 'name=Contract Terms' \
  -F 'placeholder={ContractTerms}' \
  -F 'aiHint=Extract contract duration, payment terms, key obligations, and important deadlines in a structured format' \
  -F 'richTextEnabled=false'
```

### Response
#### Success Response (200)
- **generatedContent** (string) - The extracted key terms and dates.

#### Response Example
```json
{
  "generatedContent": "Contract Duration: 5 years\nPayment Terms: Net 30\nKey Obligations: ...\nImportant Deadlines: ..."
}
```
```

--------------------------------

### Get Template Details

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

Retrieves detailed information for a specific template using its ID. It makes a GET request to the '/template/{templateId}' endpoint and logs the number of variables and the default font.

```javascript
async getTemplateDetails(templateId) {
    const response = await fetch(`${this.baseUrl}/template/${templateId}`, {
      method: 'GET',
      headers: this.headers
    });

    if (!response.ok) {
      throw new Error(`Template details failed: ${response.status}`);
    }

    const result = await response.json();
    const template = result.data.results;

    console.log(`📊 Variables: ${template.variables.length}`);
    console.log(`🔤 Default font: ${template.defaultFont || 'N/A'}`);

    return template;
  }
```

--------------------------------

### Get Template by ID using cURL

Source: https://docs.turbodocx.com/docs/API/get-template-by-id

This snippet demonstrates how to retrieve a template by its ID using a cURL request. It specifies the HTTP method, URL, and required headers.

```bash
curl -L -X GET 'https://api.turbodocx.com/template/:TemplateID' \
-H 'Accept: application/json'
```

--------------------------------

### Webhooks - The Next Logical Step

Source: https://docs.turbodocx.com/docs/TurboSign/API%20Signatures

Information on setting up webhooks for real-time notifications about document signing status, eliminating the need for polling.

```APIDOC
## Next Steps

### Webhooks - The Next Logical Step
Now that you've integrated the basic signing flow, the next step is setting up webhooks to receive real-time notifications when documents are signed. This eliminates the need for polling and provides instant updates about document status changes.

📖 **Learn how to configure Webhooks →**
```

--------------------------------

### TurboDocx Upload New Template Request Body Example

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

Illustrates the structure of the request body for uploading a new template file to TurboDocx. It includes the template file itself (as binary data) and metadata such as name, description, and optional tags.

```json
{
  "templateFile": [DOCX_OR_PPTX_FILE_BINARY],
  "name": "Employee Contract Template",
  "description": "Standard employee contract with variable placeholders",
  "variables": "[]",
  "tags": "[]"
}
```

--------------------------------

### Configure Wrike Webhook for Document Generation

Source: https://docs.turbodocx.com/docs/Integrations/Wrike

This example shows how to construct a Wrike API URL to set up a webhook. The webhook is configured to listen for 'ProjectStatusChanged' and 'TaskStatusChanged' events, recursively monitor subfolders, and send notifications to a specified hook URL with a secret for verification.

```url
https://www.wrike.com/api/v4/folders/IEAAAAAI4567890/webhooks?events=[ProjectStatusChanged,TaskStatusChanged]&recursive=true&hookUrl=https://api.turbodocx.com/integrations/wrike/webhook/StatusTriggeredWorkflow/abc123-org-id/def456-template-id&secret=TDX-12345
```

--------------------------------

### Template ID Extraction Example

Source: https://docs.turbodocx.com/docs/Integrations/Wrike

This example demonstrates how to extract the Template ID from a TurboDocx template URL. The Template ID is crucial for configuring the integration between Wrike and TurboDocx.

```text
URL: https://app.turbodocx.com/templates/bad30fa3-cf34-440f-8029-3410d2ff52e6  
Template ID: bad30fa3-cf34-440f-8029-3410d2ff52e6
```

--------------------------------

### Demo Path B: Browse Existing Template Workflow (JavaScript)

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

This function demonstrates the 'Path B' workflow, which involves browsing existing templates and generating a document. It is an asynchronous function that takes a template type and a generation description as input.

```javascript
async demoPathB() {
    console.log('🚀 DEMO: Path B - Browse Existing Template Workflow');
    console.log('=================================================\n');

    return await this.pathB_BrowseAndGenerate(
      'contract',
      'Contract Generated via Path B - Browse & Select'
    );
  }
```

--------------------------------

### Get Template PDF Preview Link

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

Generates and retrieves a link for a PDF preview of a specified template. It makes a GET request to the '/template/{templateId}/previewpdflink' endpoint and logs the availability of the preview link.

```javascript
async getTemplatePDFPreview(templateId) {
    const response = await fetch(`${this.baseUrl}/template/${templateId}/previewpdflink`, {
      method: 'GET',
      headers: this.headers
    });

    if (!response.ok) {
      throw new Error(`PDF preview failed: ${response.status}`);
    }

    const result = await response.json();
    console.log(`🖼️  PDF Preview available: ${result.results}`);

    return result.results;
  }
```

--------------------------------

### Get Template PDF Preview Link API Endpoint

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

This GET request generates a temporary link to a PDF preview of a specific template. It requires the template ID as a path parameter. The response contains a single URL for the preview.

```HTTP
GET https://api.turbodocx.com/template/{templateId}/previewpdflink
```

--------------------------------

### Create Webhook API Key

Source: https://docs.turbodocx.com/docs/Integrations/Wrike

Instructions for creating a specific API key named `wrikewebhook` within TurboDocx settings, used for secure webhook verification.

```APIDOC
## Create Webhook API Key

### Description
Generate a dedicated API key within TurboDocx, named `wrikewebhook`, to secure communication between Wrike and TurboDocx via webhooks.

### Steps
1. Navigate to **Settings → Organization Settings** in TurboDocx.
2. Select "API Keys" from the left sidebar.
3. Click "Create New API Key".
4. Set the API key name to exactly `wrikewebhook` (all lowercase, no spaces or dashes).
5. Select a role: "Contributor" (recommended) or "User".
6. Click "Create" and copy the generated API key. Store it securely.
```

--------------------------------

### Create Image Variable (Folder) - CURL Example

Source: https://docs.turbodocx.com/docs/API/create-image-variable-folder

Example of how to create an image variable using a cURL request. This involves sending a POST request to the /Variable endpoint with a JSON payload specifying the variable's properties.

```curl
curl -L -X POST 'https://api.turbodocx.com/Variable' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{  
  "name": "string",  
  "description": "string",  
  "tags": [  
    "string"  
  ],  
  "placeholder": "string",  
  "text": "string",  
  "mimeType": "string",  
  "allowRichTextInjection": true  
}'
```

--------------------------------

### TurboSign API Overview

Source: https://docs.turbodocx.com/docs/TurboSign/API%20Signatures

The TurboSign API follows a simple 3-step process to prepare documents for electronic signatures: Upload Document, Add Recipients, and Prepare for Signing.

```APIDOC
## TurboSign API Integration

This comprehensive guide walks you through the TurboSign API integration process. Learn how to programmatically upload documents, add recipients, and prepare documents for electronic signatures using our RESTful API.

### Overview
The TurboSign API follows a simple 3-step process to prepare documents for electronic signatures:
  1. **Upload Document** - Upload your PDF document to TurboSign
  2. **Add Recipients** - Configure who needs to sign and their signing order
  3. **Prepare for Signing** - Set up signature fields and send for signing

### Key Features
  * **RESTful API** : Standard HTTP methods with JSON payloads
  * **Bearer Token Authentication** : Secure API access using JWT tokens
  * **Multiple Recipients** : Support for multiple signers with custom signing order
  * **Flexible Field Placement** : Position signature fields using anchors or coordinates
  * **Real-time Status Updates** : Track document status throughout the signing process
  * **Webhook Integration** : Receive notifications when signing is complete

### Available Field Types
| Type      | Description                       | Use Case                     |
|-----------|-----------------------------------|------------------------------|
| `signature` | Electronic signature field        | Legal signatures             |
| `initial`   | Initial field                     | Document initials, paragraph acknowledgments |
| `date`      | Date picker field                 | Signing date, agreement date |
| `full_name` | Full name field                   | Automatically fills signer's complete name |
| `first_name`| First name field                  | Automatically fills signer's first name |
| `last_name` | Last name field                   | Automatically fills signer's last name |
| `title`     | Title/job title field             | Professional title or position |
| `company`   | Company name field                | Organization or company name |
| `email`     | Email address field               | Signer's email address       |
| `text`      | Generic text input field          | Custom text, notes, or any other text input |
```

--------------------------------

### Create Wrike Webhook via Postman

Source: https://docs.turbodocx.com/docs/Integrations/Wrike

Detailed instructions on how to create a Wrike webhook using Postman, specifying events, recursion, the TurboDocx hook URL, and the secret API key.

```APIDOC
## Create Wrike Webhook via Postman

### Description
Use Postman to create a webhook in a specific Wrike folder. This webhook will notify TurboDocx of specified event changes (e.g., status changes) within that folder and its subfolders.

### Method
POST

### Endpoint
`https://www.wrike.com/api/v4/folders/{WRIKE_FOLDER_ID}/webhooks`

### Parameters
#### Path Parameters
- **WRIKE_FOLDER_ID** (string) - Required - The ID of the Wrike folder to monitor (obtained in Step 3B).

#### Query Parameters
- **events** (string) - Required - The Wrike events to monitor. Use `[ProjectStatusChanged,TaskStatusChanged]` for TurboDocx.
- **recursive** (boolean) - Required - Set to `true` to monitor all tasks within the folder and its subfolders.
- **hookUrl** (string) - Required - The TurboDocx webhook endpoint: `https://api.turbodocx.com/integrations/wrike/webhook/StatusTriggeredWorkflow/{YOUR_ORG_ID}/{YOUR_TEMPLATE_ID}`.
- **secret** (string) - Required - Your `wrikewebhook` API key from TurboDocx (obtained in Step 2D).

### Authentication
- Type: Bearer Token
- Token: Your Wrike API token (from Step 2A).

### Request Example (with placeholders)
```
POST https://www.wrike.com/api/v4/folders/IEAAAAAAI4567890/webhooks?events=%5BProjectStatusChanged%2CTaskStatusChanged%5D&recursive=true&hookUrl=https://api.turbodocx.com/integrations/wrike/webhook/StatusTriggeredWorkflow/YOUR_ORG_ID/YOUR_TEMPLATE_ID&secret=YOUR_WRIKE_WEBHOOK_API_KEY
```

### Note
Replace `{WRIKE_FOLDER_ID}`, `{YOUR_ORG_ID}`, `{YOUR_TEMPLATE_ID}`, and `{YOUR_WRIKE_WEBHOOK_API_KEY}` with your actual values. Ensure the `secret` parameter uses the exact `wrikewebhook` API key.
```

--------------------------------

### Get Template Details API Endpoint

Source: https://docs.turbodocx.com/docs/TurboDocx%20Templating/API%20Templates

This GET request retrieves detailed information for a specific template using its ID. The response includes the template's metadata, such as name, description, file type, parent folder, associated variables with their placeholders, fonts used, and the default font.

```HTTP
GET https://api.turbodocx.com/template/{templateId}
```

--------------------------------

### Create Deliverable using cURL

Source: https://docs.turbodocx.com/docs/API/create-deliverable

Demonstrates how to create a deliverable by sending a POST request to the /deliverable endpoint using cURL. Requires 'Content-Type' and 'Accept' headers, along with a JSON payload specifying template details and variables.

```bash
curl -L -X POST 'https://api.turbodocx.com/deliverable' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{  
  "templateId": "TemplateID",  
  "name": "SOW for Waystar Royco",  
  "description": "hello",  
  "variables": [  
    {  
      "mimeType": "text",  
      "name": "VersionNumber",  
      "placeholder": "VersionNumber",  
      "text": "1.0",  
      "allowRichTextInjection": 0,  
      "autogenerated": true,  
      "count": 1,  
      "order": 4,  
      "subvariables": []  
    }  
  ],  
  "tags": []  
}'
```
Tokens:
Raw