This will search for users in Zendesk Support and return the user API
response payload.

triggers:
  - keyword: zendesk_support_user_search

steps:
  - say: What is the user's email?
  - type: email_address_input
    required: true
  - type: meya.zendesk.support.component.user.search
    integration: integration.zendesk.support
    query:
      - email:(@ flow.result )
  - say: Users found are (@ flow.result )

Element details

type: meya.zendesk.support.component.user.search
class: ZendeskSupportUserSearchComponent
path: /meya/zendesk/support/component/user/search.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
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
integration	The reference path to the Zendesk Support integration file. See the integration reference paths documentation for more information.	◉	○		ZendeskSupportIntegrationRef
query	The query to search for users. 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.	○	○	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.user.search
steps:
  - type: meya.zendesk.support.component.user.search
    integration: integration.zendesk_support
    query:
      - STRING

Full

triggers:
  - keyword: meya.zendesk.support.component.user.search
steps:
  - type: meya.zendesk.support.component.user.search
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    integration: integration.zendesk_support
    query:
      - STRING
    sort_by: STRING
    sort_order: asc|desc