Extract Integrations

Trigger Extract Integration

Trigger extract integration on historic conversations

post

/v1/integration/extract/{extractIntegrationId}/trigger

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

extractIntegrationIdstring* Required

The ID of the Extract integration

Request Body * Required

Request Body Schema: application/json

conversationIdsarray

Array of conversation IDs to process

sampleinteger

Number of recent conversations to process (default 20)


import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({
secret: process.env.CHATBOTKIT_API_KEY!
})

const response = await cbk.integration.extract.trigger(
extractIntegrationId, 
{"conversationIds":["string"
],
"sample":"integer"
}
)

{"id":"string",
"triggered":"number"
}

Extract integration trigger initiated successfully

Go to cbk.ai