Workflow context
What this guide helps you accomplish
Plan a UnionStack API integration around a specific workflow, accountable authorization and tenant-aware data handling.
An integration should extend one accountable workflow using OAuth 2.0 with PKCE and tenant-aware authorization—not create an uncontrolled second database.
An integration should extend an accountable UnionStack procedure, not create a second uncontrolled source of truth.
Before you begin
Prepare the following before changing shared configuration or records:
- A named owner for the site, report or integration and a written description of its audience and purpose.
- Fake source records that can be published, reported or retrieved without exposing member information.
- A review plan covering access, mobile presentation, errors and the ongoing maintenance owner.
- A fake tenant, documented data flow, approved redirect URL and secure development secret store.
Procedure
Complete the steps in order with fake or approved test information first. Record configuration decisions that will affect other teams.
Define the workflow and data need
Describe the trigger, records, transformations, destination and expected result. Request only the access required for that workflow.
Register the integration appropriately
Have an authorized administrator create or approve the required client configuration and redirect locations. Keep secrets out of source control and notes.
Implement OAuth 2.0 with PKCE
Follow the public authorization guidance, validate state and redirects and store tokens through an approved secure mechanism.
Respect tenant and user context
Treat every API response as belonging to the authorized organization and permissions. Do not combine tenant data in logs or caches.
Handle errors and limits safely
Design retries, expiry handling and operational alerts without logging tokens or unnecessary personal information.
Test and monitor with representative data
Verify successful, denied, expired and partial scenarios before production use. Review credentials and integration ownership regularly.
Product view
Video demonstration
Follow the principal workflow in this captioned demonstration. The recording uses fake records in the UnionStack test environment.
Troubleshooting
Use the symptoms below to diagnose the workflow before widening access, adding duplicate configuration or bypassing an intended control.
Authorization succeeds but the expected resource is denied
Confirm tenant, user permissions, requested operation and resource ownership. Do not broaden authorization until the denied path is understood.
The result exposes too much or too little information
Return to the source record, audience definition and authorization rule. Correct publishing status, filters or access before changing content solely to hide the symptom.
A count or page does not match expectations
Verify source quality, status, effective dates, relationships and filters. Reproduce the result with one known record before changing the configuration.
An external connection stops working
Check ownership, authorization expiry, redirect or domain settings and recent provider changes. Rotate or reauthorize credentials through the approved secure process.
Validation checklist
Do not treat the procedure as complete until an authorized second person can reproduce the intended result.
- Success, denial, expiry and partial-failure tests behave as designed without exposing tokens or cross-tenant data.
- The intended audience can reach the result and an unauthorized or signed-out user cannot reach protected information.
- Every displayed value can be traced to an understood UnionStack source record or documented calculation.
- Mobile, keyboard, link and error-state checks have been completed.
- An owner and recurring review date are recorded for the live site, report or integration.
Version applicability
This guide was verified for UnionStack 2.0 on August 16, 2026. Available fields, types, relationships, navigation and access can vary with tenant configuration and user permissions.
Corresponding product capability
UnionStack API and integrations
See the feature evidence, connected workflows and buyer guidance behind this procedure.
Explore UnionStack API and integrations →Continue learning
Return to the UnionStack Learning Centre, or take the UnionStack product tour to see how these parts connect.