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, 12:15 UTC
docs: update toolkits and API data
Sushmithamallesh committed
Sep 17, 2026 at 10:05 UTC
5f7494cbaf61afe3a9b9cab0941ee44a8ea5b9b4
4 files changed
+112
-16
docs/content/reference/api-reference/triggers/index.mdx
+1
-1
@@ -28,4 +28,4 @@ For the full concept overview, see [Triggers](/docs/triggers).
28
29
## Endpoints
30
31
-<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/trigger_instances/{slug}/upsert","pathV3":"/api/v3/trigger_instances/{slug}/upsert","summary":"Create or update a trigger","href":"/reference/api-reference/triggers/postTriggerInstancesBySlugUpsert"},{"method":"GET","pathV31":"/api/v3.1/trigger_instances/active","pathV3":"/api/v3/trigger_instances/active","summary":"List active triggers","href":"/reference/api-reference/triggers/getTriggerInstancesActive"},{"method":"DELETE","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Delete a trigger","href":"/reference/api-reference/triggers/deleteTriggerInstancesManageByTriggerId"},{"method":"PATCH","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Enable or disable a trigger","href":"/reference/api-reference/triggers/patchTriggerInstancesManageByTriggerId"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/list/enum","pathV3":"/api/v3/triggers_types/list/enum","summary":"List trigger type enums","href":"/reference/api-reference/triggers/getTriggersTypesListEnum"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/{slug}","pathV3":"/api/v3/triggers_types/{slug}","summary":"Get trigger type by slug","href":"/reference/api-reference/triggers/getTriggersTypesBySlug"},{"method":"GET","pathV31":"/api/v3.1/triggers_types","pathV3":"/api/v3/triggers_types","summary":"List trigger types","href":"/reference/api-reference/triggers/getTriggersTypes"}]} />
31
+<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/trigger_instances/{slug}/upsert","pathV3":"/api/v3/trigger_instances/{slug}/upsert","summary":"Create or update a trigger","href":"/reference/api-reference/triggers/postTriggerInstancesBySlugUpsert"},{"method":"GET","pathV31":"/api/v3.1/trigger_instances/active","pathV3":"/api/v3/trigger_instances/active","summary":"List active triggers","href":"/reference/api-reference/triggers/getTriggerInstancesActive"},{"method":"DELETE","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Delete a trigger","href":"/reference/api-reference/triggers/deleteTriggerInstancesManageByTriggerId"},{"method":"PATCH","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Update a trigger","href":"/reference/api-reference/triggers/patchTriggerInstancesManageByTriggerId"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/list/enum","pathV3":"/api/v3/triggers_types/list/enum","summary":"List trigger type enums","href":"/reference/api-reference/triggers/getTriggersTypesListEnum"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/{slug}","pathV3":"/api/v3/triggers_types/{slug}","summary":"Get trigger type by slug","href":"/reference/api-reference/triggers/getTriggersTypesBySlug"},{"method":"GET","pathV31":"/api/v3.1/triggers_types","pathV3":"/api/v3/triggers_types","summary":"List trigger types","href":"/reference/api-reference/triggers/getTriggersTypes"}]} />
docs/content/reference/v3/api-reference/triggers/index.mdx
+1
-1
@@ -28,4 +28,4 @@ For the full concept overview, see [Triggers](/docs/triggers).
28
29
## Endpoints
30
31
-<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/trigger_instances/{slug}/upsert","pathV3":"/api/v3/trigger_instances/{slug}/upsert","summary":"Create or update a trigger","href":"/reference/v3/api-reference/triggers/postTriggerInstancesBySlugUpsert"},{"method":"GET","pathV31":"/api/v3.1/trigger_instances/active","pathV3":"/api/v3/trigger_instances/active","summary":"List active triggers","href":"/reference/v3/api-reference/triggers/getTriggerInstancesActive"},{"method":"DELETE","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Delete a trigger","href":"/reference/v3/api-reference/triggers/deleteTriggerInstancesManageByTriggerId"},{"method":"PATCH","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Enable or disable a trigger","href":"/reference/v3/api-reference/triggers/patchTriggerInstancesManageByTriggerId"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/list/enum","pathV3":"/api/v3/triggers_types/list/enum","summary":"List trigger type enums","href":"/reference/v3/api-reference/triggers/getTriggersTypesListEnum"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/{slug}","pathV3":"/api/v3/triggers_types/{slug}","summary":"Get trigger type by slug","href":"/reference/v3/api-reference/triggers/getTriggersTypesBySlug"},{"method":"GET","pathV31":"/api/v3.1/triggers_types","pathV3":"/api/v3/triggers_types","summary":"List trigger types","href":"/reference/v3/api-reference/triggers/getTriggersTypes"}]} />
31
+<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/trigger_instances/{slug}/upsert","pathV3":"/api/v3/trigger_instances/{slug}/upsert","summary":"Create or update a trigger","href":"/reference/v3/api-reference/triggers/postTriggerInstancesBySlugUpsert"},{"method":"GET","pathV31":"/api/v3.1/trigger_instances/active","pathV3":"/api/v3/trigger_instances/active","summary":"List active triggers","href":"/reference/v3/api-reference/triggers/getTriggerInstancesActive"},{"method":"DELETE","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Delete a trigger","href":"/reference/v3/api-reference/triggers/deleteTriggerInstancesManageByTriggerId"},{"method":"PATCH","pathV31":"/api/v3.1/trigger_instances/manage/{triggerId}","pathV3":"/api/v3/trigger_instances/manage/{triggerId}","summary":"Update a trigger","href":"/reference/v3/api-reference/triggers/patchTriggerInstancesManageByTriggerId"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/list/enum","pathV3":"/api/v3/triggers_types/list/enum","summary":"List trigger type enums","href":"/reference/v3/api-reference/triggers/getTriggersTypesListEnum"},{"method":"GET","pathV31":"/api/v3.1/triggers_types/{slug}","pathV3":"/api/v3/triggers_types/{slug}","summary":"Get trigger type by slug","href":"/reference/v3/api-reference/triggers/getTriggersTypesBySlug"},{"method":"GET","pathV31":"/api/v3.1/triggers_types","pathV3":"/api/v3/triggers_types","summary":"List trigger types","href":"/reference/v3/api-reference/triggers/getTriggersTypes"}]} />
docs/public/openapi-v3.json
+55
-7
@@ -9136,6 +9136,16 @@
9136
}
9137
}
9138
},
9139
+ "429": {
9140
+ "description": "Too many requests - The upstream service is rate limiting the request; retry after a short backoff",
9141
+ "content": {
9142
+ "application/json": {
9143
+ "schema": {
9144
+ "$ref": "#/components/schemas/Error"
9145
+ }
9146
+ }
9147
+ }
9148
+ },
9149
"500": {
9150
"description": "Internal server error - Failed to sync toolkit",
9151
"content": {
@@ -12073,6 +12083,13 @@
12083
"type": "string",
12084
"description": "The user id (entity id) that owns the connection. When connected_account_id is omitted, the first active connection for this user and the trigger's toolkit is auto-resolved (same as tool execution). When connected_account_id is also provided and the project has 2FA enabled, user_id is validated against the owner of that connection."
12085
},
12086
+ "egress_url": {
12087
+ "type": "string",
12088
+ "nullable": true,
12089
+ "maxLength": 2048,
12090
+ "format": "uri",
12091
+ "description": "Overrides the delivery URL for this trigger instance only: its events are sent to this HTTPS URL instead of the project webhook URL. Your project webhook subscription is still required and still controls signing (the webhook secret), the payload version and which events are enabled; only the destination changes for this instance. Omit to leave the current value unchanged; pass null to remove the override and deliver to the project webhook URL again."
12092
+ },
12093
"trigger_config": {
12094
"type": "object",
12095
"additionalProperties": {},
@@ -12547,6 +12564,11 @@
12564
"additionalProperties": {},
12565
"description": "Configuration for the trigger"
12566
},
12567
+ "egress_url": {
12568
+ "type": "string",
12569
+ "nullable": true,
12570
+ "description": "Delivery URL override for this trigger instance: its events are sent here instead of the project webhook URL, while signing, the payload version and enabled events still come from the project webhook subscription. Null means no override."
12571
+ },
12572
"state": {
12573
"type": "object",
12574
"nullable": true,
@@ -12612,6 +12634,7 @@
12634
"user_id",
12635
"version",
12636
"trigger_config",
12637
+ "egress_url",
12638
"state",
12639
"updated_at",
12640
"disabled_at",
@@ -12795,8 +12818,8 @@
12818
"x-api-version": "3.0"
12819
},
12820
"patch": {
12798
- "summary": "Enable or disable a trigger",
12799
- "description": "Updates the status of a trigger instance to enable or disable it. Disabling a trigger pauses event listening without deleting the trigger configuration. Re-enabling restores the trigger to its active state. Use this for temporary maintenance or to control trigger execution.",
12821
+ "summary": "Update a trigger",
12822
+ "description": "Updates a trigger instance. Pass status to enable or disable it: disabling pauses event listening without deleting the trigger configuration, and re-enabling restores it. Pass egress_url to override where this instance delivers its events (null removes the override); the project webhook subscription is still required and still controls signing, the payload version and which events are enabled. Send either field or both. On a project with 2FA enabled, user_id is required to set egress_url and, whenever sent, must own the connected account behind the trigger.",
12823
"tags": [
12824
"Triggers"
12825
],
@@ -12823,6 +12846,7 @@
12846
}
12847
],
12848
"requestBody": {
12849
+ "required": true,
12850
"content": {
12851
"application/json": {
12852
"schema": {
@@ -12833,12 +12857,22 @@
12857
"enum": [
12858
"enable",
12859
"disable"
12836
- ]
12860
+ ],
12861
+ "description": "Enable or disable the trigger instance."
12862
+ },
12863
+ "user_id": {
12864
+ "type": "string",
12865
+ "minLength": 1,
12866
+ "description": "The user id that owns the connected account behind this trigger. Optional: when sent on a project with 2FA enabled it must be the owner of a private connection or allowed on a shared one, whatever is being updated. Required to set egress_url when 2FA is enabled. Ignored when 2FA is disabled."
12867
+ },
12868
+ "egress_url": {
12869
+ "type": "string",
12870
+ "nullable": true,
12871
+ "maxLength": 2048,
12872
+ "format": "uri",
12873
+ "description": "Overrides the delivery URL for this trigger instance only: its events are sent to this HTTPS URL instead of the project webhook URL. Your project webhook subscription is still required and still controls signing (the webhook secret), the payload version and which events are enabled; only the destination changes for this instance. Omit to leave the current value unchanged; pass null to remove the override and deliver to the project webhook URL again."
12874
}
12838
- },
12839
- "required": [
12840
- "status"
12841
- ]
12875
+ }
12876
}
12877
}
12878
}
@@ -12886,6 +12920,16 @@
12920
}
12921
}
12922
},
12923
+ "403": {
12924
+ "description": "Forbidden",
12925
+ "content": {
12926
+ "application/json": {
12927
+ "schema": {
12928
+ "$ref": "#/components/schemas/Error"
12929
+ }
12930
+ }
12931
+ }
12932
+ },
12933
"404": {
12934
"description": "Trigger instance not found",
12935
"content": {
@@ -21430,6 +21474,10 @@
21474
"type": "string",
21475
"description": "ID of cached plan if available"
21476
},
21477
+ "cached_plan_usecase": {
21478
+ "type": "string",
21479
+ "description": "Use case the cached plan was originally built for, if a cached plan is available. May differ from `use_case` when the cached plan was matched from a similar query."
21480
+ },
21481
"error": {
21482
"type": "string",
21483
"nullable": true,
docs/public/openapi.json
+55
-7
@@ -10385,6 +10385,10 @@
10385
"type": "string",
10386
"description": "ID of cached plan if available"
10387
},
10388
+ "cached_plan_usecase": {
10389
+ "type": "string",
10390
+ "description": "Use case the cached plan was originally built for, if a cached plan is available. May differ from `use_case` when the cached plan was matched from a similar query."
10391
+ },
10392
"error": {
10393
"type": "string",
10394
"nullable": true,
@@ -20212,6 +20216,16 @@
20216
}
20217
}
20218
},
20219
+ "429": {
20220
+ "description": "Too many requests - The upstream service is rate limiting the request; retry after a short backoff",
20221
+ "content": {
20222
+ "application/json": {
20223
+ "schema": {
20224
+ "$ref": "#/components/schemas/Error"
20225
+ }
20226
+ }
20227
+ }
20228
+ },
20229
"500": {
20230
"description": "Internal server error - Failed to sync toolkit",
20231
"content": {
@@ -21382,6 +21396,13 @@
21396
"type": "string",
21397
"description": "The user id (entity id) that owns the connection. When connected_account_id is omitted, the first active connection for this user and the trigger's toolkit is auto-resolved (same as tool execution). When connected_account_id is also provided and the project has 2FA enabled, user_id is validated against the owner of that connection."
21398
},
21399
+ "egress_url": {
21400
+ "type": "string",
21401
+ "nullable": true,
21402
+ "maxLength": 2048,
21403
+ "format": "uri",
21404
+ "description": "Overrides the delivery URL for this trigger instance only: its events are sent to this HTTPS URL instead of the project webhook URL. Your project webhook subscription is still required and still controls signing (the webhook secret), the payload version and which events are enabled; only the destination changes for this instance. Omit to leave the current value unchanged; pass null to remove the override and deliver to the project webhook URL again."
21405
+ },
21406
"trigger_config": {
21407
"type": "object",
21408
"additionalProperties": {},
@@ -21856,6 +21877,11 @@
21877
"additionalProperties": {},
21878
"description": "Configuration for the trigger"
21879
},
21880
+ "egress_url": {
21881
+ "type": "string",
21882
+ "nullable": true,
21883
+ "description": "Delivery URL override for this trigger instance: its events are sent here instead of the project webhook URL, while signing, the payload version and enabled events still come from the project webhook subscription. Null means no override."
21884
+ },
21885
"state": {
21886
"type": "object",
21887
"nullable": true,
@@ -21921,6 +21947,7 @@
21947
"user_id",
21948
"version",
21949
"trigger_config",
21950
+ "egress_url",
21951
"state",
21952
"updated_at",
21953
"disabled_at",
@@ -22104,8 +22131,8 @@
22131
"x-api-version": "3.1"
22132
},
22133
"patch": {
22107
- "summary": "Enable or disable a trigger",
22108
- "description": "Updates the status of a trigger instance to enable or disable it. Disabling a trigger pauses event listening without deleting the trigger configuration. Re-enabling restores the trigger to its active state. Use this for temporary maintenance or to control trigger execution.",
22134
+ "summary": "Update a trigger",
22135
+ "description": "Updates a trigger instance. Pass status to enable or disable it: disabling pauses event listening without deleting the trigger configuration, and re-enabling restores it. Pass egress_url to override where this instance delivers its events (null removes the override); the project webhook subscription is still required and still controls signing, the payload version and which events are enabled. Send either field or both. On a project with 2FA enabled, user_id is required to set egress_url and, whenever sent, must own the connected account behind the trigger.",
22136
"tags": [
22137
"Triggers"
22138
],
@@ -22132,6 +22159,7 @@
22159
}
22160
],
22161
"requestBody": {
22162
+ "required": true,
22163
"content": {
22164
"application/json": {
22165
"schema": {
@@ -22142,12 +22170,22 @@
22170
"enum": [
22171
"enable",
22172
"disable"
22145
- ]
22173
+ ],
22174
+ "description": "Enable or disable the trigger instance."
22175
+ },
22176
+ "user_id": {
22177
+ "type": "string",
22178
+ "minLength": 1,
22179
+ "description": "The user id that owns the connected account behind this trigger. Optional: when sent on a project with 2FA enabled it must be the owner of a private connection or allowed on a shared one, whatever is being updated. Required to set egress_url when 2FA is enabled. Ignored when 2FA is disabled."
22180
+ },
22181
+ "egress_url": {
22182
+ "type": "string",
22183
+ "nullable": true,
22184
+ "maxLength": 2048,
22185
+ "format": "uri",
22186
+ "description": "Overrides the delivery URL for this trigger instance only: its events are sent to this HTTPS URL instead of the project webhook URL. Your project webhook subscription is still required and still controls signing (the webhook secret), the payload version and which events are enabled; only the destination changes for this instance. Omit to leave the current value unchanged; pass null to remove the override and deliver to the project webhook URL again."
22187
}
22147
- },
22148
- "required": [
22149
- "status"
22150
- ]
22188
+ }
22189
}
22190
}
22191
}
@@ -22195,6 +22233,16 @@
22233
}
22234
}
22235
},
22236
+ "403": {
22237
+ "description": "Forbidden",
22238
+ "content": {
22239
+ "application/json": {
22240
+ "schema": {
22241
+ "$ref": "#/components/schemas/Error"
22242
+ }
22243
+ }
22244
+ }
22245
+ },
22246
"404": {
22247
"description": "Trigger instance not found",
22248
"content": {