@devries-cameron20 / composio Mirror · read-only / commits / 68b27d2bb
Fork 0

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

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 21:00 UTC

docs(triggers): remove forward-looking SDK field access from code samples

The TypeScript code block in creating-triggers.mdx accessed triggerType.requiresWebhookEndpoint, which doesn't exist on the SDK's TriggerType today (see ts/packages/core/src/types/triggers.types.ts:152). Twoslash type-checks all TS code blocks at build time per docs/CLAUDE.md rule 1, so the build failed on Vercel. Drop the property reads (Python and TypeScript) so the samples are valid against today's SDK. Conceptual prose still references the requires_webhook_endpoint flag — the discovery story is unchanged, just the code samples no longer claim the field exists yet. When the SDK ships the field, add the reads back. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Anshu Garg committed May 7, 2026 at 18:39 UTC 68b27d2bb662fbde6ffeb6d5cd46d7836e3df189
1 file changed -6
docs/content/docs/setting-up-triggers/creating-triggers.mdx
-6
@@ -33,9 +33,6 @@ user_id = "user-id-123435"
33 trigger_type = composio.triggers.get_type("GITHUB_COMMIT_EVENT")
34 print(trigger_type.config)
35 # {"properties": {"owner": {...}, "repo": {...}}, "required": ["owner", "repo"]}
36 -print(trigger_type.requires_webhook_endpoint)
37 -# False → create the trigger normally
38 -# True → see "Configuring the webhook endpoint" below first
36
37 # Create trigger with the required config
38 trigger = composio.triggers.create(
@@ -57,9 +54,6 @@ const userId = 'user-id-123435';
54 const triggerType = await composio.triggers.getType("GITHUB_COMMIT_EVENT");
55 console.log(triggerType.config);
56 // {"properties": {"owner": {...}, "repo": {...}}, "required": ["owner", "repo"]}
60 -console.log(triggerType.requiresWebhookEndpoint);
61 -// false → create the trigger normally
62 -// true → see "Configuring the webhook endpoint" below first
57
58 // Create trigger with the required config
59 const trigger = await composio.triggers.create(