Skip to main content

Config for rapidpro

Jobs that use the rapidpro adaptor may require authentication. A "credential" for the rapidpro adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "host": "https://app.rapidpro.io/",
  "token": "#Super-sSCrecrete-token"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "host": {
          "title": "Host",
          "type": "string",
          "default": "https://app.rapidpro.io/",
          "description": "instance host URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://app.rapidpro.io/"
          ]
      },
      "token": {
          "title": "Token",
          "type": "string",
          "description": "instance access token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "#Super-sSCrecrete-token"
          ]
      },
      "apiVersion": {
          "title": "API Version",
          "type": "string",
          "description": "API version to use. Leave this empty to use the default v2",
          "minLength": 1,
          "examples": [
              "v2"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "host",
      "token"
  ]
}