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

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
integrationThe reference path to the Zendesk Support integration file. See the integration reference paths documentation for more information.ZendeskSupportIntegrationRef
requester_idThe user who requested this ticket.nullint
subjectThe value of the subject field for this ticket.nullstr
commentAdd a comment to the ticket.nullstr
comment_attachmentsA 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.
nulllist
comment_publicControls whether the ticket is public or not.nullbool
tagsAn array of tags to add to the ticket.nulllist
custom_fieldsAn array of the custom field objects consisting of IDs and values.nulllist
ticket_typeThe type of this ticket. Allowed values are problem, incident, question, or task.nullstr
statusThe state of the ticket. Allowed values are new, open, pending, hold, solved, or closed.nullZendeskSupportTicketStatus
priorityThe urgency with which the ticket should be addressed. Allowed values are urgent, high, normal, or low.nullstr
assignee_idThe agent currently assigned to the ticket.nullint
group_idnullint
external_idAn ID you can use to link Zendesk Support tickets to local records.nullstr
ticket_form_idThe ID of the ticket form to render for the ticket.nullint
brand_idThe ID of the brand this ticket is associated with.nullint
contextSend context data with this component's event.{}
dict
sensitivetruebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
ticket_idThe ID of the ticket to update.nullint

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