Documentation Index

Fetch the complete documentation index at: https://help.quickbase.com/llms.txt

Use this file to discover all available pages before exploring further.

Pipelines: QBL v0.14

  • 6 minute(s) read
Prev Next

This article contains information about a QBL (Quickbase language) object. QBL objects are the supported Quickbase schema elements you see textually represented in the YAML file generated by Quickbase when you export a solution. Each object has associated properties. Supported schema may differ by QBL version.

To use this version, specify 0.14 when making requests with the API. No other activation is required.

Tip

Quickbase strongly recommends using service accounts to manage pipelines. Although QBL v0.14 supports importing and exporting pipelines from different owners, service accounts simplify authentication and allow for improved collaboration and security.

Supported channels

QBL v0.14 supports these pipeline channels:

  • Quickbase

  • FastField

  • Callable pipelines

  • Webhooks

  • Clock

  • Json-Handler

  • CSV-Handler

  • Text

  • HTTP

  • Microsoft Outlook

  • Microsoft Sharepoint

  • Gmail

  • Google drive

  • Dropbox

  • Slack

Solutions containing pipelines with unsupported channels cannot be exported.

Solution API rules for pipelines

This section explains rules for each solution API, including authentication handling, reference handling, and general behaviors.

Important

If the import or export of any resource in a solution fails, the request is stopped, and all resources revert to their original state.

Export

Authentication

Each account connection is exported with the channel account ID and alias included in the QBL.

Learn more about aliases

References

  • Recognizable references within the solution are exported as Logical IDs in the QBL, including:

    • Quickbase app references

    • Quickbase table references

    • Quickbase field references

    • Callable pipeline references

  • References outside the solution retain their real IDs. This includes references to Quickbase outside of the solution, as well as external references (like a Dropbox folder, for example).

  • Jinja expressions are exported as plain text, which means references inside the Jinja are not recognized in QBL.

  • Quickbase auth tokens are not exported for all channels. Channels that don’t use channel accounts (like Webhooks, for example) export passwords or tokens used to authenticate the pipeline as plain text. Instead, Quickbase recommends using the HTTP channel or the Quickbase Make Request step instead.

Create

  • The user performing the import will become the owner of the pipeline.

  • Imported pipelines default to the "off" state.

  • Imported pipelines retain the original schedule.

Authentication

  • Pipeline creation is only permitted if the user has the necessary permissions to create pipelines.

  • Quickbase attempts to match a channel account for each pipeline step based on the criteria: pipeline owner, channel, alias.

    Note: Channel accounts used in the pipeline step can only belong to the owner of the pipeline. If user A owns the pipeline, they cannot use a channel account belonging to user B.

    For example, if the QBL describes a Gmail channel account with alias “XYZ”, Quickbase looks for a Gmail account that belongs to the importing user with alias “XYZ”. If a match isn’t found, a placeholder account is used instead.

    • Placeholder accounts are managed by the pipeline owner, who is the user performing the import.

    • The placeholder account uses the same channel and alias as defined in the QBL.

    • If the channel account defined in the QBL matches an existing placeholder account, the same placeholder account is used.

  • If the exported pipeline requires a tokenless account, the pipeline uses the tokenless account (otherwise known as realm default account) of the importing user to create the pipeline.

  • If a different value is specified for the channel account alias parameter, Quickbase matches against the provided alias value, and not the one included in the QBL. This allows you to create channel accounts before creating a pipeline with QBL, and choose to use that account.

Learn more about placeholder accounts and aliases

Update

  • The pipeline owner remains unchanged after update.

  • The state of the pipeline (on/off) remains unchanged, unless a pipeline that was previously on is no longer valid after the update. In these cases, a message is returned.

  • Pipeline updates may adjust the following if specified in QBL:

    • Name

    • Description

    • Type

    • Schedule

