import { z, IntegrationDefinition } from '@botpress/sdk' import { sendEmailOutputSchema, sendMailInputSchema } from './definitions/actions' import { bouncedEmailEventSchema, clickedEmailLinkEventSchema, deferredEmailEventSchema, deliveredEmailEventSchema, openedEmailEventSchema, processedEmailEventSchema, } from './definitions/events' export default new IntegrationDefinition({ name: 'sendgrid', title: 'SendGrid', version: '0.1.10', readme: 'hub.md', icon: 'icon.svg', description: 'Send markdown rich-text emails using the SendGrid email service.', configuration: { schema: z.object({ apiKey: z.string().secret().min(1).describe('Your SendGrid API Key').title('SendGrid API Key'), publicSignatureKey: z .string() .secret() .optional() .describe( 'The public key used to verify the cryptographic signature of the webhook requests (Found in the edit webhook menu)' ) .title('Webhook Verification Key'), }), }, actions: { sendMail: { title: 'Send Email', description: 'Sends an email to the specified client', input: { schema: sendMailInputSchema, }, output: { schema: sendEmailOutputSchema, }, }, }, events: { delivered: { title: 'Email Delivered', description: "An event that triggers when the SendGrid API delivers a given email to the recipient's email server. (This can also trigger alongside email bounces among other events)", schema: deliveredEmailEventSchema, }, bounced: { title: 'Email Bounced', description: 'An event that triggers when an email sent via the SendGrid API bounces. (e.g. Invalid Address, blocked, etc)', schema: bouncedEmailEventSchema, }, deferred: { title: 'Email Deferred', description: "An event that triggers when the SendGrid API fails a delivery attempt to the recipient's email server. (This will often re-attempt a few times before stopping)", schema: deferredEmailEventSchema, }, processed: { title: 'Email Processed', description: 'An event that triggers when the SendGrid API has processed an outbound email.', schema: processedEmailEventSchema, }, opened: { title: 'Email Opened', description: "An event that triggers when the SendGrid API detects that an email has been opened by the recipient. (Must have 'Open Tracking' enabled)\n\nNote: This may be subject to privacy regulations of the email recipient's country", schema: openedEmailEventSchema, }, clicked: { title: 'Email Link Clicked', description: "An event that triggers when the SendGrid API detects that a link in the email has been clicked on by the recipient.(Must have 'Click Tracking' enabled)\n\nNote: This may be subject to privacy regulations of the email recipient's country", schema: clickedEmailLinkEventSchema, }, }, __advanced: { useLegacyZuiTransformer: true, }, attributes: { category: 'Marketing & Email', repo: 'botpress', }, })