@devries-cameron20 / composio-1 / commits / 8a48c25e9
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.

docs: polish managing triggers page

- Reorder sections: list active, enable/disable, delete first - Remove api keys from all snippets - Fix Python list_active params (was using nonexistent user_id/toolkit) - Fix Python list response iteration (active.items not active.triggers) - Fix trigger fields (id, trigger_name, disabled_at) - Remove redundant list_enum and discovering sections - Update dashboard screenshot - Show both Python/TS param names in filter table Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Sushmithamallesh committed Feb 10, 2026 at 08:13 UTC 8a48c25e98a085dd83529e04f6e7a5e6ed6f6abf
2 files changed +21 -126
docs/content/docs/setting-up-triggers/managing-triggers.mdx
+21 -126
@@ -1,99 +1,9 @@
1 ---
2 title: Managing triggers
3 -description: Discover, list, enable, disable, and delete trigger instances
3 +description: List, enable, disable, and delete trigger instances
4 keywords: [manage triggers, enable, disable, delete, discover]
5 ---
6
7 -## Discovering available triggers
8 -
9 -### List trigger types
10 -
11 -Browse available trigger types for a toolkit:
12 -
13 -<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
14 - <Tab value="Python">
15 -```python
16 -from composio import Composio
17 -
18 -composio = Composio(api_key="your-api-key")
19 -
20 -# List trigger types for a toolkit
21 -trigger_types = composio.triggers.list(toolkit="github")
22 -for t in trigger_types:
23 - print(f"{t.slug}: {t.description}")
24 -```
25 - </Tab>
26 - <Tab value="TypeScript">
27 -```typescript
28 -import { Composio } from '@composio/core';
29 -
30 -const composio = new Composio({ apiKey: 'your-api-key' });
31 -
32 -// List trigger types for a toolkit
33 -const triggerTypes = await composio.triggers.listTypes({ toolkits: ['github'] });
34 -for (const t of triggerTypes.items) {
35 - console.log(`${t.slug}: ${t.description}`);
36 -}
37 -```
38 - </Tab>
39 -</Tabs>
40 -
41 -### Inspect a trigger type
42 -
43 -Get the configuration schema and payload structure for a specific trigger type:
44 -
45 -<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
46 - <Tab value="Python">
47 -```python
48 -from composio import Composio
49 -
50 -composio = Composio(api_key="your-api-key")
51 -
52 -trigger_type = composio.triggers.get_type("GITHUB_COMMIT_EVENT")
53 -print("Config schema:", trigger_type.config) # Required fields for creation
54 -print("Payload schema:", trigger_type.payload) # Shape of event data
55 -```
56 - </Tab>
57 - <Tab value="TypeScript">
58 -```typescript
59 -import { Composio } from '@composio/core';
60 -
61 -const composio = new Composio({ apiKey: 'your-api-key' });
62 -
63 -const triggerType = await composio.triggers.getType('GITHUB_COMMIT_EVENT');
64 -console.log('Config schema:', triggerType.config); // Required fields for creation
65 -console.log('Payload schema:', triggerType.payload); // Shape of event data
66 -```
67 - </Tab>
68 -</Tabs>
69 -
70 -### List all trigger slugs
71 -
72 -Get a flat list of every available trigger slug:
73 -
74 -<Tabs groupId="language" items={['Python', 'TypeScript']} persist>
75 - <Tab value="Python">
76 -```python
77 -from composio import Composio
78 -
79 -composio = Composio(api_key="your-api-key")
80 -
81 -slugs = composio.triggers.list_enum()
82 -print(slugs) # ["GITHUB_COMMIT_EVENT", "GMAIL_NEW_EMAIL", ...]
83 -```
84 - </Tab>
85 - <Tab value="TypeScript">
86 -```typescript
87 -import { Composio } from '@composio/core';
88 -
89 -const composio = new Composio({ apiKey: 'your-api-key' });
90 -
91 -const slugs = await composio.triggers.listEnum();
92 -console.log(slugs); // ["GITHUB_COMMIT_EVENT", "GMAIL_NEW_EMAIL", ...]
93 -```
94 - </Tab>
95 -</Tabs>
96 -
7 ## Listing active triggers
8
9 List trigger instances that have been created. Results are cursor-paginated.
@@ -103,16 +13,14 @@ List trigger instances that have been created. Results are cursor-paginated.
13 ```python
14 from composio import Composio
15
106 -composio = Composio(api_key="your-api-key")
16 +composio = Composio()
17
108 -# List active triggers with optional filters
18 active = composio.triggers.list_active(
110 - toolkit="github",
111 - user_id="user-id-123435",
19 + connected_account_ids=["ca_def456"],
20 )
21
114 -for trigger in active.triggers:
115 - print(f"{trigger.trigger_id} ({trigger.slug}) - {trigger.status}")
22 +for trigger in active.items:
23 + print(f"{trigger.id} ({trigger.trigger_name}) - disabled_at={trigger.disabled_at}")
24
25 # Paginate with cursor
26 if active.next_cursor:
@@ -123,9 +31,8 @@ if active.next_cursor:
31 ```typescript
32 import { Composio } from '@composio/core';
33
126 -const composio = new Composio({ apiKey: 'your-api-key' });
34 +const composio = new Composio();
35
128 -// List active triggers with optional filters
36 const active = await composio.triggers.listActive({
37 connectedAccountIds: ['ca_def456'],
38 });
@@ -144,12 +51,11 @@ if (active.nextCursor) {
51
52 | Filter | Description |
53 |--------|-------------|
147 -| `connectedAccountIds` | Array of connected account IDs |
148 -| `triggerIds` | Array of trigger instance IDs |
149 -| `triggerNames` | Array of trigger type slugs |
150 -| `authConfigIds` | Array of auth config IDs |
151 -| `showDisabled` | Include disabled triggers (default: `false`) |
152 -| `cursor` | Pagination cursor from previous response |
54 +| `connected_account_ids` / `connectedAccountIds` | Array of connected account IDs |
55 +| `trigger_ids` / `triggerIds` | Array of trigger instance IDs |
56 +| `trigger_names` / `triggerNames` | Array of trigger type slugs |
57 +| `auth_config_ids` / `authConfigIds` | Array of auth config IDs |
58 +| `show_disabled` / `showDisabled` | Include disabled triggers (default: `false`) |
59
60 ## Enable / Disable triggers
61
@@ -158,10 +64,6 @@ Pause a trigger temporarily without deleting it:
64 <Tabs groupId="language" items={['Python', 'TypeScript']} persist>
65 <Tab value="Python">
66 ```python
161 -from composio import Composio
162 -
163 -composio = Composio(api_key="your-api-key")
164 -
67 # Disable a trigger
68 composio.triggers.disable(trigger_id="ti_abcd123")
69
@@ -172,7 +74,7 @@ composio.triggers.enable(trigger_id="ti_abcd123")
74 <Tab value="TypeScript">
75 ```typescript
76 import { Composio } from '@composio/core';
175 -const composio = new Composio({ apiKey: 'your-api-key' });
77 +const composio = new Composio();
78 // ---cut---
79 // Disable a trigger
80 await composio.triggers.disable('ti_abcd123');
@@ -183,18 +85,17 @@ await composio.triggers.enable('ti_abcd123');
85 </Tab>
86 </Tabs>
87
186 -You can also manage triggers from the dashboard:
88 +You can also toggle triggers from the dashboard:
89
188 -1. Go to [Auth Configs](https://platform.composio.dev?next_page=/auth-configs)
189 -2. Select your auth config
190 -3. Navigate to "Active Triggers"
191 -4. Toggle the trigger on or off
90 +1. Go to [Auth Configs](https://platform.composio.dev?next_page=/auth-configs) and select your auth config
91 +2. Navigate to **Active Triggers**
92 +3. Toggle the trigger on or off
93
94 <Figure
95 src="/images/trigger-enable-disable.png"
195 - alt="Enable/disable triggers"
196 - caption="Enable/disable triggers in dashboard"
197 - size="sm"
96 + alt="Enable/disable triggers from the dashboard"
97 + caption="Enable/disable triggers from the dashboard"
98 + size="lg"
99 />
100
101 ## Deleting triggers
@@ -204,17 +105,13 @@ Permanently remove a trigger instance:
105 <Tabs groupId="language" items={['Python', 'TypeScript']} persist>
106 <Tab value="Python">
107 ```python
207 -from composio import Composio
208 -
209 -composio = Composio(api_key="your-api-key")
210 -
108 composio.triggers.delete(trigger_id="ti_abcd123")
109 ```
110 </Tab>
111 <Tab value="TypeScript">
112 ```typescript
113 import { Composio } from '@composio/core';
217 -const composio = new Composio({ apiKey: 'your-api-key' });
114 +const composio = new Composio();
115 // ---cut---
116 await composio.triggers.delete('ti_abcd123');
117 ```
@@ -222,7 +119,5 @@ await composio.triggers.delete('ti_abcd123');
119 </Tabs>
120
121 <Callout type="warn">
225 -Deleting a trigger is permanent. If you want to temporarily stop receiving events, use `disable()` instead.
122 +Deleting a trigger is permanent. Use `disable()` instead to temporarily stop receiving events.
123 </Callout>
227 -
228 -<Card icon={<Wrench />} title="Troubleshooting triggers" href="/docs/troubleshooting/triggers" description="Common issues and how to resolve them" />
docs/public/images/trigger-enable-disable.png
Binary files a/docs/public/images/trigger-enable-disable.png and b/docs/public/images/trigger-enable-disable.png differ