The Pipelines API enables you to create and manage pipeline systems for tracking multi-step business processes in Wix CRM. A pipeline is a customizable system that organizes your business process into a series of ordered stages. For example, a sales funnel, hiring workflow, project management process, or other custom business operations. Individual items such as deals or business leads move through the pipeline stages to a final outcome.
With the Pipelines API, you can:
- Create, update, and delete custom pipelines.
- Organize pipelines with tags for easier management and filtering.
- Query and filter pipelines based on various criteria.
It's important to note the following points before starting to code:
- The Pipelines API works closely with the Cards API. Cards represent the actual deals, leads, or opportunities that move through your pipeline stages.
- All pipelines must have at least 1 stage in addition to the
doneStage.
- The
doneStage must have at least 1 allowed outcome.
- Once you set a pipeline's currency value, you can't change it.
- You can't delete any pipelines or regular stages that contain cards.
- You can't delete a pipeline's
doneStage.
- Pipeline: A structured workflow consisting of multiple ordered stages that represents a business process. Pipelines define the path that cards follow from start to completion.
- Stage: A specific step or phase in a pipeline that represents a particular state in the business process.
- Done stage: The final stage of the pipeline that serves as the end point of a business process where cards conclude their workflow. Done stages specify allowed outcomes and every pipeline must have exactly 1
doneStage.
- Stale duration: The duration, in hours, that a card can remain in a stage before becoming stale. This helps identify workflow bottlenecks and cards that may need attention.
- Outcome: The final result of a card when it reaches the final stage. Can be
NONE, WON, or LOST. The final stage must specify at least 1 allowed outcome that cards can have when moved to completion. This determines what final states are possible for items in your pipeline.
- Card: Items that move through pipeline stages, representing deals, leads, projects, and more business entities tracked through a process. You can manage cards using the Cards API.
- Tags: Keywords used to categorize and organize pipelines for filtering and tracking purposes.