mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-08 15:48:29 +00:00
Some checks failed
* WIP: v1 docs (#3626) (cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c) * docs: parity for all translations * docs: full name of acronym AMP * docs: fix lingering unused code * docs: expand contextual options in docs.json * docs: add contextual action to request feature on GitHub * chore: tidy docs formatting
256 lines
11 KiB
Plaintext
256 lines
11 KiB
Plaintext
---
|
|
title: "Triggers Overview"
|
|
description: "Understand how CrewAI AMP triggers work, how to manage them, and where to find integration-specific playbooks"
|
|
icon: "face-smile"
|
|
mode: "wide"
|
|
---
|
|
|
|
CrewAI AMP triggers connect your automations to real-time events across the tools your teams already use. Instead of polling systems or relying on manual kickoffs, triggers listen for changes—new emails, calendar updates, CRM status changes—and immediately launch the crew or flow you specify.
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
### Integration Playbooks
|
|
|
|
Deep-dive guides walk through setup and sample workflows for each integration:
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Gmail Trigger" icon="envelope">
|
|
<a href="/en/enterprise/guides/gmail-trigger">Enable crews when emails arrive or threads update.</a>
|
|
</Card>
|
|
|
|
<Card title="Google Calendar Trigger" icon="calendar-days">
|
|
<a href="/en/enterprise/guides/google-calendar-trigger">React to calendar events as they are created, updated, or cancelled.</a>
|
|
</Card>
|
|
|
|
<Card title="Google Drive Trigger" icon="folder-open">
|
|
<a href="/en/enterprise/guides/google-drive-trigger">Handle Drive file uploads, edits, and deletions.</a>
|
|
</Card>
|
|
|
|
<Card title="Outlook Trigger" icon="envelope-open">
|
|
<a href="/en/enterprise/guides/outlook-trigger">Automate responses to new Outlook messages and calendar updates.</a>
|
|
</Card>
|
|
|
|
<Card title="OneDrive Trigger" icon="cloud">
|
|
<a href="/en/enterprise/guides/onedrive-trigger">Audit file activity and sharing changes in OneDrive.</a>
|
|
</Card>
|
|
|
|
<Card title="Microsoft Teams Trigger" icon="comments">
|
|
<a href="/en/enterprise/guides/microsoft-teams-trigger">Kick off workflows when new Teams chats start.</a>
|
|
</Card>
|
|
|
|
<Card title="HubSpot Trigger" icon="hubspot">
|
|
<a href="/en/enterprise/guides/hubspot-trigger">Launch automations from HubSpot workflows and lifecycle events.</a>
|
|
</Card>
|
|
|
|
<Card title="Salesforce Trigger" icon="salesforce">
|
|
<a href="/en/enterprise/guides/salesforce-trigger">Connect Salesforce processes to CrewAI for CRM automation.</a>
|
|
</Card>
|
|
|
|
<Card title="Slack Trigger" icon="slack">
|
|
<a href="/en/enterprise/guides/slack-trigger">Start crews directly from Slack slash commands.</a>
|
|
</Card>
|
|
|
|
<Card title="Zapier Trigger" icon="bolt">
|
|
<a href="/en/enterprise/guides/zapier-trigger">Bridge CrewAI with thousands of Zapier-supported apps.</a>
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Trigger Capabilities
|
|
|
|
With triggers, you can:
|
|
|
|
- **Respond to real-time events** - Automatically execute workflows when specific conditions are met
|
|
- **Integrate with external systems** - Connect with platforms like Gmail, Outlook, OneDrive, JIRA, Slack, Stripe and more
|
|
- **Scale your automation** - Handle high-volume events without manual intervention
|
|
- **Maintain context** - Access trigger data within your crews and flows
|
|
|
|
## Managing Triggers
|
|
|
|
### Viewing Available Triggers
|
|
|
|
To access and manage your automation triggers:
|
|
|
|
1. Navigate to your deployment in the CrewAI dashboard
|
|
2. Click on the **Triggers** tab to view all available trigger integrations
|
|
|
|
<Frame caption="Example of available automation triggers for a Gmail deployment">
|
|
<img src="/images/enterprise/list-available-triggers.png" alt="List of available automation triggers" />
|
|
</Frame>
|
|
|
|
This view shows all the trigger integrations available for your deployment, along with their current connection status.
|
|
|
|
### Enabling and Disabling Triggers
|
|
|
|
Each trigger can be easily enabled or disabled using the toggle switch:
|
|
|
|
<Frame caption="Enable or disable triggers with toggle">
|
|
<img src="/images/enterprise/trigger-selected.png" alt="Enable or disable triggers with toggle" />
|
|
</Frame>
|
|
|
|
- **Enabled (blue toggle)**: The trigger is active and will automatically execute your deployment when the specified events occur
|
|
- **Disabled (gray toggle)**: The trigger is inactive and will not respond to events
|
|
|
|
Simply click the toggle to change the trigger state. Changes take effect immediately.
|
|
|
|
### Monitoring Trigger Executions
|
|
|
|
Track the performance and history of your triggered executions:
|
|
|
|
<Frame caption="List of executions triggered by automation">
|
|
<img src="/images/enterprise/list-executions.png" alt="List of executions triggered by automation" />
|
|
</Frame>
|
|
|
|
## Building Trigger-Driven Automations
|
|
|
|
Before building your automation, it's helpful to understand the structure of trigger payloads that your crews and flows will receive.
|
|
|
|
### Trigger Setup Checklist
|
|
|
|
Before wiring a trigger into production, make sure you:
|
|
|
|
- Connect the integration under **Tools & Integrations** and complete any OAuth or API key steps
|
|
- Enable the trigger toggle on the deployment that should respond to events
|
|
- Provide any required environment variables (API tokens, tenant IDs, shared secrets)
|
|
- Create or update tasks that can parse the incoming payload within the first crew task or flow step
|
|
- Decide whether to pass trigger context automatically using `allow_crewai_trigger_context`
|
|
- Set up monitoring—webhook logs, CrewAI execution history, and optional external alerting
|
|
|
|
### Payload & Crew Examples Repository
|
|
|
|
We maintain a comprehensive repository with end-to-end trigger examples to help you build and test your automations:
|
|
|
|
This repository contains:
|
|
|
|
- **Realistic payload samples** for every supported trigger integration
|
|
- **Ready-to-run crew implementations** that parse each payload and turn it into a business workflow
|
|
- **Multiple scenarios per integration** (e.g., new events, updates, deletions) so you can match the shape of your data
|
|
|
|
| Integration | When it fires | Payload Samples | Crew Examples |
|
|
| :-- | :-- | :-- | :-- |
|
|
| Gmail | New messages, thread updates | [New alerts, thread updates](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) | [`new-email-crew.py`, `gmail-alert-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) |
|
|
| Google Calendar | Event created / updated / started / ended / cancelled | [Event lifecycle payloads](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) | [`calendar-event-crew.py`, `calendar-meeting-crew.py`, `calendar-working-location-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) |
|
|
| Google Drive | File created / updated / deleted | [File lifecycle payloads](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) | [`drive-file-crew.py`, `drive-file-deletion-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) |
|
|
| Outlook | New email, calendar event removed | [Outlook payloads](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) | [`outlook-message-crew.py`, `outlook-event-removal-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) |
|
|
| OneDrive | File operations (create, update, share, delete) | [OneDrive payloads](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) | [`onedrive-file-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) |
|
|
| HubSpot | Record created / updated (contacts, companies, deals) | [HubSpot payloads](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/hubspot) | [`hubspot-company-crew.py`, `hubspot-contact-crew.py`, `hubspot-record-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/hubspot) |
|
|
| Microsoft Teams | Chat thread created | [Teams chat payload](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) | [`teams-chat-created-crew.py`](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) |
|
|
|
|
Use these samples to understand payload shape, copy the matching crew, and then replace the test payload with your live trigger data.
|
|
|
|
### Triggers with Crew
|
|
|
|
Your existing crew definitions work seamlessly with triggers, you just need to have a task to parse the received payload:
|
|
|
|
```python
|
|
@CrewBase
|
|
class MyAutomatedCrew:
|
|
@agent
|
|
def researcher(self) -> Agent:
|
|
return Agent(
|
|
config=self.agents_config['researcher'],
|
|
)
|
|
|
|
@task
|
|
def parse_trigger_payload(self) -> Task:
|
|
return Task(
|
|
config=self.tasks_config['parse_trigger_payload'],
|
|
agent=self.researcher(),
|
|
)
|
|
|
|
@task
|
|
def analyze_trigger_content(self) -> Task:
|
|
return Task(
|
|
config=self.tasks_config['analyze_trigger_data'],
|
|
agent=self.researcher(),
|
|
)
|
|
```
|
|
|
|
The crew will automatically receive and can access the trigger payload through the standard CrewAI context mechanisms.
|
|
|
|
<Note>
|
|
Crew and Flow inputs can include `crewai_trigger_payload`. CrewAI automatically injects this payload:
|
|
- Tasks: appended to the first task's description by default ("Trigger Payload: {crewai_trigger_payload}")
|
|
- Control via `allow_crewai_trigger_context`: set `True` to always inject, `False` to never inject
|
|
- Flows: any `@start()` method that accepts a `crewai_trigger_payload` parameter will receive it
|
|
</Note>
|
|
|
|
### Integration with Flows
|
|
|
|
For flows, you have more control over how trigger data is handled:
|
|
|
|
#### Accessing Trigger Payload
|
|
|
|
All `@start()` methods in your flows will accept an additional parameter called `crewai_trigger_payload`:
|
|
|
|
```python
|
|
from crewai.flow import Flow, start, listen
|
|
|
|
class MyAutomatedFlow(Flow):
|
|
@start()
|
|
def handle_trigger(self, crewai_trigger_payload: dict = None):
|
|
"""
|
|
This start method can receive trigger data
|
|
"""
|
|
if crewai_trigger_payload:
|
|
# Process the trigger data
|
|
trigger_id = crewai_trigger_payload.get('id')
|
|
event_data = crewai_trigger_payload.get('payload', {})
|
|
|
|
# Store in flow state for use by other methods
|
|
self.state.trigger_id = trigger_id
|
|
self.state.trigger_type = event_data
|
|
|
|
return event_data
|
|
|
|
# Handle manual execution
|
|
return None
|
|
|
|
@listen(handle_trigger)
|
|
def process_data(self, trigger_data):
|
|
"""
|
|
Process the data from the trigger
|
|
"""
|
|
# ... process the trigger
|
|
```
|
|
|
|
#### Triggering Crews from Flows
|
|
|
|
When kicking off a crew within a flow that was triggered, pass the trigger payload as it:
|
|
|
|
```python
|
|
@start()
|
|
def delegate_to_crew(self, crewai_trigger_payload: dict = None):
|
|
"""
|
|
Delegate processing to a specialized crew
|
|
"""
|
|
crew = MySpecializedCrew()
|
|
|
|
# Pass the trigger payload to the crew
|
|
result = crew.crew().kickoff(
|
|
inputs={
|
|
'a_custom_parameter': "custom_value",
|
|
'crewai_trigger_payload': crewai_trigger_payload
|
|
},
|
|
)
|
|
|
|
return result
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
**Trigger not firing:**
|
|
- Verify the trigger is enabled
|
|
- Check integration connection status
|
|
|
|
**Execution failures:**
|
|
- Check the execution logs for error details
|
|
- If you are developing, make sure the inputs include the `crewai_trigger_payload` parameter with the correct payload
|
|
|
|
Automation triggers transform your CrewAI deployments into responsive, event-driven systems that can seamlessly integrate with your existing business processes and tools.
|
|
|
|
<Card title="CrewAI AMP Trigger Examples" href="https://github.com/crewAIInc/crewai-enterprise-trigger-examples" icon="github">
|
|
Check them out on GitHub!
|
|
</Card>
|