Skip to content

chore: update integration docs #484

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 #484

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
892 changes: 892 additions & 0 deletions snippets/integrations/cards/botpress/freshdesk.mdx
View file
Open in desktop

Large diffs are not rendered by default.

224 changes: 224 additions & 0 deletions snippets/integrations/cards/botpress/hubspot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -744,6 +744,13 @@ Here's a reference for all [Cards](/studio/concepts/cards/introduction) availabl
<span>{"The properties of the contact"}</span>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField
name="url"
type="string"
required
>
<span>{"The URL to the contact's page in the HubSpot UI"}</span>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -820,6 +827,39 @@ Here's a reference for all [Cards](/studio/concepts/cards/introduction) availabl
</Expandable>
</ResponseField>

### Get File URL

<span>{"Get a URL to access a file stored in Hubspot Files"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="fileName"
type="string"
required
>
<span>{"The path to the Hubspot file"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="url"
type="string"
>
<span>{"The URL of the file, or undefined if not available"}</span>
</ResponseField>
</Expandable>
</ResponseField>

### Get Lead

<span>{"Get a lead from HubSpot"}</span>
Expand Down Expand Up @@ -892,6 +932,178 @@ Here's a reference for all [Cards](/studio/concepts/cards/introduction) availabl
</Expandable>
</ResponseField>

### Get Owner

<span>{"Get a Hubspot owner (user) by ID. Used to resolve owner references on contacts, deals, etc."}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="ownerId"
type="string"
required
>
<span>{"The ID of the owner to fetch"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="owner"
type="object"
>
<span>{"The owner found, or undefined if not found"}</span>

<Expandable>
<ResponseField
name="id"
type="string"
required
>
<span>{"The ID of the owner"}</span>
</ResponseField>
<ResponseField
name="email"
type="string"
>
<span>{"The email of the owner"}</span>
</ResponseField>
<ResponseField
name="firstName"
type="string"
>
<span>{"The first name of the owner"}</span>
</ResponseField>
<ResponseField
name="lastName"
type="string"
>
<span>{"The last name of the owner"}</span>
</ResponseField>
<ResponseField
name="userId"
type="number"
>
<span>{"The Hubspot user ID associated with the owner"}</span>
</ResponseField>
<ResponseField
name="type"
type="string"
required
>
<span>{"The type of owner (e.g. PERSON, QUEUE)"}</span>
</ResponseField>
<ResponseField
name="archived"
type="boolean"
required
>
<span>{"Whether the owner is archived"}</span>
</ResponseField>
<ResponseField
name="createdAt"
type="string"
required
>
<span>{"The date and time the owner was created"}</span>
</ResponseField>
<ResponseField
name="updatedAt"
type="string"
required
>
<span>{"The date and time the owner was last updated"}</span>
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>

### List Contact Properties

<span>{"List all available Hubspot contact properties with their metadata"}</span>

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

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="properties"
type="array"
required
>
<span>{"The contact properties defined in this Hubspot account"}</span>

<Expandable title="array item properties">
<ResponseField
name="name"
type="string"
required
>
<span>{"The internal name of the property"}</span>
</ResponseField>
<ResponseField
name="label"
type="string"
required
>
<span>{"The human-readable label of the property"}</span>
</ResponseField>
<ResponseField
name="type"
type="string"
required
>
<span>{"The data type of the property (e.g. string, number, date, datetime, enumeration, bool)"}</span>
</ResponseField>
<ResponseField
name="fieldType"
type="string"
required
>
<span>{"The form field type of the property (e.g. text, textarea, select, radio, checkbox)"}</span>
</ResponseField>
<ResponseField
name="groupName"
type="string"
required
>
<span>{"The internal name of the property group"}</span>
</ResponseField>
<ResponseField
name="description"
type="string"
required
>
<span>{"The description of the property"}</span>
</ResponseField>
<ResponseField
name="referencedObjectType"
type="string"
>
<span>{"The type of object referenced by this property (e.g. OWNER), if any"}</span>
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>

### List Contacts

<span>{"List contacts in HubSpot"}</span>
Expand Down Expand Up @@ -1099,6 +1311,12 @@ Here's a reference for all [Cards](/studio/concepts/cards/introduction) availabl
type="string"
>
<span>{"The phone number of the contact to search for"}</span>
</ResponseField>
<ResponseField
name="properties"
type="array"
>
<span>{"The list of property names to fetch on the matching contact. Defaults to all properties."}</span>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -1158,6 +1376,12 @@ Here's a reference for all [Cards](/studio/concepts/cards/introduction) availabl
<span>{"The properties of the contact"}</span>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField
name="url"
type="string"
>
<span>{"The URL to the contact's page in the HubSpot UI, or undefined if no contact was found"}</span>
</ResponseField>
</Expandable>
</ResponseField>
Expand Down
Loading
Loading