Building User Level Authentication Applications

Learn how to build a data connection app using User Level Authentication (OAuth 2.0) to act on behalf of a Procore user.

Introduction

This guide provides step-by-step instructions for building a data connection app using User Level Authentication (OAuth 2.0 Authorization Code Flow). This method allows your integration to act on behalf of a specific user, enabling secure data exchange between Procore and an external platform using a Client ID and Client Secret.

To get started, first create a Developer Portal account and app.

Add a New Data Connector Component

  1. In your Developer Portal app, expand the Data Connector Components section.
  2. Click Add Components.
  3. Select User Level Authentication.
    • This option uses OAuth 2.0 Authorization Code Flow to act on behalf of a user. API responses are limited by the user’s permissions in Procore.
  4. Click Save Component.

Define Setup Instructions and Post-Installation Notes

You must provide setup instructions and post-installation notes to help Procore users complete the installation and setup of your application within a Procore project.

Clear post-installation guidance is required to ensure users know exactly what to do after installing your app. For example, they may need to sign up for an external account, configure settings on your platform, or complete authentication steps before the app is ready to use.

These instructions are shown to the user immediately after installation and remain accessible in the App Management section of the Procore Admin tool.

Follow these steps to define setup instructions:

  1. Expand the Instructions and Post-Installation Notes section.
  2. In the Instructions URL field, enter a link to your company’s support site or a page with step-by-step setup instructions.
  3. In the Instructions Page Name field, enter the label you want to display as the hyperlink text for the Instructions URL.
  4. In the Post-Installation Notes field, add any additional details or reminders users need to complete setup successfully.

Create the Initial App Manifest Version

After configuring your component, you’re ready to save your first app version.

  1. In the Configuration Builder, click Create Version.
  2. Enter a semantic version number (e.g., 0.1.0).
  3. Click Create.

The version will be saved with the status Ready for Testing. As you continue development, click Save Version to capture changes.

Test and Validate in the Development Sandbox

Test and validate each version of your app in your Development Sandbox before releasing it to production.
See Installing an Application in the Development Sandbox for step-by-step instructions.

Promote the Updated Sandbox Manifest to Production

Once you’re satisfied with testing, promote your sandbox version to production.
See Managing App Versions & Update Notifications to learn how.