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

MethodPathDescription
GET/pipelinesList pipelines
GET/pipelines/:idGet a pipeline
POST/pipelinesCreate a pipeline
PATCH/pipelines/:idUpdate a pipeline
DELETE/pipelines/:idDelete a pipeline

Reads are limited to your API key's organization. Pass organization_id and type as filters.

Visibility and permissions

  • A public pipeline is visible to every member of the organization. A private pipeline 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 member role in the organization (403 Forbidden).

The pipeline object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
namestringDisplay name. Required on create.
descriptionstringDescription.
typestringdeal, conversation or ticket. Required on create.
organization_idintegerOrganization that owns the pipeline. Required on create.
created_by_user_idintegerRead-only. User who created the pipeline (the API key's user).
configobject | nullSettings. 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.
visibilitystringpublic or private. Default public.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-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:

KeyChannel
whatsapp:<whatsapp_channel_id>One WhatsApp number of the organization
instagramInstagram
messengerMessenger
webchatWebchat
smsSMS

An empty or missing list means every channel, including channels connected later.

  • Listing conversations with pipeline_id or incoming_pipeline_id only 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 400 with data.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.