GitHub Integrations
Create Github Integration
Create GitHub integration
Authorization
ChatBotKit API Secret * Required
HTTP Authorization Scheme: bearer
Request Body * Required
Request Body Schema: application/json
aliasstring
The unique alias for the instance
namestring
The associated name
descriptionstring
The associated description
metaobject
Meta data information
blueprintIdstring
The ID of the blueprint
botIdstring
The ID of the bot this configuration is using
appIdstring
This integration's GitHub App id (signs the App JWT)
privateKeystring
This integration's GitHub App private key (PEM)
webhookSecretstring
The GitHub App webhook secret used to validate x-hub-signature-256
contactCollectionboolean
Whether to collect contacts
sessionDurationnumber
The session duration for the GitHub integration
autoRespondstring
When the bot replies to messages that are not addressed to it. Direct messages and mentions of the bot always get a reply. Leave empty to reply only when addressed (the bot keeps replying in conversations it is already part of), use '@all' to reply to every message, '@auto' to let the bot decide from its name, description and backstory, or write instructions describing which messages to reply to ('@agent <instructions>' is accepted and treated the same). Stored for consistency with other integrations; this integration does not apply it yet and answers every message it receives as before.
allowFromstring
Restricts who can summon the bot. Comma or newline separated list of `@collaborators`, `@login`, `owner/repo`, `owner/*` or `*`. Defaults to `@collaborators`.
import { ChatBotKit } from '@chatbotkit/sdk'
const cbk = new ChatBotKit({
token: process.env.CHATBOTKIT_API_TOKEN!
})
const response = await cbk.integration.github.create(
{)"alias":"string","name":"string","description":"string","meta":"object","blueprintId":"string","botId":"string","appId":"string","privateKey":"string","webhookSecret":"string","contactCollection":"boolean","sessionDuration":"number","autoRespond":"string",}"allowFrom":"string"
{"id":"string"}