diff --git a/snippets/integrations/cards/botpress/desk.mdx b/snippets/integrations/cards/botpress/desk.mdx new file mode 100644 index 00000000..ecb48088 --- /dev/null +++ b/snippets/integrations/cards/botpress/desk.mdx @@ -0,0 +1,2678 @@ +{/* This file is auto-generated. Do not edit directly. */} +{/* vale off */} + +Here's a reference for all [Cards](/studio/concepts/cards/introduction) available with the integration: + +### Add Tags + +{"Add tags to a ticket"} + + + + + {"The ID of the ticket"} + + + {"Array of tag names to add to the ticket"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Assign Ticket + +{"Assign a ticket to an admin or bot"} + + + + + {"The ID of the ticket to assign"} + + + {"The ID of the admin or bot to assign the ticket to (adm_ or ibot_)"} + + + + + + + + + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Close Ticket + +{"Close a ticket"} + + + + + {"The ID of the ticket to close"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Get Admin + +{"Get a single admin by ID"} + + + + + {"The unique identifier for the admin (adm_)"} + + + + + + + + + + + + {"The unique Desk identifier for the admin (adm_)"} + + + {"The name of the admin"} + + + {"The email address of the admin"} + + + {"URL of the admin avatar image"} + + + + + + +### Get Customer + +{"Get a single customer by ID"} + + + + + {"The unique identifier for the customer (cus_)"} + + + + + + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The email address of the customer"} + + + {"The name of the customer"} + + + {"URL of the customer avatar image"} + + + {"ISO timestamp of when the customer was last seen"} + + + {"ISO timestamp of when the customer was last contacted"} + + + {"A list of tags associated with the customer"} + + + {"Additional metadata associated with the customer"} + + + {"Attributes of the customer"} + + + + + + +### Get Ticket + +{"Get a single ticket by ID"} + + + + + {"The unique identifier for the ticket (tkt_)"} + + + + + + + + + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### List Admins + +{"List all admins in Desk"} + + + + + {"Cursor for pagination (admin ID to start from)"} + + + {"Number of admins to return"} + + + + + + + + + + + + {"The unique Desk identifier for the admin (adm_)"} + + + {"The name of the admin"} + + + {"The email address of the admin"} + + + {"URL of the admin avatar image"} + + + + + {"Whether there are more admins available"} + + + {"Cursor for the next page"} + + + + +### List Bots + +{"List all bots in Desk"} + + + + + {"Cursor for pagination (bot ID to start from)"} + + + {"Number of bots to return"} + + + + + + + + + + + + {"The unique Desk identifier for the bot (ibot_)"} + + + {"The display name of the bot"} + + + {"URL of the bot avatar image"} + + + {"The handle for @mentioning this bot"} + + + {"Whether this bot can be assigned to tickets"} + + + + + {"Whether there are more bots available"} + + + {"Cursor for the next page"} + + + + +### List Customers + +{"List all customers in Desk"} + + + + + {"Cursor for pagination (customer ID to start from)"} + + + {"Number of customers to return"} + + + + + + + + {"List of customers"} + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The email address of the customer"} + + + {"The name of the customer"} + + + {"URL of the customer avatar image"} + + + {"ISO timestamp of when the customer was last seen"} + + + {"ISO timestamp of when the customer was last contacted"} + + + {"A list of tags associated with the customer"} + + + {"Additional metadata associated with the customer"} + + + {"Attributes of the customer"} + + + + + {"Whether there are more customers available"} + + + {"Cursor for the next page"} + + + + +### List Ticket Activities + +{"List activities for a specific ticket with pagination"} + + + + + {"The ID of the ticket to get activities for"} + + + {"Cursor for pagination (activity ID to start from)"} + + + {"Number of activities to return"} + + + + + + + + {"List of activities"} + + + + {"The unique identifier for the activity"} + + + {"The ticket ID this activity belongs to"} + + + {"The type of activity"} + +Available options: `comment`, `note`, `system_public`, `system_internal` + + + {"The type of author"} + +Available options: `admin`, `customer`, `bot`, `user` + + + {"The ID of the author"} + + + {"The content of the activity"} + + + {"The format of the body"} + +Available options: `plain`, `html`, `markdown`, `json` + + + {"Whether the activity is redacted"} + + + {"ISO timestamp of when the activity was created"} + + + {"ISO timestamp of when the activity was last updated"} + + + + + {"Whether there are more activities available"} + + + {"Cursor for the next page"} + + + + +### List Tickets + +{"List tickets with pagination and sorting options"} + + + + + {"Cursor for pagination (ticket ID to start from)"} + + + {"Field to order by"} + +Available options: `id`, `createdAt`, `updatedAt`, `status`, `priority`, `title`, `closedAt`, `snoozedUntil`, `waitingSince` + + + {"Sort direction"} + +Available options: `asc`, `desc` + + + {"Number of tickets to return"} + + + + + + + + {"List of tickets"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + {"Whether there are more tickets available"} + + + {"Cursor for the next page"} + + + + +### Remove Tags + +{"Remove tags from a ticket"} + + + + + {"The ID of the ticket"} + + + {"Array of tag names to remove from the ticket"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Rename Ticket + +{"Change the title of a ticket"} + + + + + {"The ID of the ticket to rename"} + + + {"The new title for the ticket"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Reopen Ticket + +{"Reopen a closed ticket"} + + + + + {"The ID of the ticket to reopen"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Set Customer Attributes + +{"Set custom attributes on a customer"} + + + + + {"The unique identifier for the customer (cus_)"} + + + {"Key-value pairs to set as customer attributes. These will be merged with existing attributes."} + + + {"Optional ticket ID to log the attribute change as a ticket activity"} + + + + + + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The email address of the customer"} + + + {"The name of the customer"} + + + {"URL of the customer avatar image"} + + + {"ISO timestamp of when the customer was last seen"} + + + {"ISO timestamp of when the customer was last contacted"} + + + {"A list of tags associated with the customer"} + + + {"Additional metadata associated with the customer"} + + + {"Attributes of the customer"} + + + + + + +### Set Priority + +{"Set the priority of a ticket"} + + + + + {"The ID of the ticket"} + + + {"The new priority for the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Snooze Ticket + +{"Snooze a ticket until a specified time"} + + + + + {"The ID of the ticket to snooze"} + + + {"ISO timestamp of when the ticket should wake up"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Unassign Ticket + +{"Remove the assignment from a ticket"} + + + + + {"The ID of the ticket to unassign"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + +### Unsnooze Ticket + +{"Wake up a snoozed ticket"} + + + + + {"The ID of the ticket to unsnooze"} + + + + + + + + {"The updated ticket"} + + + + {"The unique identifier for the ticket"} + + + {"The title of the ticket"} + + + + + + + {"The unique Desk identifier for the customer (cus_)"} + + + {"The name of the customer"} + + + {"The email address of the customer"} + + + + + {"The priority level of the ticket"} + +Available options: `low`, `medium`, `high`, `urgent` + + + {"The system from which the ticket originated"} + +Available options: `native`, `intercom`, `zendesk` + + + {"The unique identifier of the ticket in the originating system"} + + + {"The admin or bot assigned to the ticket"} + + + {"The current status of the ticket"} + +Available options: `open`, `closed`, `snoozed` + + + {"ISO timestamp of when the ticket was created"} + + + {"ISO timestamp of when the ticket was last updated"} + + + {"ISO timestamp of when the ticket was closed"} + + + {"ISO timestamp of when the ticket will wake up if snoozed"} + + + {"A list of tags associated with the ticket"} + + + {"Additional metadata associated with the ticket"} + + + + + + + +{/* vale on */} \ No newline at end of file diff --git a/snippets/integrations/triggers/botpress/desk.mdx b/snippets/integrations/triggers/botpress/desk.mdx new file mode 100644 index 00000000..40993b73 --- /dev/null +++ b/snippets/integrations/triggers/botpress/desk.mdx @@ -0,0 +1,41 @@ +{/* This file is auto-generated. Do not edit directly. */} +{/* vale off */} + +Here's a reference for all [Triggers](/studio/concepts/triggers/) available with the integration: + + + +You can access data returned from any of these Triggers by reading `event.payload` after the Trigger fires. + + + +### Ticket Activity + +{"Emitted when new activities (comments, notes, or system activities) are added to a ticket that the bot is assigned to. Does not include activities created by the bot itself to prevent infinite loops."} + + + + + + + {"The unique identifier for the ticket"} + + + {"The number of new activities that were synced"} + + + + + +{/* vale on */} \ No newline at end of file diff --git a/snippets/integrations/versions.mdx b/snippets/integrations/versions.mdx index cfa79998..f473effd 100644 --- a/snippets/integrations/versions.mdx +++ b/snippets/integrations/versions.mdx @@ -171,6 +171,10 @@ export const integrationVersions = { "version": "2.0.0", "id": "intver_01JFAQV9ZZ9MHH2ENEQ1ERMY2G" }, + "desk": { + "version": "1.0.0", + "id": "intver_01KGQ972H97YAN3D3KY9425JYN" + }, "discord": { "version": "0.3.2", "id": "intver_01J3E7AN39P65XZ0Z00C1ZAHJ9" @@ -264,8 +268,8 @@ export const integrationVersions = { "id": "intver_01KCPW0RPJR7X6ATK55RP460VZ" }, "googledrive": { - "version": "0.3.5", - "id": "intver_01KGHVDJX28GHTBKH15M2QMNHN" + "version": "0.4.0", + "id": "intver_01KHNT5E53DE0T88GVHCY6DQXF" }, "groq": { "version": "15.0.1",