Skip to content

chore: update integration docs #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chloequijano-botpress merged 1 commit into from
Apr 6, 2026
Merged

chore: update integration docs #447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,283 changes: 2,141 additions & 142 deletions snippets/integrations/cards/botpress/airtable.mdx
View file
Open in desktop

Large diffs are not rendered by default.

1,264 changes: 261 additions & 1,003 deletions snippets/integrations/cards/botpress/desk.mdx
View file
Open in desktop

Large diffs are not rendered by default.

1,737 changes: 1,737 additions & 0 deletions snippets/integrations/cards/botpress/discord.mdx
View file
Open in desktop

Large diffs are not rendered by default.

599 changes: 599 additions & 0 deletions snippets/integrations/cards/botpress/kommo.mdx
View file
Open in desktop

Large diffs are not rendered by default.

729 changes: 729 additions & 0 deletions snippets/integrations/cards/botpress/salesforce.mdx
View file
Open in desktop

Large diffs are not rendered by default.

127 changes: 125 additions & 2 deletions snippets/integrations/cards/botpress/slack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,124 @@ Available options: `dm`, `channel`
</Expandable>
</ResponseField>

### Get Channels Info

<span>{"Get information about Slack channels one page at a time. Returns channel details for the current page and a cursor for the next page."}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="includeArchived"
type="boolean"
>
<span>{"Whether to include archived channels in the results"}</span>
</ResponseField>
<ResponseField
name="includePrivate"
type="boolean"
>
<span>{"Whether to include private channels in the results"}</span>
</ResponseField>
<ResponseField
name="cursor"
type="string"
>
<span>{"Pagination cursor for fetching the next page of channels. Omit for the first page."}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="channels"
type="array"
required
>
<span>{"List of channels on this page"}</span>

<Expandable title="array item properties">
<ResponseField
name="id"
type="string"
required
>
<span>{"The Slack ID of the channel"}</span>
</ResponseField>
<ResponseField
name="name"
type="string"
required
>
<span>{"The name of the channel"}</span>
</ResponseField>
<ResponseField
name="topic"
type="string"
required
>
<span>{"The topic of the channel"}</span>
</ResponseField>
<ResponseField
name="purpose"
type="string"
required
>
<span>{"The purpose of the channel"}</span>
</ResponseField>
<ResponseField
name="numMembers"
type="number"
required
>
<span>{"The number of members in the channel"}</span>
</ResponseField>
<ResponseField
name="isPrivate"
type="boolean"
required
>
<span>{"Whether the channel is private"}</span>
</ResponseField>
<ResponseField
name="isArchived"
type="boolean"
required
>
<span>{"Whether the channel is archived"}</span>
</ResponseField>
<ResponseField
name="creator"
type="string"
required
>
<span>{"The Slack user ID of the channel creator"}</span>
</ResponseField>
<ResponseField
name="created"
type="number"
required
>
<span>{"The Unix timestamp of when the channel was created"}</span>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField
name="nextCursor"
type="string"
required
>
<span>{"Cursor for the next page. Empty string if no more pages."}</span>
</ResponseField>
</Expandable>
</ResponseField>

### Get User Profile

