Ampersand · Schema

Integration

Integration schema from Ampersand API

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
id string The integration ID.
projectId string The Ampersand project ID.
name string The integration name.
provider string The SaaS provider that this integration connects to.
createTime string The time the integration was created.
updateTime string The time the integration was last updated.
latestRevision object
View JSON Schema on GitHub

JSON Schema

ampersand-api-integration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-integration-schema.json",
  "title": "Integration",
  "description": "Integration schema from Ampersand API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The integration ID."
    },
    "projectId": {
      "type": "string",
      "description": "The Ampersand project ID.",
      "example": "project-456"
    },
    "name": {
      "type": "string",
      "description": "The integration name.",
      "example": "read-accounts"
    },
    "provider": {
      "type": "string",
      "description": "The SaaS provider that this integration connects to.",
      "example": "salesforce"
    },
    "createTime": {
      "type": "string",
      "description": "The time the integration was created.",
      "format": "date-time"
    },
    "updateTime": {
      "type": "string",
      "description": "The time the integration was last updated.",
      "format": "date-time"
    },
    "latestRevision": {
      "$ref": "#/components/schemas/Revision"
    }
  },
  "required": [
    "createTime",
    "id",
    "latestRevision",
    "name",
    "projectId",
    "provider"
  ]
}