slack.md

Slack Integration

The Slack integration config defines the slack account and settings in order to get updates from ChargeHive to be sent to slack.

Format

As with all configs, the standard wrapper is used.

{
  "kind": "Integration.Slack",            // Must be set to "Integration.Slack"
  "metadata": {
    "projectId": "test-project",          // Must be set to the ChargeHive Project ID you were issued with
    "name": "test-slack-integration"      // Set this to a memorable name for the slack integration, no spaces, all lowercase
  },
  "specVersion": "v1",                    // Must be set to the correct version
  "selector": {},                         // May be used to apply this to a subset of charges
  "spec": {
    "accessToken": "xxxxxxxxxxx",         // AccessToken slack access token
    "scopes": [
      "xxxxxxxxxxx"                       // Scopes for OAuth authentication
    ],
    "teamName": "xxxxxxxxxxx",            // TeamName for posting
    "teamID": "xxxxxxxxxxx",              // TeamID for posting
    "webhook": {                          // Webhook endpoint
      "url": "",                          // Url is the slack webhook URL
      "channel": "",                      // Channel is the slack channel to post in
      "configurationUrl": ""              // ConfigurationUrl is the slack endpoint for configuration
    },
    "transactionNotifications": true     // TransactionNotifications indicates the action to perform
  }
}

Full Example

{
  "kind": "Integration.Slack",
  "metadata": {
    "projectId": "test-project",
    "name": "test-slack-integration"
  },
  "specVersion": "v1",
  "selector": {},
  "spec": {
    "accessToken": "xxxxxxxxxxx",
    "scopes": [
      "xxxxxxxxxxx"
    ],
    "teamName": "xxxxxxxxxxx",
    "teamID": "xxxxxxxxxxx",
    "webhook": {
      "url": "",
      "channel": "",
      "configurationUrl": ""
    },
    "transactionNotifications": true
  }
}