Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

feat(docs): Add trigger type, config, and payload to toolkit pages

Sushmithamalleshd53b5446a2a2
diff --git a/docs/app/(home)/toolkits/[[...slug]]/page.tsx b/docs/app/(home)/toolkits/[[...slug]]/page.tsx
index 1f0c0edda..7ee4cf284 100644
--- a/docs/app/(home)/toolkits/[[...slug]]/page.tsx
+++ b/docs/app/(home)/toolkits/[[...slug]]/page.tsx
@@ -7,7 +7,7 @@ import { PageActions } from '@/components/page-actions';
import { readFile } from 'fs/promises';
import { join } from 'path';
import type { Metadata } from 'next';
-import type { Toolkit, Tool } from '@/types/toolkit';
+import type { Toolkit, Tool, Trigger } from '@/types/toolkit';
const API_BASE = process.env.COMPOSIO_API_BASE || 'https://backend.composio.dev/api/v3';
const API_KEY = process.env.COMPOSIO_API_KEY;
@@ -84,6 +84,77 @@ async function fetchDetailedTools(toolkitSlug: string): Promise<Tool[] | null> {
}
}
+// Fetch detailed trigger info from Composio API (server-side only)
+// Returns null on failure, empty array if toolkit has no triggers
+async function fetchDetailedTriggers(toolkitSlug: string): Promise<Trigger[] | null> {
+ if (!API_KEY) {
+ console.warn('[Toolkits] COMPOSIO_API_KEY not set, skipping detailed trigger fetch');
+ return null;
+ }
+
+ try {
+ const response = await fetch(
+ `${API_BASE}/triggers_types?toolkit_slugs=${toolkitSlug.toUpperCase()}&limit=1000`,
+ {
+ headers: {
+ 'Content-Type': 'application/json',
+ 'x-api-key': API_KEY,
+ },
+ next: { revalidate: 3600 }, // Cache for 1 hour
+ }
+ );
+
+ if (!response.ok) {
+ console.warn(`[Toolkits] Failed to fetch triggers for ${toolkitSlug}: ${response.status}`);
+ return null;
+ }
+
+ const data = await response.json();
+ const rawItems = data.items || data;
+ const items = Array.isArray(rawItems) ? rawItems : [];
+
+ return items.filter((trigger: any) => trigger && typeof trigger === 'object').map((trigger: any) => {
+ // Extract config and payload schemas
+ const configSchema = trigger.config;
+ const payloadSchema = trigger.payload;
+
+ // Get properties and required array from JSON Schema
+ const configProps = configSchema?.properties || configSchema;
+ const configRequired = configSchema?.required || [];
+ const payloadProps = payloadSchema?.properties || payloadSchema;
+ const payloadRequired = payloadSchema?.required || [];
+
+ // Add required flag to each property based on the required array
+ const processParams = (props: any, requiredList: string[]) => {
+ if (!props || typeof props !== 'object') return undefined;
+ const result: Record<string, any> = {};
+ for (const [key, value] of Object.entries(props)) {
+ if (typeof value === 'object' && value !== null) {
+ result[key] = {
+ ...(value as object),
+ required: requiredList.includes(key),
+ };
+ }
+ }
+ return Object.keys(result).length > 0 ? result : undefined;
+ };
+
+ return {
+ slug: trigger.slug || '',
+ name: trigger.name || trigger.display_name || trigger.slug || '',
+ description: trigger.description || '',
+ type: trigger.type || undefined,
+ config: processParams(configProps, configRequired),
+ payload: processParams(payloadProps, payloadRequired),
+ instructions: trigger.instructions || undefined,
+ };
+ });
+ } catch (error) {
+ console.error(`[Toolkits] Error fetching detailed triggers for ${toolkitSlug}:`, error);
+ return null;
+ }
+}
+
async function getToolkits(): Promise<Toolkit[]> {
const filePath = join(process.cwd(), 'public/data/toolkits.json');
@@ -204,17 +275,21 @@ export default async function ToolkitsPage({ params }: { params: Promise<{ slug?
const toolkit = toolkits.find((t) => t.slug === toolkitSlug);
if (toolkit) {
- // Fetch detailed tool info from API (includes input/output params)
- const detailedTools = await fetchDetailedTools(toolkitSlug);
+ // Fetch detailed tool and trigger info from API (includes input/output params)
+ const [detailedTools, detailedTriggers] = await Promise.all([
+ fetchDetailedTools(toolkitSlug),
+ fetchDetailedTriggers(toolkitSlug),
+ ]);
- // Use detailed tools if fetch succeeded, otherwise fall back to static data
+ // Use detailed data if fetch succeeded, otherwise fall back to static data
const tools = detailedTools !== null ? detailedTools : toolkit.tools;
+ const triggers = detailedTriggers !== null ? detailedTriggers : toolkit.triggers;
return (
<ToolkitDetail
toolkit={toolkit}
tools={tools}
- triggers={toolkit.triggers}
+ triggers={triggers}
path={`/toolkits/${toolkit.slug}`}
/>
);
diff --git a/docs/components/toolkits/toolkit-detail.tsx b/docs/components/toolkits/toolkit-detail.tsx
index 9d34045cb..49d74cb67 100644
--- a/docs/components/toolkits/toolkit-detail.tsx
+++ b/docs/components/toolkits/toolkit-detail.tsx
@@ -67,6 +67,11 @@ function isTool(item: Tool | Trigger): item is Tool {
return 'input_parameters' in item || 'output_parameters' in item;
}
+// Check if item is a Trigger with config/payload
+function isTrigger(item: Tool | Trigger): item is Trigger {
+ return 'config' in item || 'payload' in item || 'type' in item;
+}
+
function ToolItem({ item }: { item: Tool | Trigger }) {
const [expanded, setExpanded] = useState(false);
const [copied, setCopied] = useState(false);
@@ -79,8 +84,12 @@ function ToolItem({ item }: { item: Tool | Trigger }) {
};
const tool = isTool(item) ? item : null;
+ const trigger = isTrigger(item) ? item : null;
+
const hasInputParams = tool?.input_parameters && Object.keys(tool.input_parameters).length > 0;
const hasOutputParams = tool?.output_parameters && Object.keys(tool.output_parameters).length > 0;
+ const hasConfig = trigger?.config && Object.keys(trigger.config).length > 0;
+ const hasPayload = trigger?.payload && Object.keys(trigger.payload).length > 0;
return (
<div className="border-b border-fd-border/50 last:border-0">
@@ -92,7 +101,18 @@ function ToolItem({ item }: { item: Tool | Trigger }) {
{expanded ? <ChevronDown className="h-4 w-4" /> : <ChevronRight className="h-4 w-4" />}
</span>
<span className="flex min-w-0 flex-1 flex-col gap-1 sm:flex-row sm:items-center sm:justify-between sm:gap-2">
- <span className="truncate text-sm font-medium text-fd-foreground">{item.name}</span>
+ <span className="flex items-center gap-2">
+ <span className="truncate text-sm font-medium text-fd-foreground">{item.name}</span>
+ {trigger?.type && (
+ <span className={`shrink-0 rounded px-1.5 py-0.5 text-xs font-medium ${
+ trigger.type === 'webhook'
+ ? 'bg-green-500/10 text-green-600 dark:text-green-400'
+ : 'bg-blue-500/10 text-blue-600 dark:text-blue-400'
+ }`}>
+ {trigger.type}
+ </span>
+ )}
+ </span>
<span
role="button"
onClick={copySlug}
@@ -107,6 +127,7 @@ function ToolItem({ item }: { item: Tool | Trigger }) {
<div className="space-y-4 bg-fd-muted/20 px-4 py-3 pl-10">
<p className="text-sm text-fd-muted-foreground">{item.description}</p>
+ {/* Tool parameters */}
{hasInputParams && (
<div className="space-y-2">
<h4 className="text-xs font-semibold uppercase tracking-wide text-fd-muted-foreground">Input Parameters</h4>
@@ -120,6 +141,21 @@ function ToolItem({ item }: { item: Tool | Trigger }) {
<TypeTable type={paramsToTypeTable(tool.output_parameters!)} />
</div>
)}
+
+ {/* Trigger config/payload */}
+ {hasConfig && (
+ <div className="space-y-2">
+ <h4 className="text-xs font-semibold uppercase tracking-wide text-fd-muted-foreground">Configuration</h4>
+ <TypeTable type={paramsToTypeTable(trigger.config!)} />
+ </div>
+ )}
+
+ {hasPayload && (
+ <div className="space-y-2">
+ <h4 className="text-xs font-semibold uppercase tracking-wide text-fd-muted-foreground">Payload</h4>
+ <TypeTable type={paramsToTypeTable(trigger.payload!)} />
+ </div>
+ )}
</div>
)}
</div>
diff --git a/docs/content/docs/triggers.mdx b/docs/content/docs/triggers.mdx
index b6230ae05..dabb74929 100644
--- a/docs/content/docs/triggers.mdx
+++ b/docs/content/docs/triggers.mdx
@@ -26,7 +26,7 @@ To create triggers through the dashboard:
2. Select the auth config
3. Click "Add Trigger" and navigate to "Active Triggers" tab to fetch the trigger ID
-<Video src="/videos/enabling-triggers.mp4" caption="Creating a trigger from the dashboard" />
+<Video src="/videos/enabling-triggers.mp4" poster="/images/enabling-triggers-poster.png" caption="Creating a trigger from the dashboard" />
Some triggers require additional configuration. The dashboard will prompt you for any required fields during setup.
diff --git a/docs/public/images/enabling-triggers-poster.png b/docs/public/images/enabling-triggers-poster.png
new file mode 100644
index 000000000..50879a653
Binary files /dev/null and b/docs/public/images/enabling-triggers-poster.png differ
diff --git a/docs/types/toolkit.ts b/docs/types/toolkit.ts
index 96f77797d..84502d803 100644
--- a/docs/types/toolkit.ts
+++ b/docs/types/toolkit.ts
@@ -24,6 +24,11 @@ export interface Trigger {
slug: string;
name: string;
description: string;
+ // Detailed fields fetched on-demand
+ type?: 'webhook' | 'poll';
+ config?: Record<string, ParameterSchema>;
+ payload?: Record<string, ParameterSchema>;
+ instructions?: string;
}
// Auth config field definition