turbot / flowpipe-mod-zendesk

Zendesk pipeline library for the Flowpipe cloud scripting engine. Automation and workflows to connect Zendesk to the people, systems and data that matters.

Zendesk Mod for Flowpipe

Zendesk pipeline library for Flowpipe, enabling seamless integration of Zendesk services into your workflows.

Documentation

• Pipelines →

Getting Started

Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install flowpipe

Credentials

By default, the following environment variables will be used for authentication:

• ZENDESK_API_TOKEN
• ZENDESK_EMAIL
• ZENDESK_SUBDOMAIN

You can also create credential resources in configuration files:

vi ~/.flowpipe/config/zendesk.fpc

credential "zendesk" "default" {
  email      = "[e-mail]"
  subdomain  = "dmi"
  token      = "17ImlCYdfZ3WJIrGk96gCpJn1fi1pLwVdrb23kj4"
}

For more information on credentials in Flowpipe, please see Managing Credentials.

Usage

Initialize a mod:

mkdir my_mod
cd my_mod
flowpipe mod init

Install the Zendesk mod as a dependency:

flowpipe mod install github.com/turbot/flowpipe-mod-zendesk

Use the dependency in a pipeline step:

vi my_pipeline.fp

pipeline "my_pipeline" {

  step "pipeline" "get_ticket" {
    pipeline = zendesk.pipeline.get_ticket
    args = {
      ticket_id = "99999"
    }
  }
}

Run the pipeline:

flowpipe pipeline run my_pipeline

Developing

Clone:

git clone https://github.com/turbot/flowpipe-mod-zendesk.git
cd flowpipe-mod-zendesk

List pipelines:

flowpipe pipeline list

Run a pipeline:

flowpipe pipeline run get_ticket --arg ticket_id=99999

To use a specific credential, specify the cred pipeline argument:

flowpipe pipeline run get_ticket --arg ticket_id=99999 --arg cred=zendesk_profile

Open Source & Contributing

This repository is published under the Apache 2.0 license. Please see our code of conduct. We look forward to collaborating with you!

Flowpipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #flowpipe on Slack →

Want to help but not sure where to start? Pick up one of the help wanted issues:

• Flowpipe
• Zendesk Mod