wehub-resource-sync
105 lines
3.1 KiB
TypeScript
105 lines
3.1 KiB
TypeScript
import * as sdk from '@botpress/sdk'
|
|
import hitl from './bp_modules/hitl'
|
|
import { actions, events, configuration, channels, states, user } from './src/definitions'
|
|
|
|
export default new sdk.IntegrationDefinition({
|
|
name: 'zendesk',
|
|
title: 'Zendesk',
|
|
version: '3.1.7',
|
|
icon: 'icon.svg',
|
|
description:
|
|
'Optimize your support workflow. Trigger workflows from ticket updates as well as manage tickets, access conversations, and engage with customers.',
|
|
readme: 'hub.md',
|
|
configuration,
|
|
states,
|
|
channels,
|
|
user,
|
|
actions,
|
|
events,
|
|
secrets: {
|
|
CLIENT_ID: {
|
|
description: 'The client ID of your app',
|
|
},
|
|
CLIENT_SECRET: {
|
|
description: 'The client secret of your app',
|
|
},
|
|
CODE_CHALLENGE: {
|
|
description: 'The code challenge for PKCE',
|
|
},
|
|
},
|
|
entities: {
|
|
hitlTicket: {
|
|
schema: sdk.z.object({
|
|
priority: sdk.z
|
|
.enum(['low', 'normal', 'high', 'urgent'])
|
|
.title('Ticket Priority')
|
|
.describe('Priority of the ticket. Leave empty for default priority.')
|
|
.optional(),
|
|
chatbotName: sdk.z
|
|
.string()
|
|
.title('Chatbot Name')
|
|
.describe('Name of the chatbot that will be used in the Zendesk ticket. Defaults to "Botpress".')
|
|
.optional(),
|
|
chatbotPhotoUrl: sdk.z
|
|
.string()
|
|
.title('Chatbot Photo URL')
|
|
.describe(
|
|
'Photo URL of the chatbot that will be used in the Zendesk ticket. Must be a publicly-accessible PNG image. Defaults to Botpress logo.'
|
|
)
|
|
.optional(),
|
|
requesterName: sdk.z
|
|
.string()
|
|
.title('Requester Name')
|
|
.describe('The name of the requester the bot was talking to. This will be set in zendesk.')
|
|
.optional(),
|
|
requesterEmail: sdk.z
|
|
.string()
|
|
.title('Requester Email')
|
|
.describe(
|
|
'⚠️This needs a requester name to work. The email of the requester the bot was talking to. This will be set in zendesk.'
|
|
)
|
|
.optional(),
|
|
ticketFormId: sdk.z
|
|
.string()
|
|
.regex(/^\d+$/, 'Must be a numeric ID')
|
|
.title('Ticket Form ID')
|
|
.describe(
|
|
'The ID of the ticket form to use when creating the ticket. This needs to be set up in Zendesk beforehand.'
|
|
)
|
|
.optional(),
|
|
}),
|
|
},
|
|
},
|
|
attributes: {
|
|
category: 'Customer Support',
|
|
guideSlug: 'zendesk',
|
|
repo: 'botpress',
|
|
},
|
|
}).extend(hitl, (self) => ({
|
|
entities: {
|
|
hitlSession: self.entities.hitlTicket,
|
|
},
|
|
channels: {
|
|
hitl: {
|
|
title: 'Zendesk Ticket',
|
|
description: 'Human in the loop channel for managing Zendesk tickets',
|
|
conversation: {
|
|
tags: {
|
|
id: {
|
|
title: 'Zendesk Ticket ID',
|
|
description: 'The unique identifier of the Zendesk ticket associated with this conversation',
|
|
},
|
|
},
|
|
},
|
|
message: {
|
|
tags: {
|
|
zendeskCommentId: {
|
|
title: 'Zendesk Comment ID',
|
|
description: 'The ID of the comment in Zendesk',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}))
|