zendesk.help_center

type: meya.zendesk.help_center.trigger
class: ZendeskHelpCenterTrigger
path: /meya/zendesk/help_center/trigger/trigger.py
signature: expect

Fields

fieldsignaturerequiredtypedefaultdescription               
specForwardRef('Spec')nullOverride the original spec for this element
querystrnullThe search text to be matched or a search string. Examples: "bluetooth help", "'bluetooth help'".
label_namesstrnullA comma-separated list of label names.
localestrnullSearch for articles in the specified locale.
categoryintnullLimit the search to this category id.
sectionintnullLimit the search to this section id.
sort_byZendeskHelpCenterSortBynullOne of created_at or updated_at. Defaults to sorting by relevance.
sort_orderZendeskHelpCenterSortOrdernullOne of asc or desc. Defaults to desc.
created_afterstrnullLimit the search to articles created after a given date (format YYYY-MM-DD).
created_atstrnullLimit the search to articles created on a given date (format YYYY-MM-DD).
created_beforestrnullLimit the search to articles created before a given date (format YYYY-MM-DD).
updated_afterstrnullLimit the search to articles updated after a given date (format YYYY-MM-DD).
updated_atstrnullLimit the search to articles updated on a given date (format YYYY-MM-DD).
updated_beforestrnullLimit the search to articles updated before a given date (format YYYY-MM-DD).
pageint1Page number. Used for scroll the pagination.
per_pageint25Maximum number of articles to retrieve per request
integrationZendeskHelpCenterIntegrationRef
botBotRefnullBot used to evaluate this trigger
actionTriggerActionEntry
ActionComponentSpec
Action executed if this trigger matches
whentyping.AnyCustom condition for when to evaluate this trigger
confidenceRealnullCustom confidence override value for trigger matches
expectExpectnull

Examples

Basic

triggers:
  - integration: integration.zendesk_help_center
    when: ANY
    expect: zendesk_help_center
steps:
  - say: STRING

Full

type: meya.zendesk.help_center.trigger
spec: '?'
query: STRING
label_names: STRING
locale: STRING
category: 123
section: 123
sort_by: position|title|created_at|updated_at
sort_order: asc|desc
created_after: STRING
created_at: STRING
created_before: STRING
updated_after: STRING
updated_at: STRING
updated_before: STRING
page: 123
per_page: 123
integration: integration.zendesk_help_center
bot: element.name
action: COMPONENT
when: ANY
confidence: 123
expect: zendesk_help_center