This component will run the Zendesk Support integration's internal
ticket_rx logic and publish any relevant events to the Meya thread.

This component is mainly used when implementing agent-initiated
conversations with Zendesk Support. Check the
agent-initiated conversations guide
for more information.

Element details

type: meya.zendesk.support.component.ticket.rx
class: ZendeskSupportTicketRxComponent
path: /meya/zendesk/support/component/ticket/rx.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
context	Send context data with this component's event.	○	○	{}	dict
sensitive	Mark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled.	○	○	false	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
thread_id	The ID of the Meya relevant thread.	◉	○		str
ticket	The ticket API response payload from the Zendesk API.	◉	○		ZendeskSupportTicketGet
current_user	The user API response payload from the Zendesk API.	◉	○		ZendeskSupportUserGet

Usage reference

Basic

triggers:
  - keyword: meya.zendesk.support.component.ticket.rx
steps:
  - type: meya.zendesk.support.component.ticket.rx
    integration: integration.zendesk_support
    thread_id: STRING
    ticket:
      status: new|open|pending|hold|solved|closed
      created_at: STRING
      description: STRING
      id: 123
      updated_at: STRING
    current_user:
      name: STRING
      verified: false
      created_at: STRING
      id: 123
      role: end-user|agent|admin|system
      updated_at: STRING

Full

triggers:
  - keyword: meya.zendesk.support.component.ticket.rx
steps:
  - type: meya.zendesk.support.component.ticket.rx
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    integration: integration.zendesk_support
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    thread_id: STRING
    ticket:
      status: new|open|pending|hold|solved|closed
      assignee_id: 123
      custom_fields:
        - id: 123
          value: ANY
      external_id: STRING
      group_id: 123
      priority: STRING
      requester_id: 123
      tags:
        - STRING
      subject: STRING
      type: STRING
      ticket_form_id: 123
      brand_id: 123
      comment_count: 123
      created_at: STRING
      description: STRING
      id: 123
      updated_at: STRING
    current_user:
      alias: STRING
      details: STRING
      email: STRING
      external_id: STRING
      name: STRING
      phone: STRING
      tags:
        - STRING
      user_fields:
        STRING: ANY
      verified: false
      created_at: STRING
      id: 123
      photo:
        id: 123
        file_name: STRING
        content_url: STRING
        content_type: STRING
      role: end-user|agent|admin|system
      updated_at: STRING