zendesk.base

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

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

enabled

bool

true

Enables the integration, allowing it to process events and HTTP entries

filter

IntegrationFilter

rx_sub: true
rx: true
tx: true
tx_pub: true

verify_token

str

null

max_attachment_size

int

null

Controls maximum attachment size supported by the integration in bytes

subdomain

str

The subdomain of your Zendesk instance. You'll find this in the actual URL of your Zendesk instance e.g. https://subdomain.zendesk.com/

bot_agent_email

str

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.

bot_agent_api_token

str

The API token of the user you created to represent the bot agent.

Examples

Basic

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

Full

type: meya.zendesk.base.integration
spec: '?'
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