Overview
Changing the setup of a live process can be unsettling: a structural change might break active rules and bring operations to a halt. Pipe Snapshots brings the same concept as the UI's version history to the API. Each snapshot is a saved version of the pipe's setup, and the workflow can be restored to the latest snapshot if a change does not go as planned.
What's new?
Snapshot and restore capabilities are available through GraphQL API calls in the Pipefy Developer Portal:
- Full pipe snapshot (Create Pipe Snapshot): generates a structured JSON file containing setup elements such as phases, fields, automations, conditionals, and more.
- Restore to the latest stable version (Restore Pipe to Last Snapshot): reverts the pipe's setup to the latest saved snapshot. This action cannot be undone.
- View and manage history (Query & Rename Pipe Snapshots): list a process's saved snapshots and rename them to keep versions organized.
How does this help?
- Greater confidence when changing live processes: restructure phases, fields, and automations knowing that, if something goes wrong, the pipe can return to its latest saved snapshot without a support ticket or manual fix.
- See what changed: compare two snapshots saved on different dates and identify exactly which fields and automations were added, removed, or changed.
- Use the pipe's setup as documentation: use the exported JSON to understand a complex pipe without opening every phase, or to generate process documentation automatically with an AI agent.
Use cases
- Ana, Pipe Admin in Procurement Operations: Before restructuring the phases and rules in a request workflow, Ana creates a snapshot. One conditional conflicts with the start form and blocks new requests. Ana restores the pipe to its previous setup, and operations continue without a queue of support tickets.
- Bruno, IT Governance Specialist: The team wants to know which fields and automations were added to the Onboarding pipe last quarter. Bruno compares two snapshots saved on different dates using a diff tool or an AI agent and gets an exact list of changes without reconstructing the history manually.
- Dani, IT Manager: A support pipe has been changed by multiple admins over several months, and no one knows its current setup. Because everything happens through the API, Dani sets up a routine: snapshots run periodically, the JSON goes to the company's AI agent, and the process document is saved in the team's repository. Documentation becomes a byproduct of versioning the pipe.
Most relevant for
- Pipe Admins
- Process Architects
- IT and Governance Teams
Documentation
Consult the Developer Portal for behavior and limitations before using these calls:
- Create a pipe version in JSON
- List and query existing versions
- Rename a version
- Restore the pipe to the latest saved version
Plans and availability
This feature is in Beta, available on all plans during this phase, and restricted to Pipe Admins. Create, Rename, and Query are available for 100% of Multi-Tenant (MT) and Single-Tenant (ST) accounts; Restore is available for 100% of MT accounts. Snapshots cover the pipe's setup (phases, fields, automations, conditionals, and other elements), but not its cards. Integrations, APPs, and AI Agents are also not currently included and may need to be reconfigured after a restore.
