Element details
type: meya.zendesk.help_center.trigger
class: ZendeskHelpCenterTrigger
path: /meya/zendesk/help_center/trigger/trigger.py
signature: expect
Fields
| field | description | required | signature | default | type |
|---|---|---|---|---|---|
| spec | Override the original spec for this element. | ○ | ○ | null | Spec |
| query | The search text to be matched or a search string. Examples: "bluetooth help", "'bluetooth help'". | ○ | ○ | null | str |
| label_names | A comma-separated list of label names. | ○ | ○ | null | str |
| locale | Search for articles in the specified locale. | ○ | ○ | null | str |
| category | Limit the search to this category id. | ○ | ○ | null | int |
| section | Limit the search to this section id. | ○ | ○ | null | int |
| sort_by | One of created_at or updated_at. Defaults to sorting by relevance. | ○ | ○ | null | ZendeskHelpCenterSortBy |
| sort_order | One of asc or desc. Defaults to desc. | ○ | ○ | null | ZendeskHelpCenterSortOrder |
| created_after | Limit the search to articles created after a given date (format YYYY-MM-DD). | ○ | ○ | null | str |
| created_at | Limit the search to articles created on a given date (format YYYY-MM-DD). | ○ | ○ | null | str |
| created_before | Limit the search to articles created before a given date (format YYYY-MM-DD). | ○ | ○ | null | str |
| updated_after | Limit the search to articles updated after a given date (format YYYY-MM-DD). | ○ | ○ | null | str |
| updated_at | Limit the search to articles updated on a given date (format YYYY-MM-DD). | ○ | ○ | null | str |
| updated_before | Limit the search to articles updated before a given date (format YYYY-MM-DD). | ○ | ○ | null | str |
| page | Page number. Used for scroll the pagination. | ○ | ○ | 1 | int |
| per_page | Maximum number of articles to retrieve per request | ○ | ○ | 25 | int |
| integration | ◉ | ○ | ZendeskHelpCenterIntegrationRef | ||
| bot | Bot used to evaluate this trigger. | ○ | ○ | null | BotRef |
| action | Action executed if this trigger matches. Check the trigger action guide for more info. | ◉ | ○ | TriggerActionEntry ActionComponentSpec | |
| when | Custom condition for when to evaluate this trigger. Check the trigger when guide for more info. | ◉ | ○ | Any | |
| confidence | Override the default confidence with a custom value for trigger matches. | ○ | ○ | null | Real |
| expect | ○ | ◉ | null | Expect | |
Usage reference
Basic
triggers:
- integration: integration.zendesk_help_center
when: ANY
expect: zendesk_help_center
steps:
- say: STRING
Full
type: meya.zendesk.help_center.trigger
spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
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