Zendesk Create

Zendesk Create

Certified

Create a Zendesk ticket

Calls /api/v2/tickets.json with basic auth (username + API token) or OAuth bearer. Renders templated fields with the current RunContext. Fails if Zendesk does not return HTTP 201.

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: "{{ secret('ZENDESK_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: "{{ secret('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: "{{ secret('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

Base domain of the Zendesk instance; https:// is added if missing and trailing slash is removed.

Assignee ID

Numeric Zendesk assignee ID; omit to leave unassigned.

Ticket description

Body of the ticket; templated via RunContext and supports multiline text.

Zendesk OAuth token

Bearer token alternative to username/token; send as Authorization: Bearer.

Reference (ref) of the pluginDefaults to apply to this task.

Possible Values
URGENTHIGHNORMALLOW

Priority

Optional Zendesk priority. Allowed values: URGENT, HIGH, NORMAL, LOW. Leave blank to use Zendesk's default.

Ticket subject line

Short summary shown in Zendesk; rendered from the RunContext.

SubTypestring

Ticket tags

List of tags to apply to the ticket; rendered from the RunContext.

Possible Values
PROBLEMINCIDENTQUESTIONTASK

Ticket type

Optional Zendesk type. Allowed values: PROBLEM, INCIDENT, QUESTION, TASK.

Zendesk API token

API token for basic auth; pair it with username.

Zendesk username

Account email used with an API token for basic authentication.

Ticket ID

Ticket URL