Pipelines
A pipeline is an ordered set of stages used to track deals, conversations or support tickets on a board. The type of the pipeline says which records it holds.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /pipelines | List pipelines |
GET | /pipelines/:id | Get a pipeline |
POST | /pipelines | Create a pipeline |
PATCH | /pipelines/:id | Update a pipeline |
DELETE | /pipelines/:id | Delete a pipeline |
Reads are limited to your API key's organization. Pass organization_id and type as filters.
Visibility and permissions
- A
publicpipeline is visible to every member of the organization. Aprivatepipeline is only visible to its members (managed in the app) and to organization owners and admins. List and get apply this to the API key's user. - Creating, updating and deleting pipelines is not allowed when the API key's user has the
memberrole in the organization (403 Forbidden).
The pipeline object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
name | string | Display name. Required on create. |
description | string | Description. |
type | string | deal, conversation or ticket. Required on create. |
organization_id | integer | Organization that owns the pipeline. Required on create. |
created_by_user_id | integer | Read-only. User who created the pipeline (the API key's user). |
config | object | null | Settings. For deal pipelines the app stores defaultDealStatus (open, won, lost or all), the status filter applied when the board opens. For conversation pipelines, channel_scope lists the channels the pipeline accepts (see Channel scope). On update, config of a conversation pipeline is merged with the stored object. |
visibility | string | public or private. Default public. |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the pipeline is deleted. |
Channel scope (conversation pipelines)
A conversation pipeline can accept conversations from only some channels. config.channel_scope is a list of keys:
| Key | Channel |
|---|---|
whatsapp:<whatsapp_channel_id> | One WhatsApp number of the organization |
instagram | |
messenger | Messenger |
webchat | Webchat |
sms | SMS |
An empty or missing list means every channel, including channels connected later.
- Listing conversations with
pipeline_idorincoming_pipeline_idonly returns conversations of the pipeline's channels. - A conversation cannot be moved into a pipeline that does not accept its channel: patching a conversation returns
400withdata.code = "PIPELINE_CHANNEL_NOT_ALLOWED". - Removing channels that still have conversations in the pipeline requires saying where they go (
channel_scope_migration, see Update a pipeline).
Related
Report an issue with this documentation
Please log in to report issues with our documentation.