new-comment-trigger.ts•3.92 kB
import { createTrigger, TriggerStrategy, Property } from '@activepieces/pieces-framework';
import { smartsheetAuth } from '../../index';
import {
smartsheetCommon,
unsubscribeWebhook,
WebhookInformation,
findOrCreateWebhook,
verifyWebhookSignature,
getCommentFullDetails,
} from '../common';
import { WebhookHandshakeStrategy } from '@activepieces/shared';
const TRIGGER_KEY = 'smartsheet_new_comment_trigger';
export const newCommentTrigger = createTrigger({
auth: smartsheetAuth,
name: 'new_comment_webhook',
displayName: 'New Comment Added',
description: 'Triggers when a new comment is added to a discussion on a sheet.',
props: {
sheet_id: smartsheetCommon.sheet_id(),
},
type: TriggerStrategy.WEBHOOK,
sampleData: {
sheetId: '12345',
eventType: 'created',
objectType: 'comment',
id: 89012, // Comment ID
discussionId: 45678,
parentId: 67890, // e.g., Row ID comment is on
parentType: 'ROW',
timestamp: '2023-10-28T12:15:00Z',
userId: 54321,
commentData: {
/* ... full comment data ... */
},
},
handshakeConfiguration: {
strategy: WebhookHandshakeStrategy.BODY_PARAM_PRESENT,
paramName: 'challenge',
},
async onHandshake(context) {
return {
status: 200,
body: {
smartsheetHookResponse: (context.payload.body as any)['challenge'],
},
};
},
async onEnable(context) {
const { sheet_id } = context.propsValue;
if (!sheet_id) throw new Error('Sheet ID is required to enable the webhook.');
const triggerIdentifier = context.webhookUrl.substring(context.webhookUrl.lastIndexOf('/') + 1);
const webhook = await findOrCreateWebhook(
context.auth as string,
context.webhookUrl,
sheet_id as string,
triggerIdentifier,
);
await context.store.put<WebhookInformation>(TRIGGER_KEY, {
webhookId: webhook.id.toString(),
sharedSecret: webhook.sharedSecret,
webhookName: webhook.name,
});
},
async onDisable(context) {
const webhookInfo = await context.store.get<WebhookInformation>(TRIGGER_KEY);
if (webhookInfo && webhookInfo.webhookId) {
try {
await unsubscribeWebhook(context.auth as string, webhookInfo.webhookId);
} catch (error: any) {
if (error.response?.status !== 404) {
console.error(`Error unsubscribing webhook ${webhookInfo.webhookId}: ${error.message}`);
}
}
await context.store.delete(TRIGGER_KEY);
}
},
async run(context): Promise<unknown[]> {
const payload = context.payload.body as any;
const headers = context.payload.headers as Record<string, string | undefined>;
const webhookInfo = await context.store.get<WebhookInformation>(TRIGGER_KEY);
if (!webhookInfo) {
return [];
}
if (headers && headers['smartsheet-hook-challenge']) {
return [];
}
const webhookSecret = webhookInfo?.sharedSecret;
const webhookSignatureHeader = context.payload.headers['smartsheet-hmac-sha256'];
const rawBody = context.payload.rawBody;
if (!verifyWebhookSignature(webhookSecret, webhookSignatureHeader, rawBody)) {
return [];
}
if (payload.newWebhookStatus) {
return [];
}
if (!payload.events || !Array.isArray(payload.events) || payload.events.length === 0) {
return [];
}
const newCommentEvents = [];
for (const event of payload.events) {
if (event.objectType === 'comment' && event.eventType === 'created') {
const eventOutput: any = { ...event, sheetId: payload.scopeObjectId?.toString() };
const objectSheetId = payload.scopeObjectId?.toString();
if (objectSheetId) {
try {
eventOutput.commentData = await getCommentFullDetails(
context.auth as string,
objectSheetId,
event.discussionId.toString(),
event.id.toString(),
);
} catch (error: any) {
eventOutput.fetchError = error.message;
}
} else {
eventOutput.fetchError = 'scopeObjectId missing';
}
newCommentEvents.push(eventOutput);
}
}
return newCommentEvents;
},
});