Xkit flavored JSON

Describe fields and event payloads with our prescribed syntax

Xkit flavored JSON is our take on how you can describe a data item to Xkit. This involves specifying the data type of the item, along with a human readable label and description.

You will need Xkit flavored JSON to define object fields and event payload schemas while calling CRM Link.

Here's an example of what an item that's defined via Xkit flavored JSON looks like:

name: {
  label: "Name",
  description: "Name of the Opportunity",
  type: "string",
  format: null
}

label (type string) is a short name that your users will identify the data item with.

description (type string) is an explanation that your users will typically see when associating a field from their CRM to the data item.

type (type string) and format (type string or null) together decide the data type of the item. This data type is used to determine what operations can be done with it along with assisting the user in selecting only compatible fields from their CRM.

Note that you can optionally omit the format key if its value is null

Different data types and how they should be defined are listed below:

String

  type: "string",
  format: null

Examples:

  • "Acme Inc"
  • "Some long string\nthat contains newlines"

Number

  type: "number",
  format: null

Examples:

  • 42.12
  • 1.0e5

Boolean

  type: "boolean",
  format: null

Examples:

  • true
  • false

Object

  type: "object",
  format: null

Examples:

  • { "lead_source": "Phone Inquiry" }

Date & Time (ISO 8601)

  type: "string",
  format: "datetime"

Examples:

  • "2022-09-01T10:00:00Z"
  • "2022-09-01T10:00:00+10:00"

Date (ISO 8601)

  type: "string",
  format: "date"

Examples:

  • "2022-09-01"

Ready to build your CRM app?

Integrate every CRM with one build, request access to get started.