Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/turbot/flowpipe-mod-zendesk
automation cloud devops flowpipe flowpipe-mod hacktoberfest integrations low-code orchestration pipelines security workflow workflow-automation workflow-engine zendesk zendesk-api
Last synced: about 1 month ago
JSON representation
Zendesk pipeline library for the Flowpipe cloud scripting engine. Automation and workflows to connect Zendesk to the people, systems and data that matters.
- Host: GitHub
- URL: https://github.com/turbot/flowpipe-mod-zendesk
- Owner: turbot
- License: apache-2.0
- Created: 2023-10-11T03:50:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-22T12:40:25.000Z (2 months ago)
- Last Synced: 2024-10-22T13:24:37.552Z (2 months ago)
- Topics: automation, cloud, devops, flowpipe, flowpipe-mod, hacktoberfest, integrations, low-code, orchestration, pipelines, security, workflow, workflow-automation, workflow-engine, zendesk, zendesk-api
- Language: HCL
- Homepage: https://hub.flowpipe.io/mods/turbot/zendesk
- Size: 215 KB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Zendesk Mod for Flowpipe
Zendesk pipeline library for [Flowpipe](https://flowpipe.io), enabling seamless integration of Zendesk services into your workflows.
## Documentation
- **[Pipelines →](https://hub.flowpipe.io/mods/turbot/zendesk/pipelines)**
## Getting Started
### Installation
Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:
```sh
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:
```sh
vi ~/.flowpipe/config/zendesk.fpc
```
```hcl
credential "zendesk" "default" {
email = "[email protected]"
subdomain = "dmi"
token = "17ImlCYdfZ3WJIrGk96gCpJn1fi1pLwVdrb23kj4"
}
```
For more information on credentials in Flowpipe, please see [Managing Credentials](https://flowpipe.io/docs/run/credentials).
### Usage
[Initialize a mod](https://flowpipe.io/docs/build/index#initializing-a-mod):
```sh
mkdir my_mod
cd my_mod
flowpipe mod init
```
[Install the Zendesk mod](https://flowpipe.io/docs/build/mod-dependencies#mod-dependencies) as a dependency:
```sh
flowpipe mod install github.com/turbot/flowpipe-mod-zendesk
```
[Use the dependency](https://flowpipe.io/docs/build/write-pipelines/index) in a pipeline step:
```sh
vi my_pipeline.fp
```
```hcl
pipeline "my_pipeline" {
step "pipeline" "get_ticket" {
pipeline = zendesk.pipeline.get_ticket
args = {
ticket_id = "99999"
}
}
}
```
[Run the pipeline](https://flowpipe.io/docs/run/pipelines):
```sh
flowpipe pipeline run my_pipeline
```
### Developing
Clone:
```sh
git clone https://github.com/turbot/flowpipe-mod-zendesk.git
cd flowpipe-mod-zendesk
```
List pipelines:
```sh
flowpipe pipeline list
```
Run a pipeline:
```sh
flowpipe pipeline run get_ticket --arg ticket_id=99999
```
To use a specific `credential`, specify the `cred` pipeline argument:
```sh
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](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!
[Flowpipe](https://flowpipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). 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](https://turbot.com/open-source).
## Get Involved
**[Join #flowpipe on Slack →](https://flowpipe.io/community/join)**
Want to help but not sure where to start? Pick up one of the `help wanted` issues:
- [Flowpipe](https://github.com/turbot/flowpipe/labels/help%20wanted)
- [Zendesk Mod](https://github.com/turbot/flowpipe-mod-zendesk/labels/help%20wanted)