<span>{"Get information about a user"}</span>
Expand Down Expand Up @@ -230,9 +348,14 @@ Available options: `dm`, `channel`
<ResponseField
name="channelName"
type="string"
required
>
<span>{"The name of the channel you want the conversation to be created at"}</span>
<span>{"[DEPRECATED] The name of the channel you want the conversation to be created at"}</span>
</ResponseField>
<ResponseField
name="channelId"
type="string"
>
<span>{"The ID of the channel you want the conversation to be created at"}</span>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down
188 changes: 186 additions & 2 deletions snippets/integrations/cards/botpress/whatsapp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,93 @@ Available options: `APPROVED`, `PENDING`, `REJECTED`, `PAUSED`, `DISABLED`, `ARC
name="templateVariablesJson"
type="string"
>
<span>{"JSON array representation of variable values to pass to the WhatsApp Message Template (if required by the template). Currently, only positional parameters are supported."}</span>
<span>{"Deprecated: use templateBodyParams instead. JSON array of body variable values: [\"val1\", \"val2\"]."}</span>
</ResponseField>
<ResponseField
name="templateHeaderParams"
type="object | object | object | object"
>
<span>{"Header parameter. For text headers: type=\"text\", value is the replacement text, parameterName is optional (for named params). For media headers: type=\"image\"|\"video\"|\"document\", url is the media URL. Documents may include a filename."}</span>
</ResponseField>
<ResponseField
name="templateBodyParams"
type="object | object"
>
<span>{"Body parameters. For positional params ({{1}}, {{2}}, ...): type=\"positional\", values is an ordered array of strings. For named params ({{buyer_name}}): type=\"named\", values is a record mapping param names to values."}</span>
</ResponseField>
<ResponseField
name="templateButtonParams"
type="array"
>
<span>{"Button parameters as an ordered array. url: value is the URL suffix. quick_reply: payload is the callback data. copy_code: code is the coupon code. skip: no parameter needed (for phone number buttons, etc.)."}</span>

<Tabs>
<Tab title="url">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="value"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
<Tab title="quick_reply">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="payload"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
<Tab title="copy_code">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="code"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
<Tab title="skip">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
</Tabs>
</ResponseField>
<ResponseField
name="botPhoneNumberId"
Expand All @@ -235,6 +321,12 @@ Available options: `APPROVED`, `PENDING`, `REJECTED`, `PAUSED`, `DISABLED`, `ARC
required
>
<span>{"ID of the conversation created"}</span>
</ResponseField>
<ResponseField
name="messageId"
type="string"
>
<span>{"ID of the message created"}</span>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -280,7 +372,93 @@ Available options: `APPROVED`, `PENDING`, `REJECTED`, `PAUSED`, `DISABLED`, `ARC
name="templateVariablesJson"
type="string"
>
<span>{"JSON array representation of variable values to pass to the WhatsApp Message Template (if required by the template). Currently, only positional parameters are supported."}</span>
<span>{"Deprecated: use templateBodyParams instead. JSON array of body variable values: [\"val1\", \"val2\"]."}</span>
</ResponseField>
<ResponseField
name="templateHeaderParams"
type="object | object | object | object"
>
<span>{"Header parameter. For text headers: type=\"text\", value is the replacement text, parameterName is optional (for named params). For media headers: type=\"image\"|\"video\"|\"document\", url is the media URL. Documents may include a filename."}</span>
</ResponseField>
<ResponseField
name="templateBodyParams"
type="object | object"
>
<span>{"Body parameters. For positional params ({{1}}, {{2}}, ...): type=\"positional\", values is an ordered array of strings. For named params ({{buyer_name}}): type=\"named\", values is a record mapping param names to values."}</span>
</ResponseField>
<ResponseField
name="templateButtonParams"
type="array"
>
<span>{"Button parameters as an ordered array. url: value is the URL suffix. quick_reply: payload is the callback data. copy_code: code is the coupon code. skip: no parameter needed (for phone number buttons, etc.)."}</span>

<Tabs>
<Tab title="url">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="value"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
<Tab title="quick_reply">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="payload"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
<Tab title="copy_code">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="code"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
<Tab title="skip">
<Expandable>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
</Expandable>
</Tab>
</Tabs>
</ResponseField>
<ResponseField
name="botPhoneNumberId"
Expand All @@ -304,6 +482,12 @@ Available options: `APPROVED`, `PENDING`, `REJECTED`, `PAUSED`, `DISABLED`, `ARC
required
>
<span>{"The Botpress ID of the created conversation"}</span>
</ResponseField>
<ResponseField
name="messageId"
type="string"
>
<span>{"ID of the message created"}</span>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down
Loading
Loading