Skip to content

Configuring SLAB

Tyler Conlee edited this page Mar 7, 2019 · 3 revisions

Configuring SLAB

The configuration .toml contains everything that SLAB needs in order to know where to get the tickets from, and where to send the tickets to, as well as what the SLA structure looks like. This allows for complete customization of SLA policies and means that SLAB is flexible enough for use with any Zendesk or Slack instance.

Example Configuration

Within your configuration file, you should have this structure:

LogLevel = ""
TriageEnabled = true
Port = 0

[Zendesk]
  User = "<ZENDESK-USER>"
  APIKey = "<ZENDESK-APIKEY>"
  URL = "<ZENDESK-URL>"

[Postgres]
  Host = "localhost"
  Port = 5432
  User = "<POSTGRES-USER>"
  Password = "<POSTGRES-PASSWORD>"
  DBName = "<POSTGRES-DBNAME"

[Slack]
  APIKey = ""
  ChannelID = "<SLACK-CHANNEL-ID>"

Configuration Definitions

UpdateFreq - in the form of 8h, 9m, 1s, etc. Used to set the update loop. Default should be set to 2m.

Zendesk - This category contains the configuration options for connecting to a Zendesk instance.

  • User - the user associated with your Zendesk API login. Should end in +token (ex. tyler@test-account.com+token)
  • APIKey - the API key associated with your Zendesk API login.
  • URL - the URL to your Zendesk instance (ex. https://test.zendesk.com)

Zendesk user and API key can be found within the Settings of your Zendesk instance. More information can be found here on generating a Zendesk API key and username.

Slack - This category contains the configuration options for connecting to a Slack instance.

  • APIKey - the bot user key associated with your Slack app.
  • ChannelID - the ID of the channel SLAB should be mostly used in. tylerconlee/slack-channels can provide the ID.

The Slack integration is done as part of a bot user in Slack. Once that has been set up, you're given a token for your bot.

Clone this wiki locally