PluginsPlugin Zendesk

Create​Create

Open a new ticket in Zendesk.

yaml
type: "io.kestra.plugin.zendesk.tickets.Create"

Create Zendesk ticket using username and token.

yaml
id: zendesk_flow
namespace: company.team

tasks:
  - id: create_ticket
    type: io.kestra.plugin.zendesk.tickets.Create
    domain: mycompany.zendesk.com
    username: my_email@example.com
    token: zendesk_api_token
    subject: "Increased 5xx in Demo Service"
    description: |
      "The number of 5xx has increased beyond the threshold for Demo service."
    priority: NORMAL
    ticketType: INCIDENT
    assigneeId: 1
    tags:
      - bug
      - workflow

Create Zendesk ticket using OAuth token.

yaml
id: zendesk_flow
namespace: company.team

tasks:
  - id: create_ticket
    type: io.kestra.plugin.zendesk.tickets.Create
    domain: mycompany.zendesk.com
    oauthToken: zendesk_oauth_token
    subject: "Increased 5xx in Demo Service"
    description: |
      "The number of 5xx has increased beyond the threshold for Demo service."
    priority: NORMAL
    ticketType: INCIDENT
    assigneeId: 1
    tags:
      - bug
      - workflow

Create a ticket when a Kestra workflow in any namespace with company as prefix fails.

yaml
id: create_ticket_on_failure
namespace: company.team

tasks:
  - id: create_ticket
    type: io.kestra.plugin.zendesk.tickets.Create
    domain: mycompany.zendesk.com
    oauthToken: zendesk_oauth_token
    subject: Workflow failed
    description: |
      "{{ execution.id }} has failed on {{ taskrun.startDate }}.
      See the link below for more details."
    priority: NORMAL
    ticketType: INCIDENT
    assigneeId: 1
    tags:
      - bug
      - workflow
triggers:
  - id: on_failure
    type: io.kestra.plugin.core.trigger.Flow
    conditions:
      - type: io.kestra.plugin.core.condition.ExecutionStatus
        in:
          - FAILED
          - WARNING
      - type: io.kestra.plugin.core.condition.ExecutionNamespace
        namespace: company
        comparison: PREFIX
Properties

Zendesk domain url

Id of assignee

Ticket description

Zendesk oauth token, if api token and username is not provided

Possible Values
URGENTHIGHNORMALLOW

Priority

Available values:

  • URGENT
  • HIGH
  • NORMAL
  • LOW

Ticket subject

SubType string

List of tags for ticket

Possible Values
PROBLEMINCIDENTQUESTIONTASK

Ticket type

Available values:

  • PROBLEM
  • INCIDENT
  • QUESTION
  • TASK

Zendesk api token

Zendesk username

Ticket id

Ticket URL