For AI agents: the docs index is at https://docs.xkit.co/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Xkit Site Guides API Reference Support Sign up

Guides API Reference

Xkit Site Guides API Reference Support Sign up Log In

API Reference

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 IDdel
List Connectionsget
List Web Originsget
Create Web Originpost
Delete Web Origindel
List Credentialsget

Webhooks

Overview
Payload Types
- Connector
- Context
Connection

xkit.js

xkit.js
Installing xkit.js
Authenticating xkit.js
Type Definitions
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
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

Platform API v1

Getting Started With Your API

Type Definitions

For typescript users, these are available in the GitHub Repository and the npm package.

Updated almost 6 years ago

Updated almost 6 years ago