Creating triggers

A trigger watches for one event (like GITHUB_COMMIT_EVENT) on one user's connected account. Create one, and events start flowing to your subscription or webhook URL. For the bigger picture, see Triggers.

The user needs a connected account for the toolkit you want to monitor. See Authentication if you haven't set that up.

Inspect the trigger type

Each trigger type declares the config it needs. Check it before you create, so you pass the right fields.

from composio import Composio

composio = Composio()

trigger_type = composio.triggers.get_type("GITHUB_COMMIT_EVENT")
print(trigger_type.config)
# {"properties": {"owner": {...}, "repo": {...}}, "required": ["owner", "repo"]}
import { Composio } from '@composio/core';

const composio = new Composio();

const triggerType = await composio.triggers.getType('GITHUB_COMMIT_EVENT');
console.log(triggerType.config);
// {"properties": {"owner": {...}, "repo": {...}}, "required": ["owner", "repo"]}

Create the trigger

Pass the user, the trigger slug, and the config the type requires.

from composio import Composio

composio = Composio()
user_id = "user-id-123435"

# The user needs a connected account for this toolkit before this runs.
# Set it up first. See /docs/authentication.
trigger = composio.triggers.create(
    slug="GITHUB_COMMIT_EVENT",
    user_id=user_id,
    trigger_config={"owner": "your-repo-owner", "repo": "your-repo-name"},
)
print(f"Trigger created: {trigger.trigger_id}")
import { Composio } from '@composio/core';

const composio = new Composio();
const userId = 'user-id-123435';

// The user needs a connected account for this toolkit before this runs.
// Set it up first. See /docs/authentication.
const trigger = await composio.triggers.create(userId, 'GITHUB_COMMIT_EVENT', {
  triggerConfig: { owner: 'your-repo-owner', repo: 'your-repo-name' },
});
console.log(`Trigger created: ${trigger.triggerId}`);

You only pass a user_id. The SDK looks up that user's connected account for the toolkit automatically.

Targeting a specific connected account

If a user has more than one connected account for the toolkit, the SDK uses the most recently created one. Pass a connected account ID to pick exactly which account the trigger watches.

trigger = composio.triggers.create(
    slug="GITHUB_COMMIT_EVENT",
    user_id=user_id,
    connected_account_id="ca_def456",
    trigger_config={"owner": "your-repo-owner", "repo": "your-repo-name"},
)
const trigger = await composio.triggers.create(userId, 'GITHUB_COMMIT_EVENT', {
  connectedAccountId: 'ca_def456',
  triggerConfig: { owner: 'your-repo-owner', repo: 'your-repo-name' },
});

Trigger instances default to the 'latest' toolkit version. If you parse payloads against a fixed schema, pin a version at SDK initialization.

That's it. The trigger is active. Next, receive its events.

Next

Receiving events

Get trigger events locally with the SDK or in production over your webhook URL

Edit this page on GitHub

On this page

Inspect the trigger typeCreate the triggerTargeting a specific connected accountNext