mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
25c0c030ce
Some checks failed
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Check Documentation Broken Links / Check broken links (push) Has been cancelled
Notify Downstream / notify-downstream (push) Has been cancelled
Mark stale issues and pull requests / stale (push) Has been cancelled
* adjust aop to amp docs lang * whoop no print
98 lines
2.7 KiB
Plaintext
98 lines
2.7 KiB
Plaintext
---
|
|
title: "Gmail Trigger"
|
|
description: "Trigger automations when Gmail events occur (e.g., new emails, labels)."
|
|
icon: "envelope"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
Use the Gmail Trigger to kick off your deployed crews when Gmail events happen in connected accounts, such as receiving a new email or messages matching a label/filter.
|
|
|
|
<Tip>
|
|
Make sure Gmail is connected in Tools & Integrations and the trigger is
|
|
enabled for your deployment.
|
|
</Tip>
|
|
|
|
## Enabling the Gmail Trigger
|
|
|
|
1. Open your deployment in CrewAI AMP
|
|
2. Go to the **Triggers** tab
|
|
3. Locate **Gmail** and switch the toggle to enable
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/trigger-selected.png"
|
|
alt="Enable or disable triggers with toggle"
|
|
/>
|
|
</Frame>
|
|
|
|
## Example: Process new emails
|
|
|
|
When a new email arrives, the Gmail Trigger will send the payload to your Crew or Flow. Below is a Crew example that parses and processes the trigger payload.
|
|
|
|
```python
|
|
@CrewBase
|
|
class GmailProcessingCrew:
|
|
@agent
|
|
def parser(self) -> Agent:
|
|
return Agent(
|
|
config=self.agents_config['parser'],
|
|
)
|
|
|
|
@task
|
|
def parse_gmail_payload(self) -> Task:
|
|
return Task(
|
|
config=self.tasks_config['parse_gmail_payload'],
|
|
agent=self.parser(),
|
|
)
|
|
|
|
@task
|
|
def act_on_email(self) -> Task:
|
|
return Task(
|
|
config=self.tasks_config['act_on_email'],
|
|
agent=self.parser(),
|
|
)
|
|
```
|
|
|
|
The Gmail payload will be available via the standard context mechanisms.
|
|
|
|
### Testing Locally
|
|
|
|
Test your Gmail trigger integration locally using the CrewAI CLI:
|
|
|
|
```bash
|
|
# View all available triggers
|
|
crewai triggers list
|
|
|
|
# Simulate a Gmail trigger with realistic payload
|
|
crewai triggers run gmail/new_email_received
|
|
```
|
|
|
|
The `crewai triggers run` command will execute your crew with a complete Gmail payload, allowing you to test your parsing logic before deployment.
|
|
|
|
<Warning>
|
|
Use `crewai triggers run gmail/new_email_received` (not `crewai run`) to
|
|
simulate trigger execution during development. After deployment, your crew
|
|
will automatically receive the trigger payload.
|
|
</Warning>
|
|
|
|
## Monitoring Executions
|
|
|
|
Track history and performance of triggered runs:
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/enterprise/list-executions.png"
|
|
alt="List of executions triggered by automation"
|
|
/>
|
|
</Frame>
|
|
|
|
## Troubleshooting
|
|
|
|
- Ensure Gmail is connected in Tools & Integrations
|
|
- Verify the Gmail Trigger is enabled on the Triggers tab
|
|
- Test locally with `crewai triggers run gmail/new_email_received` to see the exact payload structure
|
|
- Check the execution logs and confirm the payload is passed as `crewai_trigger_payload`
|
|
- Remember: use `crewai triggers run` (not `crewai run`) to simulate trigger execution
|