Jump to Content
XkitXkit SiteGuidesAPI ReferenceSupportSign up
GuidesAPI Reference
Xkit SiteGuidesAPI ReferenceSupportSign upLog InXkit
API Reference
Log In

Platform API

  • Getting Started with the Platform API
  • Platform Authentication
  • Create Contextpost
  • Update Platform Contextput
  • Get Connection by Connectorget
  • Get Connection by IDget
  • Delete Connection by IDdelete
  • List Connectionsget
  • List Web Originsget
  • Create Web Originpost
  • Delete Web Origindelete
  • List Credentialsget

Webhooks

  • Overview
  • Payload Types
    • Connector
    • Context
  • Connection
    • Enabled
    • Disabled
    • Errored

xkit.js

  • xkit.js
  • Installing xkit.js
  • Authenticating xkit.js
  • Type Definitions
    • Authorization
    • Authorizer
    • Authorizer Prototype
    • Platform
    • Connector
    • Connection
    • ConnectionShell
    • TokenCallback
  • ready
  • onUpdate
  • login
  • logout
  • getPlatform
  • getConnection
  • getConnectionOrConnector
  • getConnectionToken
  • connect
  • reconnect
  • disconnect
  • addConnection
  • removeConnection
  • listConnectors
  • listConnections
  • on
  • off

xkit-catalog.js

  • xkit-catalog.js
  • Installing xkit-catalog.js
  • Configuring xkit-catalog.js
  • Type Definitions
    • Catalog
    • Gradient
    • Button
    • Fonts
    • Text Colors
    • Card
    • Tab
    • Catalog Theme
    • Catalog Filter
    • Settings Field
    • Settings Text Field
    • Settings Select Field
    • Settings Switch Field
    • Catalog Settings
  • renderCatalogDefault
  • renderCatalog
  • unmountCatalog

CRM API

  • Get Schema
    • Get CRM OBJECT Schemaget
  • Get CRM Object
    • Get CRM OBJECT data by CRM IDget
    • Batch get CRM OBJECTs by CRM IDget
  • Call Events
    • Call a collection CRM EVENTpost
    • Call an object CRM EVENTpost
  • Webhook Subscriptions
    • Create a CRM EVENT Webhook subscriptionpost
    • Remove a CRM EVENT Webhook subscriptiondelete
    • Create a CRM OBJECT Webhook subscriptionpost
    • Remove a CRM OBJECT Webhook subscriptiondelete

Platform API v1

  • Getting Started With Your API

Settings Field

An object specifying a field in an integration's configuration

This is one of Settings Text Field, Settings Select Field or Settings Switch Field.