Partner integration
A partner integration lets several customers connect your application to their own Oneflow accounts. You build the workflow once and keep each customer's connection settings separately.
You use the same API operations for authentication, contract creation, and webhooks as other integrations. Start with Integrations - Introduction, then follow Building a partner integration.
Blueprints and Playbooks
An Integration Blueprint defines the fields your integration uses. A Playbook maps those fields to shared Oneflow fields. Customers select a Playbook on a template, which supplies the fields and mappings for contracts created from it.
You can use this model with one external system or several. The same integration can create a contract and respond to its events.
See Core building blocks for the components and Key concepts for data flow and field access.
Integration extension in Oneflow
Contact the Oneflow Partner team to set up a dedicated integration extension. This gives customers a way to enable your integration in Oneflow.
The team will help you choose how customers provide API tokens. Customers can enter a token manually, or your app can receive it when the extension is activated or a setup button is selected.
Once enabled, customers can find their integration under Admin > Integrations.
For the partner setup details, see Core building blocks: Integration.
Working with data fields
Define your integration's fields in its Blueprint. Give each field a stable custom_id, which your code uses to send and read contract values.
The customer maps those Blueprint fields to Playbook fields in Oneflow Admin. For example, your Company name field can map to the customer's Customer name field.
See Integration Blueprint field for field properties and Field mapping for how the fields connect.
Getting workspaces and templates
Let users select a workspace and template they can access. Use the template's Playbook or Blueprint association to find templates that work with your integration.
Store Blueprint and Playbook IDs separately for each customer account. An ID from your test account does not identify the same setup in another account.
See Integration identity and token context for the filters and Account-scoped lifecycle for account-specific IDs.
Responding to contract events
Use a webhook when your application needs to act on a contract event, such as signing. Connecting a Blueprint to a Playbook does not register a webhook.
Add a BLUEPRINT rule when notifications must be limited to contracts associated with that Blueprint. An event can notify your integration even when another system created the contract, if the webhook filters match.
Follow Webhooks and integration responsibilities for registration, filters, verification, and processing.
Updating an existing partner integration
Start with Migrating from the legacy integration framework. Use Migration guide to plan, test, and roll out the changes for each customer account.
Updated 19 days ago

