Skip to main content

Config for vtiger

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

{
  "hostUrl": "https://openfunction.od2.vtiger.com",
  "username": "test@openfn.org",
  "accessToken": "@some()!veryHugeToke"
}

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": {
      "hostUrl": {
          "title": "Host URL",
          "type": "string",
          "description": "VTiger instance host URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://openfunction.od2.vtiger.com"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "VTiger instance username",
          "minLength": 1,
          "examples": [
              "test@openfn.org"
          ]
      },
      "accessToken": {
          "title": "Access Token",
          "type": "string",
          "description": "VTiger instance access token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@some()!veryHugeToke"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "hostUrl",
      "username",
      "accessToken"
  ]
}