Skip to content

chore: update integration docs #510

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

Open
botpress-docs-actions wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: update integration docs #510

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
33 changes: 33 additions & 0 deletions snippets/integrations/cards/botpress/chat.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,39 @@

Here's a reference for all [Cards](/studio/concepts/cards/introduction) available with the integration:

### Publish Message Stream

<span>{"Publish a transient message stream delta or abort signal"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="conversationId"
type="string"
required
>
<span>{"Botpress conversation ID for the message stream"}</span>
</ResponseField>
<ResponseField
name="signal"
type="object | object"
required
>
<span>{"Transient message stream delta or abort signal"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
This Card has no output.
</ResponseField>

### Send Custom Event

<span>{"Send a custom event from the bot to the chat client"}</span>
Expand Down
54 changes: 0 additions & 54 deletions snippets/integrations/cards/botpress/desk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3564,60 +3564,6 @@ Available options: `triage`, `open`, `waiting`, `closed`
</Expandable>
</ResponseField>

### Request Approval

<span>{"Submit a tool action for agent review and approval before execution"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="ticketId"
type="string"
required
>
<span>{"The ID of the ticket"}</span>
</ResponseField>
<ResponseField
name="toolName"
type="string"
required
>
<span>{"The name of the tool being requested for approval"}</span>
</ResponseField>
<ResponseField
name="toolInput"
type="object"
required
>
<span>{"The input parameters for the tool"}</span>
</ResponseField>
<ResponseField
name="reasoning"
type="string"
>
<span>{"Optional explanation of why this action is being requested"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="approvalId"
type="string"
required
>
<span>{"The unique ID of the approval request"}</span>
</ResponseField>
</Expandable>
</ResponseField>

### Set Customer Attributes

<span>{"Set custom attributes on a customer"}</span>
Expand Down
8 changes: 7 additions & 1 deletion snippets/integrations/cards/botpress/fireworks-ai.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Here's a reference for all [Cards](/studio/concepts/cards/introduction) availabl
>
<span>{"Model to use for content generation"}</span>

Available options: `accounts/fireworks/models/deepseek-r1-0528`, `accounts/fireworks/models/deepseek-v3-0324`, `accounts/fireworks/models/llama4-maverick-instruct-basic`, `accounts/fireworks/models/llama4-scout-instruct-basic`, `accounts/fireworks/models/llama-v3p3-70b-instruct`, `accounts/fireworks/models/llama-v3p1-70b-instruct`, `accounts/fireworks/models/llama-v3p1-8b-instruct`, `accounts/fireworks/models/mixtral-8x22b-instruct`, `accounts/fireworks/models/mythomax-l2-13b`, `accounts/fireworks/models/gemma2-9b-it`, `accounts/fireworks/models/gpt-oss-20b`, `accounts/fireworks/models/gpt-oss-120b`
Available options: `accounts/fireworks/models/llama4-maverick-instruct-basic`, `accounts/fireworks/models/llama4-scout-instruct-basic`, `accounts/fireworks/models/llama-v3p3-70b-instruct`, `accounts/fireworks/models/llama-v3p1-70b-instruct`, `accounts/fireworks/models/llama-v3p1-8b-instruct`, `accounts/fireworks/models/mixtral-8x22b-instruct`, `accounts/fireworks/models/mythomax-l2-13b`, `accounts/fireworks/models/gemma2-9b-it`, `accounts/fireworks/models/gpt-oss-20b`, `accounts/fireworks/models/gpt-oss-120b`
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -262,6 +262,12 @@ Available options: `text`, `json_object`
type="string"
>
<span>{"Name of the integration that originally received the message that initiated this action"}</span>
</ResponseField>
<ResponseField
name="metadata"
type="object"
>
<span>{"Arbitrary key-value metadata to attach to usage records for this call, e.g. a conversationId to break down usage by conversation"}</span>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down
Loading
Loading