Authentication

  • Quickbase attempts to match a channel account for each pipeline step based on the criteria: pipeline owner, channel, alias. All channel accounts must be matched, not only new additions.

    • For existing steps, the channel account remains unchanged during an update.

    • If a structural change is made to a step that requires a different channel account (for example, switching the authentication type from tokenless to token), the matching logic applies to select the correct account.

    • When a new step is created during an import, the matching logic is used to determine its channel account.

      Note: During updates, Quickbase attempts to match the owner of the pipeline, not the user performing the update. For example, if the QBL describes a Gmail channel account with alias “XYZ”, Quickbase looks for a Gmail account that belongs to the pipeline owner with alias “XYZ”. If a match isn’t found, a placeholder account is used instead.

      • Placeholder accounts are managed by the pipeline owner, not the user performing the update.

      • The placeholder account uses the same channel and alias as defined in the QBL.

      • If the channel account defined in the QBL matches an existing placeholder account, the same placeholder account is used.

  • If a different value is specified for the channel account alias parameter, Quickbase matches against the provided alias value, and not the one included in the QBL. This allows you to create channel accounts before updating a pipeline with QBL, and choose to use that account.

Learn more about placeholder accounts and aliases

This article contains information about a QBL (Quickbase language) object. QBL objects are the supported Quickbase schema elements you see textually represented in the YAML file generated by Quickbase when you export a solution. Each object has associated properties. Supported schema may differ by QBL version.

The following tables list information about the properties of this object. 

The following tables list information about the properties of this object. 

Pipeline

Property Name

Required

Default

Allowed Values

Name

False

New pipeline

Any string

Description

False

Your new pipeline

Any string

Owner

True

Any string

Tags

True

Array of items of type: / Any string

Crontab

True

Any string

CrontabTimezone

True

Any string

Pipeline bucket

Property Name

Required

Default

Allowed Values

Label

True

Any string

Value

True

Any string

Pipeline channel account

Property Name

Required

Default

Allowed Values

Alias

True

Any string

AccountId

True

Any string

Channel

True

Any string

AccountType

True

Any string

Realm

True

Any string

Pipeline step

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Bucket

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Clock

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Cloudpipes Meta

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Condition

Property Name

Required

Default

Allowed Values

Type

True

Any string

Name

True

Any string

Note

False

""

Any string

Filters

False

Pipeline step - CSV Handler

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Data source - App

Property Name

Required

Default

Allowed Values

Name

True

Any string

App

True

References: App (Scope: Solution)

Pipeline step - Data source - Fields

Property Name

Required

Default

Allowed Values

Name

True

Any string

Source

True

Reference to QB::PipelineStep::DataSource::Table. See nested properties.

    Name

True

Any string

    Table

True

References: Table (Scope: Root), Table (Scope: Solution)

    Source

True

Reference to QB::PipelineStep::DataSource::App. See nested properties.

        Name

True

Any string

        App

True

References: App (Scope: Solution)

Fields

False

Array of items of type:

Pipeline step - Data source - Table

Property Name

Required

Default

Allowed Values

Name

True

Any string

Table

True

References: Table (Scope: Root), Table (Scope: Solution)

Source

True

Reference to QB::PipelineStep::DataSource::App. See nested properties.

    Name

True

Any string

    App

True

References: App (Scope: Solution)

Pipeline step - Dropbox

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - FastField

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Gmail

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Google Drive

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - HTTP

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Inputs Meta

No properties defined.

Pipeline step - JSON Handler

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Loop

Property Name

Required

Default

Allowed Values

Type

True

Any string

Name

True

Any string

Target

False

Note

False

""

Any string

Pipeline step - Microsoft Outlook

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Microsoft Sharepoint

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Quickbase

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Slack

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Stop

Property Name

Required

Default

Allowed Values

Type

True

Any string

Name

True

Any string

Note

False

""

Any string

Pipeline step - Text

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline step - Webhooks

Property Name

Required

Default

Allowed Values

Id

True

Any string

Name

True

Any string

Type

True

Any string

SubType

True

Any string

PipelineChannelAccount

True

Reference to PipelineChannelAccount

Channel

False

See nested properties

    Resource

True

Any string

    Id

True

Any string

    Selector

True

Any string

Inputs

False

Filters

False

Target

False

Link

False

Note

False

""

Any string

Pipeline table

Property Name

Required

Default

Allowed Values

Label

True

Any string

Value

True

Any string

Placeholder record set

Property Name

Required

Default

Allowed Values

ExternalSetId

True

Any string

Name

True

Any string

SetType

False

Table

One of: Table, Query