PowerClerk Support Center

Program Design
Automations
Questions to Ask
Locating the Automations feature
How to create an Automation
Automation Triggers
Automation Action Rules
Validation Rules
Scheduled Triggers
Troubleshooting Automations
FAQs
Channels
Questions to ask yourself
Locating the Channels feature
What are Channels?
Types of Channels
Channel Type: Mark as Child
Channel Type: Make Successor
Channel Type: Create Related Project
Channel Type: Submit Related Project
Channel Type: Project Lookup
How to create a Channel
Channel Signals and Automations
Using Channels in Test Environments
FAQs
Communications
Questions to ask yourself
Locating the Communications feature
Creating Communication templates
Finding Data Tags
Bulk Communications via Data Import
Images in Communications
Project Attachments and Content Library Items
Smart Templates
Upgrading to Smart Templates
Upgrading when a Test Environment Exists
Broken Template Tags
Examples of Broken Template Tags
PowerClerk Bulk Email Communication Policy
FAQs
Connections
Questions to ask yourself
Locating the Connections feature
What are Connections
How to Create a Standard Web Adapter
Define the Standard Web Adapter
Connecting, Testing, and Enabling the Web Adapter
Creating a Standard Web Adapter Configuration
Utilizing Connections on PowerClerk
Maintaining and Editing the Web Adapter
Web Adapter Payload Type Format
Supported Message Versions
Error Handling
Custom List Lookup
Create a Custom List Lookup
Utilizing Custom List Lookup
FAQs
Content Library
Questions to ask yourself
Locating the Content Library feature
Uploading content to the Content Library
Use with Communication Templates
Use for Front Page content
FAQs
Custom API IDs
Questions to Ask
Locating the Custom API IDs feature
How to edit a Custom API ID
FAQs
Data Fields
Questions to ask yourself
Locating the Data Fields feature
How to work with Data Fields
Custom Lists and Data Field Groups
Table form element
PV System + batteries element
FAQs
Deadlines
Questions to ask yourself
Locating the Deadlines feature
What are Deadlines
How to Create a Deadline
Deadline Automation Action Rules
Utilizing Project Admin Page for Deadlines
Communication Templates for Deadlines
Deadline Set/Satisfy Options
Program-Wide Deadline Actions
Reporting on Deadlines
Deadlines in Project List Columns
FAQs
Document Templates
Questions to ask yourself
Locating the Document Templates feature
How to define a new Template
How to define a new Merged Document
eSignatures
DocuSign template tags
Mapping eSignature tags
Smart Templates
FAQs
eSignature Envelopes
Questions to Ask
Locating the eSignature Feature
What are eSignature Envelopes?
eSignature Checklist: The Prerequisites to create a new Envelope
How to set up Advanced eSignature Envelopes Step-by-Step
How to add an eSignature Envelope to a form
eSignature Automation Trigger
Viewing Completed eSignature Envelopes
Resending eSignature Notifications
Canceling eSignatures
FAQs
Forms
Questions to ask yourself
Locating the Forms feature
How to create and edit Forms
Adding data fields
Configuring Forms
VersaForms
Sensitive Data Fields
FAQs
Formulas and Calculated Fields
Questions to ask yourself
Locating the Formulas feature
How to work with Formulas and Calculated Fields
Formula Data Dictionary
Dynamic Formula References
Rules of Formula References
Advanced Visibility Rules
Video Guides: Formulas
FAQs
Front Page
Questions to ask yourself
Locating the Front Page feature
How to edit the Front Page
FAQs
Incentive Design
Questions to ask yourself
Locating the Incentive Design feature
How to create and edit Incentive Designs
Incentive Options for One-Time Incentive Type
Incentive Design Options
FAQs
Milestones
Questions to ask yourself
Locating the Milestones feature
How to define a Milestone
FAQs
Project List Columns
Questions to ask yourself
Locating the Project List Columns feature
How to use Project List Columns
FAQs
Project Summary
Questions to ask yourself
Locating the Project Summary feature
How to edit the Project Summary
FAQs
Project Views
Questions to ask yourself
Locating the Project Views feature
How to edit Project Views
FAQs
Roles
Questions to ask yourself
Locating the Roles feature
How to create and edit a Role
Access Groups
Access Groups and Automations
Access Groups and Data Imports
Access Groups and Reports
FAQs
Workflow
Questions to ask yourself
Locating the Workflow feature
How to create and edit the Workflow
Transitions
Workflow Example Overview
FAQs
Administration
Business Days
Questions to ask yourself
Locating the Business Days feature
Setting up Business Days
FAQs
Dashboards
Questions to ask yourself
Locating the Dashboards feature
How to create widgets in your Dashboard
Other Dashboard Actions
Data Import
Questions to ask yourself
Locating the Data Import feature
Steps to Complete a Data Import
Data Import Configurations
Column Header Types
Automatic Data Imports via SFTP
FAQs
Duplicate Check
Questions to ask yourself
Locating the Duplicate Check feature
How to use Duplicate Checks
FAQs
Import Projects
Questions to ask yourself
Locating the Import Projects feature
How to Import From V2
FAQs
Operation Status
Questions to ask yourself
Locating the Operation Status feature
How to use the Operation Status feature
FAQs
Program Info
Project Inquiry
Locating the Project Inquiry feature
How to edit the Project Inquiry Settings
Automating Communications for Project Inquires
Inquiry Summary
Questions to ask yourself
Locating the Program Info feature
How to edit the Program Info menu
Notification Banners
Usage Info
FAQs
Program Statistics
Questions to ask yourself
Locating the Program Statistics feature
How to use Program Statistics
FAQs
Reports
Questions to ask yourself
Locating the Reports feature
How to setup Reports
Multi-instance reports
Sharing Reports
Integrate scheduled Reports
Cross-Program Reports
FAQs
Test Environment
Questions to ask yourself
Locating the Test Environment feature
How to setup a Test Environment
FAQs
User Administration
Questions to ask yourself
Locating the User Administration feature
How to work with User Administration
FAQs
Tools Menu
My Account
Questions to Ask
Locating the My Account feature
How to use the My Account feature
Setting up Multi-Factor Authentication
Missing, lost, or stolen mobile devices: resetting Multi-Factor Authentication
Disabling Multi-Factor Authentication
Recovery Guidelines for MFA Administrators
FAQs
FormSense
Questions to Ask
Locating the FormSense feature
How to use the FormSense feature
FAQs
Grant Access
Questions to Ask
Project Grants vs Broad Grants (i.e. "Grant Access")
Locating the Project Grant feature
Locating the Grant Access feature
How to use the Grant Access feature
FAQs
Integration Guides & API
ePayments
Questions to ask yourself
Locating the ePayments History feature
How to add ePayments
FAQ
PowerClerk API
Questions to Ask
What is the PowerClerk API?
What can the PowerClerk API do?
Integrating with the PowerClerk API
API Documentation for Developers
Single Sign On (SSO)
Questions to Ask
PowerClerk SSO Configuration
Azure AD Configuration (SAML)
Azure AD Configuration (OIDC)
Okta IDP Configuration (SAML)
SP Configuration
SSO for multiple programs
IDP Configuration Troubleshooting
FAQs
Integration Guide 001: How to configure a Web Adapter – ArcGIS Implementation
Integration Guide 002: How to configure Electric Power Research Institute’s (EPRI) DRIVE Connect software with PowerClerk
PowerClerk Video Guides
New User Video Guide
Setting up Business Days
Dashboards
FormSense
Edit Forms - Tutorial #1
Build A Formula
Edit Forms - Tutorial #2
Automation with Formulas in Action Rules
Configuring Forms
Formulas and Advanced Visibility Rules
Calculated Fields
Milestones
Project Summary
Setting up Roll-up Reports
Roles and User Administration
Visualize Workflows
ArcGIS
API
SFTP Automatic Data Import
Standard Web Adapter Setup
PowerClerk Program Launch
PowerClerk User Group Sessions (UGS)
Learning Management System (LMS)
Join us for Reflow!
NEW: PowerClerk Certifications

