mirror of
https://github.com/simstudioai/sim.git
synced 2026-04-06 03:00:16 -04:00
* fix(grain): update to stable version of API * fix prewebhook lookup * update pending webhook verification infra * add generic webhook test event verification subblock
220 lines
5.9 KiB
TypeScript
220 lines
5.9 KiB
TypeScript
import type { TriggerOutput } from '@/triggers/types'
|
|
|
|
/**
|
|
* Shared trigger dropdown options for all Grain triggers
|
|
*/
|
|
export const grainTriggerOptions = [
|
|
{ label: 'General Webhook (All Events)', id: 'grain_webhook' },
|
|
{ label: 'Recording Created', id: 'grain_recording_created' },
|
|
{ label: 'Recording Updated', id: 'grain_recording_updated' },
|
|
{ label: 'Highlight Created', id: 'grain_highlight_created' },
|
|
{ label: 'Highlight Updated', id: 'grain_highlight_updated' },
|
|
{ label: 'Story Created', id: 'grain_story_created' },
|
|
]
|
|
|
|
/**
|
|
* Generate setup instructions for a specific Grain event type
|
|
*/
|
|
export function grainSetupInstructions(eventType: string): string {
|
|
const instructions = [
|
|
'Enter your Grain API Key (Personal Access Token) above.',
|
|
`Enter the Grain view ID that matches the ${eventType} trigger. Grain requires <code>view_id</code> for webhook creation.`,
|
|
'Use the Grain "List Views" tool or GET <code>/_/public-api/views</code> to find the correct view ID.',
|
|
'You can find or create your API key in Grain at <strong>Workspace Settings > API</strong> under Integrations on <a href="https://grain.com/app/settings/integrations?tab=api" target="_blank" rel="noopener noreferrer">grain.com</a>.',
|
|
'The webhook will be automatically deleted when you remove this trigger.',
|
|
]
|
|
|
|
return instructions
|
|
.map(
|
|
(instruction, index) =>
|
|
`<div class="mb-3"><strong>${index + 1}.</strong> ${instruction}</div>`
|
|
)
|
|
.join('')
|
|
}
|
|
|
|
/**
|
|
* Build output schema for recording events
|
|
* Webhook payload structure: { type, user_id, data: { ...recording } }
|
|
*/
|
|
export function buildRecordingOutputs(): Record<string, TriggerOutput> {
|
|
return {
|
|
type: {
|
|
type: 'string',
|
|
description: 'Event type',
|
|
},
|
|
user_id: {
|
|
type: 'string',
|
|
description: 'User UUID who triggered the event',
|
|
},
|
|
data: {
|
|
id: {
|
|
type: 'string',
|
|
description: 'Recording UUID',
|
|
},
|
|
title: {
|
|
type: 'string',
|
|
description: 'Recording title',
|
|
},
|
|
start_datetime: {
|
|
type: 'string',
|
|
description: 'ISO8601 start timestamp',
|
|
},
|
|
end_datetime: {
|
|
type: 'string',
|
|
description: 'ISO8601 end timestamp',
|
|
},
|
|
duration_ms: {
|
|
type: 'number',
|
|
description: 'Duration in milliseconds',
|
|
},
|
|
media_type: {
|
|
type: 'string',
|
|
description: 'audio, transcript, or video',
|
|
},
|
|
source: {
|
|
type: 'string',
|
|
description: 'Recording source (zoom, meet, local_capture, etc.)',
|
|
},
|
|
url: {
|
|
type: 'string',
|
|
description: 'URL to view in Grain',
|
|
},
|
|
thumbnail_url: {
|
|
type: 'string',
|
|
description: 'Thumbnail URL (nullable)',
|
|
},
|
|
tags: {
|
|
type: 'array',
|
|
description: 'Array of tag strings',
|
|
},
|
|
teams: {
|
|
type: 'array',
|
|
description: 'Array of team objects',
|
|
},
|
|
meeting_type: {
|
|
type: 'object',
|
|
description: 'Meeting type info with id, name, scope (nullable)',
|
|
},
|
|
},
|
|
} as Record<string, TriggerOutput>
|
|
}
|
|
|
|
/**
|
|
* Build output schema for highlight events
|
|
* Note: Grain API docs only show recording webhooks. Highlight webhooks may have similar structure.
|
|
*/
|
|
export function buildHighlightOutputs(): Record<string, TriggerOutput> {
|
|
return {
|
|
type: {
|
|
type: 'string',
|
|
description: 'Event type',
|
|
},
|
|
user_id: {
|
|
type: 'string',
|
|
description: 'User UUID who triggered the event',
|
|
},
|
|
data: {
|
|
id: {
|
|
type: 'string',
|
|
description: 'Highlight UUID',
|
|
},
|
|
recording_id: {
|
|
type: 'string',
|
|
description: 'Parent recording UUID',
|
|
},
|
|
text: {
|
|
type: 'string',
|
|
description: 'Highlight title/description',
|
|
},
|
|
transcript: {
|
|
type: 'string',
|
|
description: 'Transcript text of the clip',
|
|
},
|
|
speakers: {
|
|
type: 'array',
|
|
description: 'Array of speaker names',
|
|
},
|
|
timestamp: {
|
|
type: 'number',
|
|
description: 'Start timestamp in ms',
|
|
},
|
|
duration: {
|
|
type: 'number',
|
|
description: 'Duration in ms',
|
|
},
|
|
tags: {
|
|
type: 'array',
|
|
description: 'Array of tag strings',
|
|
},
|
|
url: {
|
|
type: 'string',
|
|
description: 'URL to view in Grain',
|
|
},
|
|
thumbnail_url: {
|
|
type: 'string',
|
|
description: 'Thumbnail URL',
|
|
},
|
|
created_datetime: {
|
|
type: 'string',
|
|
description: 'ISO8601 creation timestamp',
|
|
},
|
|
},
|
|
} as Record<string, TriggerOutput>
|
|
}
|
|
|
|
/**
|
|
* Build output schema for story events
|
|
* Note: Grain API docs only show recording webhooks. Story webhooks may have similar structure.
|
|
*/
|
|
export function buildStoryOutputs(): Record<string, TriggerOutput> {
|
|
return {
|
|
type: {
|
|
type: 'string',
|
|
description: 'Event type',
|
|
},
|
|
user_id: {
|
|
type: 'string',
|
|
description: 'User UUID who triggered the event',
|
|
},
|
|
data: {
|
|
id: {
|
|
type: 'string',
|
|
description: 'Story UUID',
|
|
},
|
|
title: {
|
|
type: 'string',
|
|
description: 'Story title',
|
|
},
|
|
url: {
|
|
type: 'string',
|
|
description: 'URL to view in Grain',
|
|
},
|
|
created_datetime: {
|
|
type: 'string',
|
|
description: 'ISO8601 creation timestamp',
|
|
},
|
|
},
|
|
} as Record<string, TriggerOutput>
|
|
}
|
|
|
|
/**
|
|
* Build output schema for generic webhook events
|
|
* Webhook payload structure: { type, user_id, data: { ... } }
|
|
*/
|
|
export function buildGenericOutputs(): Record<string, TriggerOutput> {
|
|
return {
|
|
type: {
|
|
type: 'string',
|
|
description: 'Event type (e.g., recording_added)',
|
|
},
|
|
user_id: {
|
|
type: 'string',
|
|
description: 'User UUID who triggered the event',
|
|
},
|
|
data: {
|
|
type: 'object',
|
|
description: 'Event data object (recording, highlight, etc.)',
|
|
},
|
|
} as Record<string, TriggerOutput>
|
|
}
|