Skip to main content

PipelineList Embeddable

The PipelineList embeddable provides an easy-to-implement, UI-driven interface that gives you a clear overview of all pipelines in your organization and its sub-organizations. You can quickly see how often each pipeline has run, who created it, and the status of its last five executions—all in one place.

Configure the component based on your specific use case

Add the code snippet below and insert the component on the page where you want it to appear:

Fields

accessToken

Add here your access token

settings

i18nOverrides

Allows you to override each text element in the interface

language

Defines the language of the flow. So far we only support English ("en")

modal

Defines whether the component is shown inline (false) or within a modal view (true)

allowPipelineCreation

Defines whether the "New pipeline" button is shown

onPipelineView

Runs after the user has clicked on one pipeline

onPipelineCreate

Runs after the user has clicked on the "New pipeline" button

onClose

Runs when the user trys to close the modal by using the "X" button or clicking outside the modal

Component

<PipelineList
accessToken=string
settings={{
i18nOverrides: {}
language: "en"
modal: boolean (default: false)
allowPipelineCreation: boolean (default: false)
}}
onPipelineView={({data}) => {
// runs when the "Details" button of a pipeline is pressed
// data: pipeline object of the selected pipeline
}}
onPipelineCreate={() => {
// runs when the "New pipeline" button is pressed
}}
onClose={() => {
// runs when the creation workflow is closed via the "X" button or clicking outside the modal
}}
/>