cleanup trigger outputs

Author: icecrasher321

.claude/commands/add-trigger.md

@@ -552,6 +552,53 @@ All fields automatically have:
 - `mode: 'trigger'` - Only shown in trigger mode
 - `condition: { field: 'selectedTriggerId', value: triggerId }` - Only shown when this trigger is selected
 
+## Trigger Outputs & Webhook Input Formatting
+
+### Important: Two Sources of Truth
+
+There are two related but separate concerns:
+
+1. **Trigger `outputs`** - Schema/contract defining what fields SHOULD be available. Used by UI for tag dropdown.
+2. **`formatWebhookInput`** - Implementation that transforms raw webhook payload into actual data. Located in `apps/sim/lib/webhooks/utils.server.ts`.
+
+**These MUST be aligned.** The fields returned by `formatWebhookInput` should match what's defined in trigger `outputs`. If they differ:
+- Tag dropdown shows fields that don't exist (broken variable resolution)
+- Or actual data has fields not shown in dropdown (users can't discover them)
+
+### When to Add a formatWebhookInput Handler
+
+- **Simple providers**: If the raw webhook payload structure already matches your outputs, you don't need a handler. The generic fallback returns `body` directly.
+- **Complex providers**: If you need to transform, flatten, extract nested data, compute fields, or handle conditional logic, add a handler.
+
+### Adding a Handler
+
+In `apps/sim/lib/webhooks/utils.server.ts`, add a handler block:
+
+```typescript
+if (foundWebhook.provider === '{service}') {
+  // Transform raw webhook body to match trigger outputs
+  return {
+    eventType: body.type,
+    resourceId: body.data?.id || '',
+    timestamp: body.created_at,
+    resource: body.data,
+  }
+}
+```
+
+**Key rules:**
+- Return fields that match your trigger `outputs` definition exactly
+- No wrapper objects like `webhook: { data: ... }` or `{service}: { ... }`
+- No duplication (don't spread body AND add individual fields)
+- Use `null` for missing optional data, not empty objects with empty strings
+
+### Verify Alignment
+
+Run the alignment checker:
+```bash
+bunx scripts/check-trigger-alignment.ts {service}
+```
+
 ## Trigger Outputs
 
 Trigger outputs use the same schema as block outputs (NOT tool outputs).
@@ -649,6 +696,11 @@ export const {service}WebhookTrigger: TriggerConfig = {
 - [ ] Added `delete{Service}Webhook` function to `provider-subscriptions.ts`
 - [ ] Added provider to `cleanupExternalWebhook` function
 
+### Webhook Input Formatting
+- [ ] Added handler in `apps/sim/lib/webhooks/utils.server.ts` (if custom formatting needed)
+- [ ] Handler returns fields matching trigger `outputs` exactly
+- [ ] Run `bunx scripts/check-trigger-alignment.ts {service}` to verify alignment
+
 ### Testing
 - [ ] Run `bun run type-check` to verify no TypeScript errors
 - [ ] Restart dev server to pick up new triggers

apps/sim/lib/webhooks/utils.server.ts

@@ -423,10 +423,12 @@ async function formatTeamsGraphNotification(
       hasCredential: !!credentialId,
     })
     return {
-      from: null,
-      message: { raw: notification },
-      activity: body,
-      conversation: { id: chatId },
+      message_id: resolvedMessageId,
+      chat_id: resolvedChatId,
+      from_name: '',
+      text: '',
+      created_at: '',
+      attachments: [],
     }
   }
 
@@ -435,31 +437,12 @@ async function formatTeamsGraphNotification(
   const createdAt = message.createdDateTime || ''
 
   return {
-    from: {
-      id: from.id || '',
-      name: from.displayName || '',
-      aadObjectId: from.aadObjectId || '',
-    },
-    message: {
-      raw: {
-        attachments: rawAttachments,
-        channelData: {},
-        conversation: { id: chatId },
-        text: messageText,
-        messageType: 'message',
-        channelId: '',
-        timestamp: createdAt,
-      },
-    },
-    activity: body,
-    conversation: {
-      id: chatId,
-      name: '',
-      isGroup: false,
-      tenantId: '',
-      aadObjectId: '',
-      conversationType: '',
-    },
+    message_id: resolvedMessageId,
+    chat_id: resolvedChatId,
+    from_name: from.displayName || '',
+    text: messageText,
+    created_at: createdAt,
+    attachments: rawAttachments,
   }
 }
 
@@ -602,6 +585,7 @@ export async function formatWebhookInput(
         sender: rawMessage.from
           ? {
               id: rawMessage.from.id,
+              username: rawMessage.from.username,
               firstName: rawMessage.from.first_name,
               lastName: rawMessage.from.last_name,
               languageCode: rawMessage.from.language_code,
@@ -818,7 +802,7 @@ export async function formatWebhookInput(
   if (foundWebhook.provider === 'webflow') {
     return {
       siteId: body?.siteId || '',
-      workspaceId: body?.workspaceId || '',
+      formId: body?.formId || '',
       name: body?.name || '',
       id: body?.id || '',
       submittedAt: body?.submittedAt || '',
@@ -977,16 +961,6 @@ export async function formatWebhookInput(
     }
   }
 
-  if (foundWebhook.provider === 'lemlist') {
-    // Lemlist webhook - expose raw payload as `data` for user to destructure
-    // Common fields include: _id, type, createdAt, leadId, campaignId, leadEmail,
-    // leadFirstName, leadLastName, sequenceStep, messageId, text, etc.
-    return {
-      data: body,
-    }
-  }
-
-  // Generic format for other providers - pass through the body directly
   return body
 }
 

apps/sim/triggers/circleback/utils.ts

@@ -96,23 +96,3 @@ export function buildMeetingOutputs(): Record<string, TriggerOutput> {
     },
   } as Record<string, TriggerOutput>
 }
-
-/**
- * Build output schema for generic webhook events
- */
-export function buildGenericOutputs(): Record<string, TriggerOutput> {
-  return {
-    payload: {
-      type: 'object',
-      description: 'Raw webhook payload',
-    },
-    headers: {
-      type: 'object',
-      description: 'Request headers',
-    },
-    timestamp: {
-      type: 'string',
-      description: 'ISO8601 received timestamp',
-    },
-  } as Record<string, TriggerOutput>
-}

apps/sim/triggers/circleback/webhook.ts

@@ -1,6 +1,6 @@
 import { CirclebackIcon } from '@/components/icons'
 import type { TriggerConfig } from '@/triggers/types'
-import { buildGenericOutputs, circlebackSetupInstructions, circlebackTriggerOptions } from './utils'
+import { buildMeetingOutputs, circlebackSetupInstructions, circlebackTriggerOptions } from './utils'
 
 export const circlebackWebhookTrigger: TriggerConfig = {
   id: 'circleback_webhook',
@@ -74,7 +74,7 @@ export const circlebackWebhookTrigger: TriggerConfig = {
     },
   ],
 
-  outputs: buildGenericOutputs(),
+  outputs: buildMeetingOutputs(),
 
   webhook: {
     method: 'POST',

apps/sim/triggers/github/issue_closed.ts

@@ -116,6 +116,15 @@ export const githubIssueClosedTrigger: TriggerConfig = {
   ],
 
   outputs: {
+    event_type: {
+      type: 'string',
+      description:
+        'GitHub event type from X-GitHub-Event header (e.g., issues, pull_request, push)',
+    },
+    branch: {
+      type: 'string',
+      description: 'Branch name derived from ref (empty for non-branch events)',
+    },
     action: {
       type: 'string',
       description: 'Action performed (opened, closed, reopened, edited, etc.)',

apps/sim/triggers/github/issue_comment.ts

@@ -117,6 +117,14 @@ export const githubIssueCommentTrigger: TriggerConfig = {
   ],
 
   outputs: {
+    event_type: {
+      type: 'string',
+      description: 'GitHub event type from X-GitHub-Event header (e.g., issue_comment)',
+    },
+    branch: {
+      type: 'string',
+      description: 'Branch name derived from ref (empty for non-branch events)',
+    },
     action: {
       type: 'string',
       description: 'Action performed (created, edited, deleted)',

apps/sim/triggers/github/issue_opened.ts

@@ -137,6 +137,15 @@ export const githubIssueOpenedTrigger: TriggerConfig = {
   ],
 
   outputs: {
+    event_type: {
+      type: 'string',
+      description:
+        'GitHub event type from X-GitHub-Event header (e.g., issues, pull_request, push)',
+    },
+    branch: {
+      type: 'string',
+      description: 'Branch name derived from ref (empty for non-branch events)',
+    },
     action: {
       type: 'string',
       description: 'Action performed (opened, closed, reopened, edited, etc.)',

apps/sim/triggers/github/pr_closed.ts

@@ -117,6 +117,14 @@ export const githubPRClosedTrigger: TriggerConfig = {
   ],
 
   outputs: {
+    event_type: {
+      type: 'string',
+      description: 'GitHub event type from X-GitHub-Event header (e.g., pull_request)',
+    },
+    branch: {
+      type: 'string',
+      description: 'Branch name derived from ref (empty for non-branch events)',
+    },
     action: {
       type: 'string',
       description: 'Action performed (opened, closed, synchronize, reopened, edited, etc.)',

apps/sim/triggers/github/pr_comment.ts

@@ -117,6 +117,14 @@ export const githubPRCommentTrigger: TriggerConfig = {
   ],
 
   outputs: {
+    event_type: {
+      type: 'string',
+      description: 'GitHub event type from X-GitHub-Event header (e.g., issue_comment)',
+    },
+    branch: {
+      type: 'string',
+      description: 'Branch name derived from ref (empty for non-branch events)',
+    },
     action: {
       type: 'string',
       description: 'Action performed (created, edited, deleted)',

apps/sim/triggers/github/pr_merged.ts

@@ -116,6 +116,14 @@ export const githubPRMergedTrigger: TriggerConfig = {
   ],
 
   outputs: {
+    event_type: {
+      type: 'string',
+      description: 'GitHub event type from X-GitHub-Event header (e.g., pull_request)',
+    },
+    branch: {
+      type: 'string',
+      description: 'Branch name derived from ref (empty for non-branch events)',
+    },
     action: {
       type: 'string',
       description: 'Action performed (opened, closed, synchronize, reopened, edited, etc.)',