@devries-cameron20 / composio Mirror · read-only
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, 03:37 UTC

next
mdx 132 lines 4.46 KB
Raw
1 ---
2 title: "Toolkit Version Support for Triggers"
3 description: "Trigger operations now support explicit toolkit version specification"
4 date: "2025-11-10"
5 ---
6
7 ### Summary
8 Added toolkit version support to trigger operations (`create` and `getType`) in both Python and TypeScript SDKs. This allows users to explicitly specify which toolkit version to use when creating trigger instances and retrieving trigger type information, ensuring consistent behavior across different toolkit versions.
9
10 Trigger operations now respect the global `toolkitVersions` configuration set during Composio initialization, providing better control over which trigger versions are used in your applications.
11
12 ### Key Changes
13
14 #### TypeScript SDK (`ts/packages/core/`)
15 - Added `toolkit_versions` parameter to `triggers.create()` method
16 - Passes the global toolkit versions configuration when creating trigger instances
17 - Defaults to `'latest'` when no version is specified
18 - Modified `triggers.getType()` to respect global toolkit versions
19 - Now accepts toolkit version configuration to fetch trigger types for specific versions
20 - Improved error messages to include version-related fixes
21 - Updated trigger type documentation with comprehensive examples
22 - Added behavior documentation explaining version usage patterns
23
24 #### Python SDK (`python/composio/core/models/`)
25 - Added `toolkit_versions` parameter to `triggers.create()` method
26 - Uses global toolkit version configuration when creating trigger instances
27 - Converts `None` to `omit` for API compatibility
28 - Modified `triggers.get_type()` to respect toolkit versions
29 - Implemented custom method replacing direct client binding
30 - Passes toolkit version configuration to API calls
31 - Added comprehensive docstrings explaining version behavior
32
33 ### Behavior
34
35 **Creating Triggers with Toolkit Versions:**
36
37 ```typescript
38 // @noErrors
39 // TypeScript - Configure versions at initialization
40 const composio = new Composio({
41 apiKey: 'your-api-key',
42 toolkitVersions: {
43 gmail: '12082025_00',
44 github: '10082025_01'
45 }
46 });
47
48 // Create trigger - uses version '12082025_00' for Gmail
49 const trigger = await composio.triggers.create('user@example.com', 'GMAIL_NEW_MESSAGE', {
50 connectedAccountId: 'ca_abc123',
51 triggerConfig: {
52 labelIds: 'INBOX',
53 userId: 'me',
54 interval: 60,
55 },
56 });
57 ```
58
59 ```python
60 # Python - Configure versions at initialization
61 composio = Composio(
62 api_key="your-api-key",
63 toolkit_versions={"gmail": "12082025_00", "github": "10082025_01"}
64 )
65
66 # Create trigger - uses version '12082025_00' for Gmail
67 trigger = composio.triggers.create(
68 slug="GMAIL_NEW_MESSAGE",
69 user_id="user@example.com",
70 trigger_config={"labelIds": "INBOX", "userId": "me", "interval": 60}
71 )
72 ```
73
74 **Retrieving Trigger Types with Specific Versions:**
75
76 ```typescript
77 // @noErrors
78 // TypeScript
79 const composio = new Composio({
80 apiKey: 'your-api-key',
81 toolkitVersions: { github: '10082025_01' }
82 });
83
84 // Get trigger type for specific version
85 const triggerType = await composio.triggers.getType('GITHUB_COMMIT_EVENT');
86 // Returns trigger type for version '10082025_01'
87 ```
88
89 ```python
90 # Python
91 composio = Composio(
92 api_key="your-api-key",
93 toolkit_versions={"github": "10082025_01"}
94 )
95
96 # Get trigger type for specific version
97 trigger_type = composio.triggers.get_type("GITHUB_COMMIT_EVENT")
98 # Returns trigger type for version '10082025_01'
99 ```
100
101 ### Benefits
102
103 - **Version Control**: Explicitly specify which toolkit version to use for triggers
104 - **Consistency**: Ensure trigger behavior remains consistent across toolkit updates
105 - **Testing**: Test trigger integrations with specific versions before updating
106 - **Debugging**: Easier to debug issues by pinning to specific toolkit versions
107 - **Production Safety**: Avoid unexpected changes from automatic version updates
108
109 ### Migration Guide
110
111 This is a **non-breaking change**. Existing code will continue to work with default behavior:
112
113 **Before (still works):**
114 ```typescript
115 // @noErrors
116 // Uses 'latest' version by default
117 const trigger = await composio.triggers.create('user', 'GITHUB_COMMIT_EVENT', {...});
118 ```
119
120 **After (recommended for production):**
121 ```typescript
122 // @noErrors
123 // Explicitly configure versions for better control
124 const composio = new Composio({
125 apiKey: 'your-api-key',
126 toolkitVersions: { github: '10082025_01' }
127 });
128
129 const trigger = await composio.triggers.create('user', 'GITHUB_COMMIT_EVENT', {...});
130 ```
131
132 For more details on toolkit versioning, see the [Toolkit Versioning documentation](/docs/tools-direct/toolkit-versioning).