Third-Party Service Configuration Files

app/
└── services/
    └── <Service Name>/
        ├── config.json
        └── rules/
            └── <Rule Name>.json

Service Configuration

config.json

{
   "name": "<Service Name>",
   "type": "<Service Type>",
   "config": {
      "<Configuration Option>": <Configuration Value>
   },
   "secret_config": {
      "<Configuration Option>": "<Secret Name>"
   },
}

Field	Description
`name` String	The name of the service. The name may be at most 64 characters long and can only contain ASCII letters, numbers, underscores, and hyphens.
`type` String	The type of the service. Valid Options: `"aws"` `"twilio"` `"github"` `"gcm"`
`config` Document	A document with fields that map to additional configuration options for the service. The exact configuration fields depend on the service `type`. AWS Service Configuration Twilio Service Configuration GitHub Service Configuration
`secret_config` Document	A document where each field name is a private configuration field for the service and the value of each field is the name of a Secret that stores the configuration value.

Service Rules

Rules for a specific external service are defined in the /<service name>/rules sub-directory.

Each rule maps to its own JSON file with the same name as the rule.

<rule name>.json

{
  "name": "<Rule Name>",
  "actions": ["<Service Action Name>"],
  "when": { <JSON Expression> }
}

Field	Description
`name` String	The name of the service rule. The name may be at most 64 characters long and can only contain ASCII letters, numbers, underscores, and hyphens.
`actions` Array<String>	A list of service actions that the rule applies to. The specific actions available depend on the service `type`.
`when` Document	A rule expression that evaluates to `true` when the rule applies to a given request.

← Log Forwarder Configuration Files Atlas Device Sync Configuration Files →