Element details
type: meya.salesforce.knowledge.trigger
class: SalesforceKnowledgeTrigger
path: /meya/salesforce/knowledge/trigger/trigger.py
signature: expect
Fields
| field | description | required | signature | default | type |
|---|---|---|---|---|---|
| spec | Override the original spec for this element. | ○ | ○ | null | Spec |
| locale | The locale of the articles to be retrieved. Usually this should be set to the user's locale. | ○ | ○ | "en-US" | str |
| page_size | The maximum number of returned articles to be returned. | ○ | ○ | null | int |
| page_number | The specific page number to retrieve when a search query is broken up into multiple pages of articles. This allows you to page through the list of articles. | ○ | ○ | null | int |
| channel | Gives the possibility to select different scopes depending on the situation. | ○ | ○ | null | SalesforceKnowledgeChannel |
| order | Articles ordering, 'ASC' or 'DESC'. | ○ | ○ | null | SalesforceKnowledgeOrder |
| sort | Articles sort. | ○ | ○ | null | SalesforceKnowledgeSort |
| article_body_field_name | This is the specific field name you set in Salesforce to contain the body of an article. When this is set, the api will automatically fetch all body content for a list of articles in a search result. However, if it's not defined then the api will NOT fetch the article body content. | ○ | ○ | null | str |
| integration | ◉ | ○ | SalesforceKnowledgeIntegrationRef | ||
| 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. | ◉ | ○ | typing.Any | |
| confidence | Override the default confidence with a custom value for trigger matches. | ○ | ○ | null | Real |
| expect | ○ | ◉ | null | Expect | |
Usage reference
Basic
triggers:
- integration: integration.salesforce_knowledge
when: ANY
expect: salesforce_knowledge
steps:
- say: STRING
Full
type: meya.salesforce.knowledge.trigger
spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
locale: STRING
page_size: 123
page_number: 123
channel: App|Pkb|Csp|Prm
order: ASC|DESC
sort: LastPublishedDate|CreatedDate|Title|ViewScore
article_body_field_name: STRING
integration: integration.salesforce_knowledge
bot: element.name
action: COMPONENT
when: ANY
confidence: 123
expect: salesforce_knowledge