zendesk.support.ticket.update

This component will update the specified ticket with the provided
fields and return the ticket API response payload.

Element details

type: meya.zendesk.support.component.ticket.update
class: ZendeskSupportTicketUpdateComponent
path: /meya/zendesk/support/component/ticket/update.py
signature: -

Fields

field

description

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

required

signature

default

type

spec

Override the original spec for this element.

null

Spec

integration

The reference path to the Zendesk Support integration file. See the integration reference paths documentation for more information.

ZendeskSupportIntegrationRef

requester_id

The user who requested this ticket.

null

int

subject

The value of the subject field for this ticket.

null

str

comment

Add a comment to the ticket.

null

str

comment_attachments

A list of file URLs to attach to the comment. These fileswill be downloaded from the source and then uploaded to Zendesk to ensure they are secured by Zendesk's security policies and user access rights.

Be careful not to attach too many large files that take long to download and upload, as this could exceed the component timeout and cause the component to fail.

If any file fails to download or upload, the component will log the exception in your app's logs.

The file size limit is 50MB per attachment.

There is a 10s timeout per file download and a 10s timeout per file upload.

null

list

comment_public

Controls whether the ticket is public or not.

null

bool

tags

An array of tags to add to the ticket.

null

list

custom_fields

An array of the custom field objects consisting of IDs and values.

null

list

ticket_type

The type of this ticket. Allowed values are problem, incident, question, or task.

null

str

status

The state of the ticket. Allowed values are new, open, pending, hold, solved, or closed.

null

ZendeskSupportTicketStatus

priority

The urgency with which the ticket should be addressed. Allowed values are urgent, high, normal, or low.

null

str

assignee_id

The agent currently assigned to the ticket.

null

int

group_id

null

int

external_id

An ID you can use to link Zendesk Support tickets to local records.

null

str

ticket_form_id

The ID of the ticket form to render for the ticket.

null

int

brand_id

The ID of the brand this ticket is associated with.

null

int

context

Send context data with this component's event.

{}

dict

sensitive

true

bool

triggers

Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.

[]

list

ticket_id

The ID of the ticket to update.

null

int

Usage reference

Basic

triggers:
  - keyword: meya.zendesk.support.component.ticket.update
steps:
  - type: meya.zendesk.support.component.ticket.update
    integration: integration.zendesk_support

Full

triggers:
  - keyword: meya.zendesk.support.component.ticket.update
steps:
  - type: meya.zendesk.support.component.ticket.update
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    integration: integration.zendesk_support
    requester_id: 123
    subject: STRING
    comment: STRING
    comment_attachments:
      - STRING
    comment_public: false
    tags:
      - STRING
    custom_fields:
      - id: 123
        value: ANY
    ticket_type: STRING
    status: new|open|pending|hold|solved|closed
    priority: STRING
    assignee_id: 123
    group_id: 123
    external_id: STRING
    ticket_form_id: 123
    brand_id: 123
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    ticket_id: 123