DEVELOPER PLATFORM · v1

An API you can build with

CRM, campaigns, analytics and integrations. Exact contracts, practical examples and signed webhooks.

Download OpenAPI

Private preview: use a project API key. Public SLA and support windows have not been established yet.

POST

Preview Developer Integration

/api/v1/developer/integrations/{installationId}/preview

Use the access scope below. The generated schemas specify the exact request and responses.

Access scopeintegrations.operations.read

Authorization: Bearer YOUR_PROJECT_TOKEN

Parameters

installationIdrequired · path: stringminLength: 1 · maxLength: 160
JSON Schema
{ "type": "string", "minLength": 1, "maxLength": 160 }

Request examples

curl --request POST 'https://YOUR_NOVA_HOST/api/v1/developer/integrations/INSTALLATION_ID/preview' --header 'Authorization: Bearer YOUR_PROJECT_TOKEN'

Responses

200 Integration import preview

application/json

object

countsrequired

object

Nested schema

object

contactrequired: integerminimum: 0
organizationrequired: integerminimum: 0
leadrequired: integerminimum: 0
dealrequired: integerminimum: 0
taskrequired: integerminimum: 0
activityrequired: integerminimum: 0
noterequired: integerminimum: 0

JSON Schema

{
  "type": "object",
  "properties": {
    "contact": {
      "type": "integer",
      "minimum": 0
    },
    "organization": {
      "type": "integer",
      "minimum": 0
    },
    "lead": {
      "type": "integer",
      "minimum": 0
    },
    "deal": {
      "type": "integer",
      "minimum": 0
    },
    "task": {
      "type": "integer",
      "minimum": 0
    },
    "activity": {
      "type": "integer",
      "minimum": 0
    },
    "note": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "contact",
    "organization",
    "lead",
    "deal",
    "task",
    "activity",
    "note"
  ],
  "additionalProperties": false
}

duplicateCountrequired

integerminimum: 0

unsupportedFieldsrequired

array

Nested schema

array

object

entityTyperequired: stringenum: ["contact","organization","lead","deal","task","activity","note"]
externalFieldrequired: stringminLength: 1 · maxLength: 100
reasonrequired: stringenum: ["not_mapped","unsupported_type","restricted"]

JSON Schema

{
  "type": "object",
  "properties": {
    "entityType": {
      "type": "string",
      "enum": [
        "contact",
        "organization",
        "lead",
        "deal",
        "task",
        "activity",
        "note"
      ]
    },
    "externalField": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "reason": {
      "type": "string",
      "enum": [
        "not_mapped",
        "unsupported_type",
        "restricted"
      ]
    }
  },
  "required": [
    "entityType",
    "externalField",
    "reason"
  ],
  "additionalProperties": false
}

JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "entityType": {
        "type": "string",
        "enum": [
          "contact",
          "organization",
          "lead",
          "deal",
          "task",
          "activity",
          "note"
        ]
      },
      "externalField": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "reason": {
        "type": "string",
        "enum": [
          "not_mapped",
          "unsupported_type",
          "restricted"
        ]
      }
    },
    "required": [
      "entityType",
      "externalField",
      "reason"
    ],
    "additionalProperties": false
  }
}

estimatedChangesrequired

object

Nested schema

object

createrequired: integerminimum: 0
updaterequired: integerminimum: 0
skiprequired: integerminimum: 0

JSON Schema

{
  "type": "object",
  "properties": {
    "create": {
      "type": "integer",
      "minimum": 0
    },
    "update": {
      "type": "integer",
      "minimum": 0
    },
    "skip": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "create",
    "update",
    "skip"
  ],
  "additionalProperties": false
}

profileVersionrequired

integerminimum: 0

fingerprintrequired

stringpattern: "^[a-f0-9]{64}$"

JSON Schema

{
  "type": "object",
  "properties": {
    "counts": {
      "type": "object",
      "properties": {
        "contact": {
          "type": "integer",
          "minimum": 0
        },
        "organization": {
          "type": "integer",
          "minimum": 0
        },
        "lead": {
          "type": "integer",
          "minimum": 0
        },
        "deal": {
          "type": "integer",
          "minimum": 0
        },
        "task": {
          "type": "integer",
          "minimum": 0
        },
        "activity": {
          "type": "integer",
          "minimum": 0
        },
        "note": {
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "contact",
        "organization",
        "lead",
        "deal",
        "task",
        "activity",
        "note"
      ],
      "additionalProperties": false
    },
    "duplicateCount": {
      "type": "integer",
      "minimum": 0
    },
    "unsupportedFields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "entityType": {
            "type": "string",
            "enum": [
              "contact",
              "organization",
              "lead",
              "deal",
              "task",
              "activity",
              "note"
            ]
          },
          "externalField": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "reason": {
            "type": "string",
            "enum": [
              "not_mapped",
              "unsupported_type",
              "restricted"
            ]
          }
        },
        "required": [
          "entityType",
          "externalField",
          "reason"
        ],
        "additionalProperties": false
      }
    },
    "estimatedChanges": {
      "type": "object",
      "properties": {
        "create": {
          "type": "integer",
          "minimum": 0
        },
        "update": {
          "type": "integer",
          "minimum": 0
        },
        "skip": {
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "create",
        "update",
        "skip"
      ],
      "additionalProperties": false
    },
    "profileVersion": {
      "type": "integer",
      "minimum": 0
    },
    "fingerprint": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    }
  },
  "required": [
    "counts",
    "duplicateCount",
    "unsupportedFields",
    "estimatedChanges",
    "profileVersion",
    "fingerprint"
  ],
  "additionalProperties": false,
  "$ref": "#/components/schemas/DeveloperIntegrationPreview"
}

400 Invalid integration preparation request

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

401 Invalid developer credential

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

403 Integration preparation access unavailable

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

404 Integration installation not found

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

409 Integration is not ready for preview

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

429 Developer API rate limit exceeded

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}

503 Developer API rate limiter unavailable

application/problem+json

object

type: stringformat: "uri" · default: "about:blank"
titlerequired: string
statusrequired: integerminimum: 100 · maximum: 599
detail: string
instance: string
errors: object

JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "format": "uri",
      "default": "about:blank"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    },
    "detail": {
      "type": "string"
    },
    "instance": {
      "type": "string"
    },
    "errors": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "title",
    "status"
  ]
}