Kombo · Schema

PostPassthroughToolApiPositiveResponse

ATSEmbedded iPaaSHRISLMSPayrollUnified API

Properties

Name Type Description
status string
data object
warnings array These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.
View JSON Schema on GitHub

JSON Schema

kombo-postpassthroughtoolapipositiveresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostPassthroughToolApiPositiveResponse",
  "title": "PostPassthroughToolApiPositiveResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "description": "The full URL of the request that we automatically assemble for you based on the specified `api`, the specified `path`, and the integration's auth credentials. You can use this to debug path-related issues (e.g., the API returning 404 errors)."
        },
        "status": {
          "type": "integer",
          "format": "int64",
          "description": "The HTTP status code returned from the remote system."
        },
        "headers": {
          "type": "object",
          "additionalProperties": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          },
          "description": "The HTTP headers returned from the remote system."
        },
        "data": {
          "description": "The HTTP body returned from the remote system. This will either be an array or object (in the case that JSON was returned) or a string (in any other case)."
        }
      },
      "required": [
        "url",
        "status",
        "headers"
      ],
      "examples": [
        {
          "url": "https://api.personio.de/v1/company/employees",
          "status": 200,
          "headers": {
            "content-type": "application/json"
          },
          "data": {
            "success": true,
            "data": [
              {
                "id": 123,
                "first_name": "John",
                "last_name": "Doe"
              }
            ]
          }
        }
      ]
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        },
        "required": [
          "message"
        ]
      },
      "description": "These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console."
    }
  },
  "required": [
    "status",
    "data",
    "warnings"
  ]
}