Config for telerivet

Jobs that use the telerivet adaptor may require authentication. A "credential" for the telerivet 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.

{
  "projectId": "telerivet_project_id",
  "apiKey": "telerivet_api_key"
}

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": {
      "projectId": {
          "title": "Project ID",
          "type": "string",
          "description": "Your Telerivet project id",
          "minLength": 1,
          "examples": [
              "telerivet_project_id"
          ]
      },
      "apiKey": {
          "title": "API Key",
          "type": "string",
          "description": "Your Telerivet API Key",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "telerivet_api_key"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "projectId",
      "apiKey"
  ]
}