Skip to main content

Test Connection

PUT /v1/integration/instance/connect

Tests the connection to an integration instance by validating the configuration and attempting to establish communication with the external service. Returns the current connection status and available actions if the test succeeds, or error details if it fails.

Request Body​

{
    "status": {
      "enabled": true,
      "connected": true
    },
    "_id": "<object-id>",
    "__v": 0,
    "actions": [
      "account:create",
      "order:create",
      "account:list",
      "account:export",
      "product:list"
    ],
    "configuration": [
      {
        "related": {
          "to": "url",
          "with": "relatedValue"
        },
        "uuid": "env",
        "label": "Environment",
        "description": "",
        "type": "select",
        "required": false,
        "options": [
          {
            "label": "Production",
            "value": "production",
            "relatedValue": "https://example.com/v2",
            "disabled": true
          },
          {
            "label": "Sandbox",
            "value": "sandbox",
            "relatedValue": "https://api.example.com/v2",
            "disabled": true
          },
          {
            "label": "Custom",
            "value": "custom",
            "relatedValue": "",
            "disabled": false
          }
        ],
        "isEncrypted": false,
        "defaultValue": null,
        "enabled": true,
        "_id": "<object-id>",
        "value": "sandbox"
      },
      {
        "uuid": "url",
        "label": "URL",
        "description": "",
        "type": "textInput",
        "required": false,
        "options": [],
        "isEncrypted": false,
        "defaultValue": null,
        "enabled": true,
        "_id": "<object-id>",
        "value": "https://api.example.com/v2"
      },
      {
        "uuid": "100",
        "label": "Employee Token",
        "description": "",
        "type": "passwordInput",
        "required": true,
        "options": [],
        "isEncrypted": true,
        "defaultValue": null,
        "enabled": true,
        "_id": "<object-id>",
        "value": "<encrypted-token>"
      },
      {
        "uuid": "200",
        "label": "Consumer Token",
        "description": "",
        "type": "passwordInput",
        "required": true,
        "options": [],
        "isEncrypted": true,
        "defaultValue": null,
        "enabled": true,
        "_id": "<object-id>",
        "value": "<encrypted-token>"
      },
      {
        "uuid": "300",
        "label": "Product import and export",
        "description": "Enable product import and export for this integration",
        "type": "switch",
        "required": false,
        "options": [],
        "isEncrypted": false,
        "defaultValue": "true",
        "enabled": false,
        "_id": "<object-id>",
        "value": "true"
      },
      {
        "uuid": "400",
        "label": "Create account",
        "description": "Automatically create accounts in Tripletex",
        "type": "switch",
        "required": false,
        "options": [],
        "isEncrypted": false,
        "defaultValue": "true",
        "enabled": false,
        "_id": "<object-id>",
        "value": "true"
      },
      {
        "uuid": "500",
        "label": "Create order",
        "description": "Automatically create order in Tripletex on confirmed order",
        "type": "switch",
        "required": false,
        "options": [],
        "isEncrypted": false,
        "defaultValue": "true",
        "enabled": false,
        "_id": "<object-id>",
        "value": "true"
      },
      {
        "uuid": "600",
        "label": "Create products",
        "description": "Automatically create products in Tripletex",
        "type": "switch",
        "required": false,
        "options": [],
        "isEncrypted": false,
        "defaultValue": "false",
        "enabled": false,
        "_id": "<object-id>",
        "value": "false"
      }
    ],
    "description": "Tripletex is a modern and user friendly accounting system.",
    "logo": "https://api.example.com/v1/files/public/icons/integration.png",
    "name": "Tripletex ",
    "provider": "tripletex",
    "type": "accountant",
    "id": "<object-id>",
    "tenant": "<tenant-id>",
    "workers": [
      "<worker-id>"
    ],
    "integrationId": "<object-id>"
  }