This component searches for tickets in Zendesk Support based on a query.

Here is an example of a flow that searches for tickets based on the user's
ID and displays the IDs of all the tickets:

triggers:
  - keyword: zendesk_support_ticket_search

steps:
  - type: meya.zendesk.support.component.user.show
    integration: integration.zendesk.support
  - type: meya.zendesk.support.component.ticket.search
    integration: integration.zendesk.support
    query:
      - requester_id:(@ flow.result.id )
  - ask: Your tickets are (@ flow.result | map(attribute="id") | join(", ") )

Element details

type: meya.zendesk.support.component.ticket.search
class: ZendeskSupportTicketSearchComponent
path: /meya/zendesk/support/component/ticket/search.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		○	○	true	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
query	The query to search for tickets. This must be a valid search query based on the Zendesk search syntax. See the Zendesk search reference guide for more information.	◉	○		list
sort_by	The field to sort the results by. This can be one of `updated_at`, `created_at`, `priority`, `status`, or `ticket_type`. Defaults to sorting by relevance.	○	○	null	str
sort_order	The sort order of the results. This can be `asc` or `desc`. Defaults to `desc`.	○	○	null	ZendeskSupportSortOrder

Usage reference

Basic

triggers:
  - keyword: meya.zendesk.support.component.ticket.search
steps:
  - type: meya.zendesk.support.component.ticket.search
    integration: integration.zendesk_support
    query:
      - STRING

Full

triggers:
  - keyword: meya.zendesk.support.component.ticket.search
steps:
  - type: meya.zendesk.support.component.ticket.search
    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
    query:
      - STRING
    sort_by: STRING
    sort_order: asc|desc