English
Integration contracts
These exports cover integrations beyond REST and SCIM. Full structures are available in the package's TypeScript declarations.
Outgoing webhooks
@2chevskii/kaiten-client/webhooks · KaitenWebhookEvent
| Event | Type | Documentation |
|---|---|---|
block:add | BlockAddWebhookEvent | Kaiten |
block:update | BlockUpdateWebhookEvent | Kaiten |
board:add | BoardAddWebhookEvent | Kaiten |
board:update | BoardUpdateWebhookEvent | Kaiten |
card_member:add | CardMemberAddWebhookEvent | Kaiten |
card_member:remove | CardMemberRemoveWebhookEvent | Kaiten |
card_member:update | CardMemberUpdateWebhookEvent | Kaiten |
card:add | CardAddWebhookEvent | Kaiten |
card:update | CardUpdateWebhookEvent | Kaiten |
comment:add | CommentAddWebhookEvent | Kaiten |
comment:remove | CommentRemoveWebhookEvent | Kaiten |
comment:update | CommentUpdateWebhookEvent | Kaiten |
file:add | FileAddWebhookEvent | Kaiten |
file:remove | FileRemoveWebhookEvent | Kaiten |
file:update | FileUpdateWebhookEvent | Kaiten |
space:update | SpaceUpdateWebhookEvent | Kaiten |
tag:add | TagAddWebhookEvent | Kaiten |
tag:remove | TagRemoveWebhookEvent | Kaiten |
tag:update | TagUpdateWebhookEvent | Kaiten |
card_time_log:add | TimelogAddWebhookEvent | Kaiten |
card_time_log:remove | TimelogRemoveWebhookEvent | Kaiten |
card_time_log:update | TimelogUpdateWebhookEvent | Kaiten |
Import files
@2chevskii/kaiten-client/imports · ImportEntityName · ImportColor
| File | Record type | Documentation |
|---|---|---|
boards | ImportBoardsRecord | Kaiten |
card-timers | ImportCardTimersRecord | Kaiten |
cards | ImportCardsRecord | Kaiten |
columns | ImportColumnsRecord | Kaiten |
columns-mapping | ImportColumnsMappingRecord | Kaiten |
comments | ImportCommentsRecord | Kaiten |
custom-fields | ImportCustomFieldsRecord | Kaiten |
document-files | ImportDocumentFilesRecord | Kaiten |
documents | ImportDocumentsRecord | Kaiten |
files | ImportFilesRecord | Kaiten |
folders | ImportFoldersRecord | Kaiten |
meta-data | ImportMetaDataRecord | Kaiten |
properties-mapping | ImportPropertiesMappingRecord | Kaiten |
spaces | ImportSpacesRecord | Kaiten |
users | ImportUsersRecord | Kaiten |
User metadata
@2chevskii/kaiten-client/metadata exports UserMetadataRequest, UserMetadataResponse, UserMetadataPropertyValue, and UserMetadataHandler. See the guide.
Addons
@2chevskii/kaiten-client/addons exports browser SDK declarations: KaitenAddonSdk, AddonCapabilities, AddonContext, AddonPlatformApiClient, AddonPopupOptions, AddonDialogOptions, and related types. @2chevskii/kaiten-client/addon-oauth exports AddonOAuthClient, AddonOAuthOptions, AddonTokenKey, and AddonTokenResponse; the getToken and refreshToken methods are covered in the guide.