@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 20 lines 1.41 KB
Raw
1 Triggers let you subscribe to events from a user's connected app, such as a new Gmail message, a GitHub commit, or a Slack message, and receive the event data as a structured payload at your webhook endpoint.
2
3 There are two layers to understand:
4
5 - A **trigger type** is a template that defines what event to listen for and what configuration it needs. For example, `GITHUB_COMMIT_EVENT` requires an `owner` and a `repo`. Each toolkit exposes its own trigger types.
6 - A **trigger instance** is a trigger type scoped to a specific user and connected account. Creating one produces an instance with its own `ti_*` ID that you can enable, disable, or delete independently.
7
8 Reach for these endpoints when you want to:
9
10 - Discover the trigger types a toolkit offers, or fetch one type by `slug` to inspect its config and payload schema.
11 - Create or update a trigger instance for a connected account with the upsert endpoint.
12 - List active trigger instances, or enable, disable, and delete an instance by `triggerId`.
13
14 These endpoints authenticate with your project API key in the `x-api-key` header.
15
16 <Callout type="info">
17 Creating a trigger instance only registers it. To actually receive events, set a webhook URL for your project once, then route incoming events on `metadata.trigger_slug`. See [Subscribing to events](/docs/setting-up-triggers/subscribing-to-events).
18 </Callout>
19
20 For the full concept overview, see [Triggers](/docs/triggers).