Element details

type: meya.zendesk.help_center.component.display
class: ZendeskHelpCenterArticlesDisplayComponent
path: /meya/zendesk/help_center/component/display.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	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
search_response	The response from the Zendesk Help Center search API. This is usually available in flow scope, (@ flow.get('result')), after using the meya.zendesk.help_center.component.search or meya.zendesk.help_center.component.article.get component.	◉	○		ZendeskHelpCenterSearchResponse ZendeskHelpCenterArticle
url_button_text	The text of the link button which is displayed with each article tile.	○	○	"Read article"	str
snippet_length	Length of the article snippet displayed on the tile body	○	○	125	int
button_type	Tile button type	○	○	"url"	ButtonType

Usage reference

Basic

triggers:
  - keyword: meya.zendesk.help_center.component.display
steps:
  - type: meya.zendesk.help_center.component.display
    search_response:
      count: 123
      page: 123
      page_count: 123
      per_page: 123
      results:
        - locale: STRING
          title: STRING
          author_id: 123
          permission_group_id: 123
          id: 123
          vote_sum: 123
          vote_count: 123
          result_type: STRING
          snippet: STRING

Full

triggers:
  - keyword: meya.zendesk.help_center.component.display
steps:
  - type: meya.zendesk.help_center.component.display
    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
    search_response:
      count: 123
      page: 123
      page_count: 123
      per_page: 123
      sort_by: STRING
      sort_order: STRING
      previous_page: STRING
      next_page: STRING
      results:
        - locale: STRING
          title: STRING
          author_id: 123
          permission_group_id: 123
          id: 123
          outdated_locales:
            - STRING
          vote_sum: 123
          vote_count: 123
          name: STRING
          user_segment_id: 123
          body: STRING
          comments_disabled: false
          created_at: STRING
          updated_at: STRING
          draft: false
          edited_at: STRING
          html_url: STRING
          label_names:
            - STRING
          outdated: false
          position: 123
          promoted: false
          section_id: 123
          source_locale: STRING
          url: STRING
          result_type: STRING
          snippet: STRING
    url_button_text: STRING
    snippet_length: 123
    button_type: text|url|static|menu|divider|action|flow_next|component_next