Element details

type: meya.zendesk.base.integration
class: ZendeskBaseIntegration
path: /meya/zendesk/base/integration/integration.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
enabled	Enables the integration, allowing it to process events and HTTP/WS entries.	○	○	true	bool
filter	Specifies the GridQL to filter `rx_sub`, `rx`, `tx`, `tx_pub`entries. Check the integration filtering guidefor more info.	○	○	rx_sub: true rx: true tx: true tx_pub: true	IntegrationFilter
verify_token	The token to be verified for each incoming request. You need to add the `verify_token=YOUR_TOKEN` query parameter to integration's webhook URL.	○	○	null	str
max_attachment_size	Controls maximum attachment size supported by the integration in bytes.	○	○	null	int
subdomain	The subdomain of your Zendesk instance. You'll find this in the actual URL of your Zendesk instance e.g. https://subdomain.zendesk.com/	◉	○		str
bot_agent_email	The email address of the Zendesk user you created to represent the bot agent. All API calls the integration makes will use this user's Zendesk API token.	◉	○		str
bot_agent_api_token	The API token of the user you created to represent the bot agent.	◉	○		str

Usage reference

Basic

type: meya.zendesk.base.integration
subdomain: STRING
bot_agent_email: STRING
bot_agent_api_token: STRING

Full

type: meya.zendesk.base.integration
spec:
  type: STRING
  data:
    STRING: ANY
  timeout: 123
  trigger_when: ANY
enabled: false
filter:
  rx_sub: STRING
  rx: STRING
  tx: STRING
  tx_pub: STRING
verify_token: STRING
max_attachment_size: 123
subdomain: STRING
bot_agent_email: STRING
bot_agent_api_token: STRING