PlanRadar Connector Overview – PlanRadar HelpCenter

1 Overview

The PlanRadar Connector is a native integration available in PlanRadar Connect that provides pre-built triggers and actions for connecting PlanRadar with third-party applications. It allows you to automate workflows without writing code.

This article covers all triggers and actions available in the PlanRadar Connector, and explains how to set up the connection.

Connection Setup

To use the PlanRadar Connector, you need to configure a connection with the following three fields:

Field	Description	Where to find it
API Key	Your personal access token used to authenticate requests	PlanRadar → Profile → Access Tokens
Customer ID	Your account identifier, used to scope all API requests	PlanRadar → Profile → Access Tokens
PlanRadar URL	The base URL of your PlanRadar account (e.g. https://www.planradar.com)	Your browser's address bar when logged into PlanRadar

Note: The API key is tied to the user who generates it. All actions performed by the connector will be attributed to that user. Make sure the user has the appropriate permissions in PlanRadar for the operations the recipe will perform.

2 Triggers

Triggers define when a recipe starts. All PlanRadar Connector triggers are real-time — they react to events in PlanRadar immediately as they happen.

Trigger NameDescriptionProject Report SubmittedTriggers when a project report is submittedProjects: New, Updated, DeletedTriggers when a project is created, updated, or deletedTicket Report CreatedTriggers when a ticket report is createdTickets: New, UpdatedTriggers when a ticket is created or updated

3 Actions — Ticket & Report Management

Actions define what the recipe does once triggered. The following actions are available for managing tickets and reports.

Create Ticket — Create a new ticket with basic information.

Note: This action does not accept a project ID dynamically. To pass a dynamic project ID, use the Workato HTTP connector and call the PlanRadar API directly (see API documentation in the PlanRadar web app under Settings). Only ticket text fields accept datapills; all other fields accept static values only.
Update Ticket — Update an existing ticket.

The action requires a ticket UUID (Universally Unique Identifier), for example: 8fadcf58-eeb0-4807-830b-415660f364e9.

Note: This action does not accept a project ID dynamically. To pass a dynamic project ID, use the Workato HTTP connector and call the PlanRadar API directly (see API documentation in the PlanRadar web app under Settings). Only ticket text fields accept datapills; all other fields accept static values only.
Delete a Ticket — Delete a ticket permanently.

Note: Whether this action succeeds depends on your PlanRadar account permissions.
Fetch Ticket by ID — Get ticket data by numerical or hashed sequential ID.
Fetch Ticket by UUID — Get ticket data by UUID.
List Tickets — Fetch tickets from a project, with optional filtering.
Export Tickets of a Project (PDF/XLS/CSV) — Export tickets from a project using a predefined template and filter.

Note: PDF export supports up to 3,000 tickets. The download URL expires after 2 hours. This action cannot be run in test mode — start the recipe to test it.
Export Single Ticket to PDF — Export one ticket as a PDF.

4 Actions — Project Report Management

Load Project Report Templates — Retrieve all project report templates.
Load Filled Project Reports — Load all submitted reports for a project.

5 Actions — File Management

Add Asset to Ticket — Add an asset to a ticket by UUID.

Supported document file types: pdf, xls, xlsx, ods, csv, doc, docx, odt, dwg, dxf, eml, msg

Supported image file types: jpg, png, gif, bmp, heic
Fetch Ticket Assets by UUID — Get all attachments for a ticket.
Upload File — Upload a file to PlanRadar Documents. There is no restriction on file type.
Upload / Update Plan — Upload a PDF plan to a layer or component.
Download File — Download a file from PlanRadar Documents.
Move File/Folder to Trash — Move a document or folder to trash.
Search File/Folder — Search for a specific file or folder by name.
Create Folder — Create a new folder in PlanRadar Documents.

6 Actions — Project & Form Utilities

List Projects — Retrieve all active projects in the account.
Get Project Data — Retrieve details for a specific project.
Create Project — Create a new project in PlanRadar.
List Forms — Get all forms available for a given project.
List Layers — Retrieve all plan layers for a project.
Create Layer — Create a new layer (component) in a project without uploading a plan. Optionally assign it as a sub-layer of an existing layer.
Add User to Project — Add one or more users to a project with a specific role. Optionally enable mobile sync so the project data is available on the user's mobile device.
Add Group to Project — Add one or more groups to a project with a specific role.

7 Further Support

For more help using PlanRadar Connect and building recipes, visit the PlanRadar Help Center or refer to the Workato documentation.