zendesk.help_center

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

Fields

field

signature

required

type

default

description               

spec

Spec

null

Override the original spec for this element

query

str

null

The search text to be matched or a search string. Examples: "bluetooth help", "'bluetooth help'".

label_names

str

null

A comma-separated list of label names.

locale

str

null

Search for articles in the specified locale.

category

int

null

Limit the search to this category id.

section

int

null

Limit the search to this section id.

sort_by

ZendeskHelpCenterSortBy

null

One of created_at or updated_at. Defaults to sorting by relevance.

sort_order

ZendeskHelpCenterSortOrder

null

One of asc or desc. Defaults to desc.

created_after

str

null

Limit the search to articles created after a given date (format YYYY-MM-DD).

created_at

str

null

Limit the search to articles created on a given date (format YYYY-MM-DD).

created_before

str

null

Limit the search to articles created before a given date (format YYYY-MM-DD).

updated_after

str

null

Limit the search to articles updated after a given date (format YYYY-MM-DD).

updated_at

str

null

Limit the search to articles updated on a given date (format YYYY-MM-DD).

updated_before

str

null

Limit the search to articles updated before a given date (format YYYY-MM-DD).

page

int

1

Page number. Used for scroll the pagination.

per_page

int

25

Maximum number of articles to retrieve per request

integration

ZendeskHelpCenterIntegrationRef

bot

BotRef

null

Bot used to evaluate this trigger

action

TriggerActionEntry
ActionComponentSpec

Action executed if this trigger matches

when

typing.Any

Custom condition for when to evaluate this trigger

confidence

Real

null

Custom confidence override value for trigger matches

expect

Expect

null

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:
  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