PowerClerk API

Minimize processing overhead and unlock the value of your data with programmatic access to PowerClerk.

PowerClerk API


Questions to ask yourself about PowerClerk’s API:

Which of our processes can be automated programmatically?
How do we get started using PowerClerk’s API?
How do I retrieve data from PowerClerk to integrate with our existing systems?

What is the PowerClerk API?

APIs (Application Programming Interfaces) allow software applications to communicate and interact. With PowerClerk’s API, your client may search, retrieve or update Project data or approval statuses. These API methods mirror the functionality of the PowerClerk user interface for interacting with projects.
 

What can the PowerClerk API do?

Utilities and Energy Agencies can further integrate and automate PowerClerk workflows and reporting to maximize the value of PowerClerk subscriptions via the PowerClerk API:

  • Populate and update external systems (e.g., ERP, CRM, CIS, billing, etc.) with PowerClerk data.
  • Create and update projects programmatically, including status changes.
  • Integrate distribution planning systems to automate technical screening.
  • Provide real-time information about distributed generation penetration on utility circuits via Geographic Information Systems (GIS) maps.

Applicants reduce the time required to submit applications from minutes to seconds:

  • Programmatically submit and update projects utilizing customer data already stored in CRM systems.
  • Report on projects in process.
  • Gain visibility across multiple programs and utilities/agencies from your CRM system.

Learning more about integrating with the PowerClerk API

To get started, login to PowerClerk and submit an API Key request to our support team at the PowerClerk’s Ticket System and choose the Submit API Key Request option:
 
 

Submit API Key Request

Figure 1: Ticket System >> Submit API Key Request button

 
 
Please Note: Each API key is mapped to a PowerClerk account(s). If you are requesting an API Key for a Production program, please provide the PowerClerk account that the API key will be mapped to and a user with the role of Program Designer (not all Program utilize the verbiage Program Designer, in that case please provide the PowerClerk user who manages the program). The Program Designer will verbally confirm the API Key request. Sandbox programs do not require this verbal authorization.
 

To learn more about the PowerClerk API, visit our Developer Documentation sites:

Getting Started

Learn how to get started with the PowerClerk API.      Visit the Getting Started page …

Common Usage Scenarios

Find examples of common usage scenarios that outline using the API
to familiarize yourself with the API’s capabilities.      Visit the Common Usage Scenarios page …

Using Custom IDs

IDs in PowerClerk’s API are random and unique between programs and test enviornments.
For convenience, Program Designers can map these to fixed Custom IDs.      Visit the Using Custom IDs page …

API Method Reference

Explore the detailed API methods, including parameter descriptions and expected values.      Visit the API Method Reference page …

Code Samples

Review code examples to help you realize your use case scenario
with PowerClerk’s API.      Visit the Code Samples page …

Video Guide

Integrate with PowerClerk API using Postman

This video guide will walk you through using the PowerClerk API with Postman.

 
 
A full list of all Video Guides can also be found here.