From da331ce422ef50aeb2eb80a87c1c8b51b8e48bfa Mon Sep 17 00:00:00 2001 From: Lucas Gomide Date: Thu, 9 Oct 2025 16:11:57 -0300 Subject: [PATCH] Update triggers docs (#3678) * docs: introduce triggers list & triggers run command * docs: add KO triggers docs --- docs/docs.json | 12 +++ .../enterprise/guides/automation-triggers.mdx | 74 ++++++++++++------ docs/en/enterprise/guides/gmail-trigger.mdx | 31 ++++---- .../guides/google-calendar-trigger.mdx | 23 ++++-- .../guides/google-drive-trigger.mdx | 22 ++++-- docs/en/enterprise/guides/hubspot-trigger.mdx | 12 --- .../guides/microsoft-teams-trigger.mdx | 20 ++++- .../en/enterprise/guides/onedrive-trigger.mdx | 22 ++++-- docs/en/enterprise/guides/outlook-trigger.mdx | 21 ++++-- .../enterprise/guides/automation-triggers.mdx | 75 +++++++++++++------ docs/ko/enterprise/guides/gmail-trigger.mdx | 31 ++++---- .../guides/google-calendar-trigger.mdx | 23 ++++-- .../guides/google-drive-trigger.mdx | 22 ++++-- docs/ko/enterprise/guides/hubspot-trigger.mdx | 2 - .../guides/microsoft-teams-trigger.mdx | 20 ++++- .../ko/enterprise/guides/onedrive-trigger.mdx | 22 ++++-- docs/ko/enterprise/guides/outlook-trigger.mdx | 21 ++++-- .../enterprise/guides/automation-triggers.mdx | 75 +++++++++++++------ .../pt-BR/enterprise/guides/gmail-trigger.mdx | 31 ++++---- .../guides/google-calendar-trigger.mdx | 23 ++++-- .../guides/google-drive-trigger.mdx | 22 ++++-- .../guides/microsoft-teams-trigger.mdx | 20 ++++- .../enterprise/guides/onedrive-trigger.mdx | 22 ++++-- .../enterprise/guides/outlook-trigger.mdx | 21 ++++-- 24 files changed, 462 insertions(+), 205 deletions(-) diff --git a/docs/docs.json b/docs/docs.json index 09130a46c..312125c57 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -825,6 +825,12 @@ "group": "Triggers", "pages": [ "pt-BR/enterprise/guides/automation-triggers", + "pt-BR/enterprise/guides/gmail-trigger", + "pt-BR/enterprise/guides/google-calendar-trigger", + "pt-BR/enterprise/guides/google-drive-trigger", + "pt-BR/enterprise/guides/outlook-trigger", + "pt-BR/enterprise/guides/onedrive-trigger", + "pt-BR/enterprise/guides/microsoft-teams-trigger", "pt-BR/enterprise/guides/slack-trigger", "pt-BR/enterprise/guides/hubspot-trigger", "pt-BR/enterprise/guides/salesforce-trigger", @@ -1250,6 +1256,12 @@ "group": "트리거", "pages": [ "ko/enterprise/guides/automation-triggers", + "ko/enterprise/guides/gmail-trigger", + "ko/enterprise/guides/google-calendar-trigger", + "ko/enterprise/guides/google-drive-trigger", + "ko/enterprise/guides/outlook-trigger", + "ko/enterprise/guides/onedrive-trigger", + "ko/enterprise/guides/microsoft-teams-trigger", "ko/enterprise/guides/slack-trigger", "ko/enterprise/guides/hubspot-trigger", "ko/enterprise/guides/salesforce-trigger", diff --git a/docs/en/enterprise/guides/automation-triggers.mdx b/docs/en/enterprise/guides/automation-triggers.mdx index 61fe4691c..7ca9d83ab 100644 --- a/docs/en/enterprise/guides/automation-triggers.mdx +++ b/docs/en/enterprise/guides/automation-triggers.mdx @@ -117,27 +117,50 @@ Before wiring a trigger into production, make sure you: - 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 +### Testing Triggers Locally with CLI -We maintain a comprehensive repository with end-to-end trigger examples to help you build and test your automations: +The CrewAI CLI provides powerful commands to help you develop and test trigger-driven automations without deploying to production. -This repository contains: +#### List Available Triggers -- **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 +View all available triggers for your connected integrations: -| 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) | +```bash +crewai triggers list +``` + +This command displays all triggers available based on your connected integrations, showing: +- Integration name and connection status +- Available trigger types +- Trigger names and descriptions + +#### Simulate Trigger Execution + +Test your crew with realistic trigger payloads before deployment: + +```bash +crewai triggers run +``` + +For example: + +```bash +crewai triggers run microsoft_onedrive/file_changed +``` + +This command: +- Executes your crew locally +- Passes a complete, realistic trigger payload +- Simulates exactly how your crew will be called in production + + + **Important Development Notes:** + - Use `crewai triggers run ` to simulate trigger execution during development + - Using `crewai run` will NOT simulate trigger calls and won't pass the trigger payload + - After deployment, your crew will be executed with the actual trigger payload + - If your crew expects parameters that aren't in the trigger payload, execution may fail + -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 @@ -241,15 +264,20 @@ def delegate_to_crew(self, crewai_trigger_payload: dict = None): ## Troubleshooting **Trigger not firing:** -- Verify the trigger is enabled -- Check integration connection status +- Verify the trigger is enabled in your deployment's Triggers tab +- Check integration connection status under Tools & Integrations +- Ensure all required environment variables are properly configured **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 +- Use `crewai triggers run ` to test locally and see the exact payload structure +- Verify your crew can handle the `crewai_trigger_payload` parameter +- Ensure your crew doesn't expect parameters that aren't included in the trigger payload + +**Development issues:** +- Always test with `crewai triggers run ` before deploying to see the complete payload +- Remember that `crewai run` does NOT simulate trigger calls—use `crewai triggers run` instead +- Use `crewai triggers list` to verify which triggers are available for your connected integrations +- After deployment, your crew will receive the actual trigger payload, so test thoroughly locally first Automation triggers transform your CrewAI deployments into responsive, event-driven systems that can seamlessly integrate with your existing business processes and tools. - - - Check them out on GitHub! - diff --git a/docs/en/enterprise/guides/gmail-trigger.mdx b/docs/en/enterprise/guides/gmail-trigger.mdx index 2caefc045..4e6e66e15 100644 --- a/docs/en/enterprise/guides/gmail-trigger.mdx +++ b/docs/en/enterprise/guides/gmail-trigger.mdx @@ -51,16 +51,25 @@ class GmailProcessingCrew: ) ``` -The Gmail payload will be available via the standard context mechanisms. See the payload samples repository for structure and fields. +The Gmail payload will be available via the standard context mechanisms. -### Sample payloads & crews +### Testing Locally -The [CrewAI AMP Trigger Examples repository](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) includes: +Test your Gmail trigger integration locally using the CrewAI CLI: -- `new-email-payload-1.json` / `new-email-payload-2.json` — production-style new message alerts with matching crews in `new-email-crew.py` -- `thread-updated-sample-1.json` — follow-up messages on an existing thread, processed by `gmail-alert-crew.py` +```bash +# View all available triggers +crewai triggers list -Use these samples to validate your parsing logic locally before wiring the trigger to your live Gmail accounts. +# Simulate a Gmail trigger with realistic payload +crewai triggers run gmail/new_email +``` + +The `crewai triggers run` command will execute your crew with a complete Gmail payload, allowing you to test your parsing logic before deployment. + + + Use `crewai triggers run gmail/new_email` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload. + ## Monitoring Executions @@ -70,16 +79,10 @@ Track history and performance of triggered runs: List of executions triggered by automation -## Payload Reference - -See the sample payloads and field descriptions: - - - Gmail samples in Trigger Examples Repo - - ## 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` 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 diff --git a/docs/en/enterprise/guides/google-calendar-trigger.mdx b/docs/en/enterprise/guides/google-calendar-trigger.mdx index cf2d32471..4dee7a3dd 100644 --- a/docs/en/enterprise/guides/google-calendar-trigger.mdx +++ b/docs/en/enterprise/guides/google-calendar-trigger.mdx @@ -39,16 +39,23 @@ print(result.raw) Use `crewai_trigger_payload` exactly as it is delivered by the trigger so the crew can extract the proper fields. -## Sample payloads & crews +## Testing Locally -The [Google Calendar examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) show how to handle multiple event types: +Test your Google Calendar trigger integration locally using the CrewAI CLI: -- `new-event.json` → standard event creation handled by `calendar-event-crew.py` -- `event-updated.json` / `event-started.json` / `event-ended.json` → in-flight updates processed by `calendar-meeting-crew.py` -- `event-canceled.json` → cancellation workflow that alerts attendees via `calendar-meeting-crew.py` -- Working location events use `calendar-working-location-crew.py` to extract on-site schedules +```bash +# View all available triggers +crewai triggers list -Each crew transforms raw event metadata (attendees, rooms, working locations) into the summaries your teams need. +# Simulate a Google Calendar trigger with realistic payload +crewai triggers run google_calendar/event_changed +``` + +The `crewai triggers run` command will execute your crew with a complete Calendar payload, allowing you to test your parsing logic before deployment. + + + Use `crewai triggers run google_calendar/event_changed` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload. + ## Monitoring Executions @@ -61,5 +68,7 @@ The **Executions** list in the deployment dashboard tracks every triggered run a ## Troubleshooting - Ensure the correct Google account is connected and the trigger is enabled +- Test locally with `crewai triggers run google_calendar/event_changed` to see the exact payload structure - Confirm your workflow handles all-day events (payloads use `start.date` and `end.date` instead of timestamps) - Check execution logs if reminders or attendee arrays are missing—calendar permissions can limit fields in the payload +- Remember: use `crewai triggers run` (not `crewai run`) to simulate trigger execution diff --git a/docs/en/enterprise/guides/google-drive-trigger.mdx b/docs/en/enterprise/guides/google-drive-trigger.mdx index 19c10837b..f0fc4e938 100644 --- a/docs/en/enterprise/guides/google-drive-trigger.mdx +++ b/docs/en/enterprise/guides/google-drive-trigger.mdx @@ -36,15 +36,23 @@ crew.kickoff({ }) ``` -## Sample payloads & crews +## Testing Locally -Explore the [Google Drive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) to cover different operations: +Test your Google Drive trigger integration locally using the CrewAI CLI: -- `new-file.json` → new uploads processed by `drive-file-crew.py` -- `updated-file.json` → file edits and metadata changes handled by `drive-file-crew.py` -- `deleted-file.json` → deletion events routed through `drive-file-deletion-crew.py` +```bash +# View all available triggers +crewai triggers list -Each crew highlights the file name, operation type, owner, permissions, and security considerations so downstream systems can respond appropriately. +# Simulate a Google Drive trigger with realistic payload +crewai triggers run google_drive/file_changed +``` + +The `crewai triggers run` command will execute your crew with a complete Drive payload, allowing you to test your parsing logic before deployment. + + + Use `crewai triggers run google_drive/file_changed` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload. + ## Monitoring Executions @@ -57,5 +65,7 @@ Track history and performance of triggered runs with the **Executions** list in ## Troubleshooting - Verify Google Drive is connected and the trigger toggle is enabled +- Test locally with `crewai triggers run google_drive/file_changed` to see the exact payload structure - If a payload is missing permission data, ensure the connected account has access to the file or folder - The trigger sends file IDs only; use the Drive API if you need to fetch binary content during the crew run +- Remember: use `crewai triggers run` (not `crewai run`) to simulate trigger execution diff --git a/docs/en/enterprise/guides/hubspot-trigger.mdx b/docs/en/enterprise/guides/hubspot-trigger.mdx index c2a7549f3..0c95db0f6 100644 --- a/docs/en/enterprise/guides/hubspot-trigger.mdx +++ b/docs/en/enterprise/guides/hubspot-trigger.mdx @@ -49,16 +49,4 @@ This guide provides a step-by-step process to set up HubSpot triggers for CrewAI -## Additional Resources - -### Sample payloads & crews - -You can jump-start development with the [HubSpot examples in the trigger repository](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/hubspot): - -- `record-created-contact.json`, `record-updated-contact.json` → contact lifecycle events handled by `hubspot-contact-crew.py` -- `record-created-company.json`, `record-updated-company.json` → company enrichment flows in `hubspot-company-crew.py` -- `record-created-deals.json`, `record-updated-deals.json` → deal pipeline automation in `hubspot-record-crew.py` - -Each crew demonstrates how to parse HubSpot record fields, enrich context, and return structured insights. - For more detailed information on available actions and customization options, refer to the [HubSpot Workflows Documentation](https://knowledge.hubspot.com/workflows/create-workflows). diff --git a/docs/en/enterprise/guides/microsoft-teams-trigger.mdx b/docs/en/enterprise/guides/microsoft-teams-trigger.mdx index 10878af40..00434632b 100644 --- a/docs/en/enterprise/guides/microsoft-teams-trigger.mdx +++ b/docs/en/enterprise/guides/microsoft-teams-trigger.mdx @@ -37,16 +37,28 @@ print(result.raw) The crew parses thread metadata (subject, created time, roster) and generates an action plan for the receiving team. -## Sample payloads & crews +## Testing Locally -The [Microsoft Teams examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) include: +Test your Microsoft Teams trigger integration locally using the CrewAI CLI: -- `chat-created.json` → chat creation payload processed by `teams-chat-created-crew.py` +```bash +# View all available triggers +crewai triggers list -The crew demonstrates how to extract participants, initial messages, tenant information, and compliance metadata from the Microsoft Graph webhook payload. +# Simulate a Microsoft Teams trigger with realistic payload +crewai triggers run microsoft_teams/teams_message_created +``` + +The `crewai triggers run` command will execute your crew with a complete Teams payload, allowing you to test your parsing logic before deployment. + + + Use `crewai triggers run microsoft_teams/teams_message_created` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload. + ## Troubleshooting - Ensure the Teams connection is active; it must be refreshed if the tenant revokes permissions +- Test locally with `crewai triggers run microsoft_teams/teams_message_created` to see the exact payload structure - Confirm the webhook subscription in Microsoft 365 is still valid if payloads stop arriving - Review execution logs for payload shape mismatches—Graph notifications may omit fields when a chat is private or restricted +- Remember: use `crewai triggers run` (not `crewai run`) to simulate trigger execution diff --git a/docs/en/enterprise/guides/onedrive-trigger.mdx b/docs/en/enterprise/guides/onedrive-trigger.mdx index 51de175db..09aabd2e2 100644 --- a/docs/en/enterprise/guides/onedrive-trigger.mdx +++ b/docs/en/enterprise/guides/onedrive-trigger.mdx @@ -36,18 +36,28 @@ crew.kickoff({ The crew inspects file metadata, user activity, and permission changes to produce a compliance-friendly summary. -## Sample payloads & crews +## Testing Locally -The [OneDrive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) showcase how to: +Test your OneDrive trigger integration locally using the CrewAI CLI: -- Parse file metadata, size, and folder paths -- Track who created and last modified the file -- Highlight permission and external sharing changes +```bash +# View all available triggers +crewai triggers list -`onedrive-file-crew.py` bundles the analysis and summarization tasks so you can add remediation steps as needed. +# Simulate a OneDrive trigger with realistic payload +crewai triggers run microsoft_onedrive/file_changed +``` + +The `crewai triggers run` command will execute your crew with a complete OneDrive payload, allowing you to test your parsing logic before deployment. + + + Use `crewai triggers run microsoft_onedrive/file_changed` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload. + ## Troubleshooting - Ensure the connected account has permission to read the file metadata included in the webhook +- Test locally with `crewai triggers run microsoft_onedrive/file_changed` to see the exact payload structure - If the trigger fires but the payload is missing `permissions`, confirm the site-level sharing settings allow Graph to return this field - For large tenants, filter notifications upstream so the crew only runs on relevant directories +- Remember: use `crewai triggers run` (not `crewai run`) to simulate trigger execution diff --git a/docs/en/enterprise/guides/outlook-trigger.mdx b/docs/en/enterprise/guides/outlook-trigger.mdx index 21bda5407..ac7be7d21 100644 --- a/docs/en/enterprise/guides/outlook-trigger.mdx +++ b/docs/en/enterprise/guides/outlook-trigger.mdx @@ -36,17 +36,28 @@ crew.kickoff({ The crew extracts sender details, subject, body preview, and attachments before generating a structured response. -## Sample payloads & crews +## Testing Locally -Review the [Outlook examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) for two common scenarios: +Test your Outlook trigger integration locally using the CrewAI CLI: -- `new-message.json` → new mail notifications parsed by `outlook-message-crew.py` -- `event-removed.json` → calendar cleanup handled by `outlook-event-removal-crew.py` +```bash +# View all available triggers +crewai triggers list -Each crew demonstrates how to handle Microsoft Graph payloads, normalize headers, and keep humans in-the-loop with concise summaries. +# Simulate an Outlook trigger with realistic payload +crewai triggers run microsoft_outlook/email_received +``` + +The `crewai triggers run` command will execute your crew with a complete Outlook payload, allowing you to test your parsing logic before deployment. + + + Use `crewai triggers run microsoft_outlook/email_received` (not `crewai run`) to simulate trigger execution during development. After deployment, your crew will automatically receive the trigger payload. + ## Troubleshooting - Verify the Outlook connector is still authorized; the subscription must be renewed periodically +- Test locally with `crewai triggers run microsoft_outlook/email_received` to see the exact payload structure - If attachments are missing, confirm the webhook subscription includes the `includeResourceData` flag - Review execution logs when events fail to match—cancellation payloads lack attendee lists by design and the crew should account for that +- Remember: use `crewai triggers run` (not `crewai run`) to simulate trigger execution diff --git a/docs/ko/enterprise/guides/automation-triggers.mdx b/docs/ko/enterprise/guides/automation-triggers.mdx index 84b31b6bf..963fb7591 100644 --- a/docs/ko/enterprise/guides/automation-triggers.mdx +++ b/docs/ko/enterprise/guides/automation-triggers.mdx @@ -110,19 +110,49 @@ CrewAI AMP 트리거는 팀이 이미 사용하고 있는 도구의 실시간 - `allow_crewai_trigger_context` 옵션으로 컨텍스트 자동 주입 여부를 결정했나요? - 웹훅 로그, CrewAI 실행 기록, 외부 알림 등 모니터링을 준비했나요? -### Payload & Crew 예제 저장소 +### CLI로 로컬에서 트리거 테스트 -| 통합 | 동작 시점 | Payload 예제 | Crew 예제 | -| :-- | :-- | :-- | :-- | -| Gmail | 신규 메일, 스레드 업데이트 | [Gmail payload](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 | 이벤트 생성/수정/시작/종료/취소 | [Calendar payload](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 | 파일 생성/수정/삭제 | [Drive payload](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 | 새 이메일, 이벤트 제거 | [Outlook payload](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 | 파일 작업(생성, 수정, 공유, 삭제) | [OneDrive payload](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 | 레코드 생성/업데이트(연락처, 회사, 딜) | [HubSpot payload](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 | 채팅 생성 | [Teams 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) | +CrewAI CLI는 프로덕션에 배포하기 전에 트리거 기반 자동화를 개발하고 테스트할 수 있는 강력한 명령을 제공합니다. -예제 payload를 참고해 파싱 로직을 검증하고, 제공되는 crew를 복사해 실제 데이터로 교체하세요. +#### 사용 가능한 트리거 목록 보기 + +연결된 통합에 사용 가능한 모든 트리거를 확인하세요: + +```bash +crewai triggers list +``` + +이 명령은 연결된 통합을 기반으로 사용 가능한 모든 트리거를 표시합니다: +- 통합 이름 및 연결 상태 +- 사용 가능한 트리거 유형 +- 트리거 이름 및 설명 + +#### 트리거 실행 시뮬레이션 + +배포 전에 실제 트리거 payload로 크루를 테스트하세요: + +```bash +crewai triggers run <트리거_이름> +``` + +예시: + +```bash +crewai triggers run microsoft_onedrive/file_changed +``` + +이 명령은: +- 로컬에서 크루를 실행합니다 +- 완전하고 실제적인 트리거 payload를 전달합니다 +- 프로덕션에서 크루가 호출되는 방식을 정확히 시뮬레이션합니다 + + + **중요한 개발 노트:** + - 개발 중 트리거 실행을 시뮬레이션하려면 `crewai triggers run `를 사용하세요 + - `crewai run`을 사용하면 트리거 호출을 시뮬레이션하지 않으며 트리거 payload를 전달하지 않습니다 + - 배포 후에는 실제 트리거 payload로 크루가 실행됩니다 + - 크루가 트리거 payload에 없는 매개변수를 기대하면 실행이 실패할 수 있습니다 + ### 트리거와 Crew 연동 @@ -191,17 +221,20 @@ def delegate_to_crew(self, crewai_trigger_payload: dict = None): ## 문제 해결 **트리거가 실행되지 않나요?** -- 트리거가 활성 상태인지 확인하세요. -- 통합 연결 상태를 확인하세요. +- 배포의 Triggers 탭에서 트리거가 활성화되어 있는지 확인하세요 +- Tools & Integrations에서 통합 연결 상태를 확인하세요 +- 필요한 모든 환경 변수가 올바르게 구성되어 있는지 확인하세요 **실행 중 오류가 발생하나요?** -- 실행 로그에서 오류 메시지를 확인하세요. -- 개발 중이라면 `crewai_trigger_payload`가 올바른 데이터로 전달되고 있는지 확인하세요. +- 실행 로그에서 오류 세부 정보를 확인하세요 +- `crewai triggers run <트리거_이름>`을 사용하여 로컬에서 테스트하고 정확한 payload 구조를 확인하세요 +- 크루가 `crewai_trigger_payload` 매개변수를 처리할 수 있는지 확인하세요 +- 크루가 트리거 payload에 포함되지 않은 매개변수를 기대하지 않는지 확인하세요 + +**개발 문제:** +- 배포하기 전에 항상 `crewai triggers run `로 테스트하여 전체 payload를 확인하세요 +- `crewai run`은 트리거 호출을 시뮬레이션하지 않으므로 `crewai triggers run`을 대신 사용하세요 +- `crewai triggers list`를 사용하여 연결된 통합에 사용 가능한 트리거를 확인하세요 +- 배포 후 크루는 실제 트리거 payload를 받으므로 먼저 로컬에서 철저히 테스트하세요 트리거를 활용하면 CrewAI 자동화를 이벤트 기반 시스템으로 전환하여 기존 비즈니스 프로세스와 도구에 자연스럽게 녹여낼 수 있습니다. - - - - CrewAI AMP Trigger Examples - - diff --git a/docs/ko/enterprise/guides/gmail-trigger.mdx b/docs/ko/enterprise/guides/gmail-trigger.mdx index 2caefc045..ddca4f63b 100644 --- a/docs/ko/enterprise/guides/gmail-trigger.mdx +++ b/docs/ko/enterprise/guides/gmail-trigger.mdx @@ -51,16 +51,25 @@ class GmailProcessingCrew: ) ``` -The Gmail payload will be available via the standard context mechanisms. See the payload samples repository for structure and fields. +The Gmail payload will be available via the standard context mechanisms. -### Sample payloads & crews +### 로컬에서 테스트 -The [CrewAI AMP Trigger Examples repository](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) includes: +CrewAI CLI를 사용하여 Gmail 트리거 통합을 로컬에서 테스트하세요: -- `new-email-payload-1.json` / `new-email-payload-2.json` — production-style new message alerts with matching crews in `new-email-crew.py` -- `thread-updated-sample-1.json` — follow-up messages on an existing thread, processed by `gmail-alert-crew.py` +```bash +# 사용 가능한 모든 트리거 보기 +crewai triggers list -Use these samples to validate your parsing logic locally before wiring the trigger to your live Gmail accounts. +# 실제 payload로 Gmail 트리거 시뮬레이션 +crewai triggers run gmail/new_email +``` + +`crewai triggers run` 명령은 완전한 Gmail payload로 크루를 실행하여 배포 전에 파싱 로직을 테스트할 수 있게 해줍니다. + + + 개발 중에는 `crewai triggers run gmail/new_email`을 사용하세요 (`crewai run`이 아님). 배포 후에는 크루가 자동으로 트리거 payload를 받습니다. + ## Monitoring Executions @@ -70,16 +79,10 @@ Track history and performance of triggered runs: List of executions triggered by automation -## Payload Reference - -See the sample payloads and field descriptions: - - - Gmail samples in Trigger Examples Repo - - ## Troubleshooting - Ensure Gmail is connected in Tools & Integrations - Verify the Gmail Trigger is enabled on the Triggers tab +- `crewai triggers run gmail/new_email`로 로컬 테스트하여 정확한 payload 구조를 확인하세요 - Check the execution logs and confirm the payload is passed as `crewai_trigger_payload` +- 주의: 트리거 실행을 시뮬레이션하려면 `crewai triggers run`을 사용하세요 (`crewai run`이 아님) diff --git a/docs/ko/enterprise/guides/google-calendar-trigger.mdx b/docs/ko/enterprise/guides/google-calendar-trigger.mdx index cf2d32471..6f279602e 100644 --- a/docs/ko/enterprise/guides/google-calendar-trigger.mdx +++ b/docs/ko/enterprise/guides/google-calendar-trigger.mdx @@ -39,16 +39,23 @@ print(result.raw) Use `crewai_trigger_payload` exactly as it is delivered by the trigger so the crew can extract the proper fields. -## Sample payloads & crews +## 로컬에서 테스트 -The [Google Calendar examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) show how to handle multiple event types: +CrewAI CLI를 사용하여 Google Calendar 트리거 통합을 로컬에서 테스트하세요: -- `new-event.json` → standard event creation handled by `calendar-event-crew.py` -- `event-updated.json` / `event-started.json` / `event-ended.json` → in-flight updates processed by `calendar-meeting-crew.py` -- `event-canceled.json` → cancellation workflow that alerts attendees via `calendar-meeting-crew.py` -- Working location events use `calendar-working-location-crew.py` to extract on-site schedules +```bash +# 사용 가능한 모든 트리거 보기 +crewai triggers list -Each crew transforms raw event metadata (attendees, rooms, working locations) into the summaries your teams need. +# 실제 payload로 Google Calendar 트리거 시뮬레이션 +crewai triggers run google_calendar/event_changed +``` + +`crewai triggers run` 명령은 완전한 Calendar payload로 크루를 실행하여 배포 전에 파싱 로직을 테스트할 수 있게 해줍니다. + + + 개발 중에는 `crewai triggers run google_calendar/event_changed`를 사용하세요 (`crewai run`이 아님). 배포 후에는 크루가 자동으로 트리거 payload를 받습니다. + ## Monitoring Executions @@ -61,5 +68,7 @@ The **Executions** list in the deployment dashboard tracks every triggered run a ## Troubleshooting - Ensure the correct Google account is connected and the trigger is enabled +- `crewai triggers run google_calendar/event_changed`로 로컬 테스트하여 정확한 payload 구조를 확인하세요 - Confirm your workflow handles all-day events (payloads use `start.date` and `end.date` instead of timestamps) - Check execution logs if reminders or attendee arrays are missing—calendar permissions can limit fields in the payload +- 주의: 트리거 실행을 시뮬레이션하려면 `crewai triggers run`을 사용하세요 (`crewai run`이 아님) diff --git a/docs/ko/enterprise/guides/google-drive-trigger.mdx b/docs/ko/enterprise/guides/google-drive-trigger.mdx index 19c10837b..3fd27bcd6 100644 --- a/docs/ko/enterprise/guides/google-drive-trigger.mdx +++ b/docs/ko/enterprise/guides/google-drive-trigger.mdx @@ -36,15 +36,23 @@ crew.kickoff({ }) ``` -## Sample payloads & crews +## 로컬에서 테스트 -Explore the [Google Drive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) to cover different operations: +CrewAI CLI를 사용하여 Google Drive 트리거 통합을 로컬에서 테스트하세요: -- `new-file.json` → new uploads processed by `drive-file-crew.py` -- `updated-file.json` → file edits and metadata changes handled by `drive-file-crew.py` -- `deleted-file.json` → deletion events routed through `drive-file-deletion-crew.py` +```bash +# 사용 가능한 모든 트리거 보기 +crewai triggers list -Each crew highlights the file name, operation type, owner, permissions, and security considerations so downstream systems can respond appropriately. +# 실제 payload로 Google Drive 트리거 시뮬레이션 +crewai triggers run google_drive/file_changed +``` + +`crewai triggers run` 명령은 완전한 Drive payload로 크루를 실행하여 배포 전에 파싱 로직을 테스트할 수 있게 해줍니다. + + + 개발 중에는 `crewai triggers run google_drive/file_changed`를 사용하세요 (`crewai run`이 아님). 배포 후에는 크루가 자동으로 트리거 payload를 받습니다. + ## Monitoring Executions @@ -57,5 +65,7 @@ Track history and performance of triggered runs with the **Executions** list in ## Troubleshooting - Verify Google Drive is connected and the trigger toggle is enabled +- `crewai triggers run google_drive/file_changed`로 로컬 테스트하여 정확한 payload 구조를 확인하세요 - If a payload is missing permission data, ensure the connected account has access to the file or folder - The trigger sends file IDs only; use the Drive API if you need to fetch binary content during the crew run +- 주의: 트리거 실행을 시뮬레이션하려면 `crewai triggers run`을 사용하세요 (`crewai run`이 아님) diff --git a/docs/ko/enterprise/guides/hubspot-trigger.mdx b/docs/ko/enterprise/guides/hubspot-trigger.mdx index 462778478..1818e48b1 100644 --- a/docs/ko/enterprise/guides/hubspot-trigger.mdx +++ b/docs/ko/enterprise/guides/hubspot-trigger.mdx @@ -49,6 +49,4 @@ mode: "wide" -## 추가 자료 - 사용 가능한 작업과 사용자 지정 옵션에 대한 자세한 정보는 [HubSpot 워크플로우 문서](https://knowledge.hubspot.com/workflows/create-workflows)를 참고하세요. diff --git a/docs/ko/enterprise/guides/microsoft-teams-trigger.mdx b/docs/ko/enterprise/guides/microsoft-teams-trigger.mdx index 10878af40..621561690 100644 --- a/docs/ko/enterprise/guides/microsoft-teams-trigger.mdx +++ b/docs/ko/enterprise/guides/microsoft-teams-trigger.mdx @@ -37,16 +37,28 @@ print(result.raw) The crew parses thread metadata (subject, created time, roster) and generates an action plan for the receiving team. -## Sample payloads & crews +## 로컬에서 테스트 -The [Microsoft Teams examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) include: +CrewAI CLI를 사용하여 Microsoft Teams 트리거 통합을 로컬에서 테스트하세요: -- `chat-created.json` → chat creation payload processed by `teams-chat-created-crew.py` +```bash +# 사용 가능한 모든 트리거 보기 +crewai triggers list -The crew demonstrates how to extract participants, initial messages, tenant information, and compliance metadata from the Microsoft Graph webhook payload. +# 실제 payload로 Microsoft Teams 트리거 시뮬레이션 +crewai triggers run microsoft_teams/teams_message_created +``` + +`crewai triggers run` 명령은 완전한 Teams payload로 크루를 실행하여 배포 전에 파싱 로직을 테스트할 수 있게 해줍니다. + + + 개발 중에는 `crewai triggers run microsoft_teams/teams_message_created`를 사용하세요 (`crewai run`이 아님). 배포 후에는 크루가 자동으로 트리거 payload를 받습니다. + ## Troubleshooting - Ensure the Teams connection is active; it must be refreshed if the tenant revokes permissions +- `crewai triggers run microsoft_teams/teams_message_created`로 로컬 테스트하여 정확한 payload 구조를 확인하세요 - Confirm the webhook subscription in Microsoft 365 is still valid if payloads stop arriving - Review execution logs for payload shape mismatches—Graph notifications may omit fields when a chat is private or restricted +- 주의: 트리거 실행을 시뮬레이션하려면 `crewai triggers run`을 사용하세요 (`crewai run`이 아님) diff --git a/docs/ko/enterprise/guides/onedrive-trigger.mdx b/docs/ko/enterprise/guides/onedrive-trigger.mdx index 51de175db..ce0a0e7cd 100644 --- a/docs/ko/enterprise/guides/onedrive-trigger.mdx +++ b/docs/ko/enterprise/guides/onedrive-trigger.mdx @@ -36,18 +36,28 @@ crew.kickoff({ The crew inspects file metadata, user activity, and permission changes to produce a compliance-friendly summary. -## Sample payloads & crews +## 로컬에서 테스트 -The [OneDrive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) showcase how to: +CrewAI CLI를 사용하여 OneDrive 트리거 통합을 로컬에서 테스트하세요: -- Parse file metadata, size, and folder paths -- Track who created and last modified the file -- Highlight permission and external sharing changes +```bash +# 사용 가능한 모든 트리거 보기 +crewai triggers list -`onedrive-file-crew.py` bundles the analysis and summarization tasks so you can add remediation steps as needed. +# 실제 payload로 OneDrive 트리거 시뮬레이션 +crewai triggers run microsoft_onedrive/file_changed +``` + +`crewai triggers run` 명령은 완전한 OneDrive payload로 크루를 실행하여 배포 전에 파싱 로직을 테스트할 수 있게 해줍니다. + + + 개발 중에는 `crewai triggers run microsoft_onedrive/file_changed`를 사용하세요 (`crewai run`이 아님). 배포 후에는 크루가 자동으로 트리거 payload를 받습니다. + ## Troubleshooting - Ensure the connected account has permission to read the file metadata included in the webhook +- `crewai triggers run microsoft_onedrive/file_changed`로 로컬 테스트하여 정확한 payload 구조를 확인하세요 - If the trigger fires but the payload is missing `permissions`, confirm the site-level sharing settings allow Graph to return this field - For large tenants, filter notifications upstream so the crew only runs on relevant directories +- 주의: 트리거 실행을 시뮬레이션하려면 `crewai triggers run`을 사용하세요 (`crewai run`이 아님) diff --git a/docs/ko/enterprise/guides/outlook-trigger.mdx b/docs/ko/enterprise/guides/outlook-trigger.mdx index 21bda5407..908d312e0 100644 --- a/docs/ko/enterprise/guides/outlook-trigger.mdx +++ b/docs/ko/enterprise/guides/outlook-trigger.mdx @@ -36,17 +36,28 @@ crew.kickoff({ The crew extracts sender details, subject, body preview, and attachments before generating a structured response. -## Sample payloads & crews +## 로컬에서 테스트 -Review the [Outlook examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) for two common scenarios: +CrewAI CLI를 사용하여 Outlook 트리거 통합을 로컬에서 테스트하세요: -- `new-message.json` → new mail notifications parsed by `outlook-message-crew.py` -- `event-removed.json` → calendar cleanup handled by `outlook-event-removal-crew.py` +```bash +# 사용 가능한 모든 트리거 보기 +crewai triggers list -Each crew demonstrates how to handle Microsoft Graph payloads, normalize headers, and keep humans in-the-loop with concise summaries. +# 실제 payload로 Outlook 트리거 시뮬레이션 +crewai triggers run microsoft_outlook/email_received +``` + +`crewai triggers run` 명령은 완전한 Outlook payload로 크루를 실행하여 배포 전에 파싱 로직을 테스트할 수 있게 해줍니다. + + + 개발 중에는 `crewai triggers run microsoft_outlook/email_received`를 사용하세요 (`crewai run`이 아님). 배포 후에는 크루가 자동으로 트리거 payload를 받습니다. + ## Troubleshooting - Verify the Outlook connector is still authorized; the subscription must be renewed periodically +- `crewai triggers run microsoft_outlook/email_received`로 로컬 테스트하여 정확한 payload 구조를 확인하세요 - If attachments are missing, confirm the webhook subscription includes the `includeResourceData` flag - Review execution logs when events fail to match—cancellation payloads lack attendee lists by design and the crew should account for that +- 주의: 트리거 실행을 시뮬레이션하려면 `crewai triggers run`을 사용하세요 (`crewai run`이 아님) diff --git a/docs/pt-BR/enterprise/guides/automation-triggers.mdx b/docs/pt-BR/enterprise/guides/automation-triggers.mdx index 07f5a757a..abfe9224c 100644 --- a/docs/pt-BR/enterprise/guides/automation-triggers.mdx +++ b/docs/pt-BR/enterprise/guides/automation-triggers.mdx @@ -116,19 +116,49 @@ Antes de ativar em produção, confirme que você: - Decidiu se usará `allow_crewai_trigger_context` para injetar contexto automaticamente - Configurou monitoramento (webhooks, históricos da CrewAI, alertas externos) -### Repositório de Payloads e Crews de Exemplo +### Testando Triggers Localmente com CLI -| Integração | Quando dispara | Amostras de payload | Crews de exemplo | -| :-- | :-- | :-- | :-- | -| Gmail | Novas mensagens, atualização de threads | [Payloads de alertas e threads](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 | Evento criado/atualizado/iniciado/encerrado/cancelado | [Payloads de eventos](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 | Arquivo criado/atualizado/excluído | [Payloads de arquivos](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 | Novo e‑mail, evento removido | [Payloads do Outlook](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 | Operações de arquivo (criar, atualizar, compartilhar, excluir) | [Payloads do OneDrive](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 | Registros criados/atualizados (contatos, empresas, negócios) | [Payloads do HubSpot](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 criado | [Payload do Teams](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) | +A CLI da CrewAI fornece comandos poderosos para ajudá-lo a desenvolver e testar automações orientadas por triggers sem fazer deploy para produção. -Use essas amostras para ajustar o parsing, copiar a crew correspondente e substituir o payload de teste pelo dado real. +#### Listar Triggers Disponíveis + +Visualize todos os triggers disponíveis para suas integrações conectadas: + +```bash +crewai triggers list +``` + +Este comando exibe todos os triggers disponíveis baseados nas suas integrações conectadas, mostrando: +- Nome da integração e status de conexão +- Tipos de triggers disponíveis +- Nomes e descrições dos triggers + +#### Simular Execução de Trigger + +Teste sua crew com payloads realistas de triggers antes do deployment: + +```bash +crewai triggers run +``` + +Por exemplo: + +```bash +crewai triggers run microsoft_onedrive/file_changed +``` + +Este comando: +- Executa sua crew localmente +- Passa um payload de trigger completo e realista +- Simula exatamente como sua crew será chamada em produção + + + **Notas Importantes de Desenvolvimento:** + - Use `crewai triggers run ` para simular execução de trigger durante o desenvolvimento + - Usar `crewai run` NÃO simulará chamadas de trigger e não passará o payload do trigger + - Após o deployment, sua crew será executada com o payload real do trigger + - Se sua crew espera parâmetros que não estão no payload do trigger, a execução pode falhar + ### Triggers com Crews @@ -203,17 +233,20 @@ def delegar_para_crew(self, crewai_trigger_payload: dict = None): ## Solução de Problemas **Trigger não dispara:** -- Verifique se está habilitado -- Confira o status da conexão +- Verifique se o trigger está habilitado na aba Triggers do seu deployment +- Confira o status da conexão em Tools & Integrations +- Garanta que todas as variáveis de ambiente necessárias estão configuradas **Falhas de execução:** -- Consulte os logs para entender o erro -- Durante o desenvolvimento, garanta que `crewai_trigger_payload` está presente com o payload correto +- Consulte os logs de execução para detalhes do erro +- Use `crewai triggers run ` para testar localmente e ver a estrutura exata do payload +- Verifique se sua crew pode processar o parâmetro `crewai_trigger_payload` +- Garanta que sua crew não espera parâmetros que não estão incluídos no payload do trigger + +**Problemas de desenvolvimento:** +- Sempre teste com `crewai triggers run ` antes de fazer deploy para ver o payload completo +- Lembre-se que `crewai run` NÃO simula chamadas de trigger—use `crewai triggers run` em vez disso +- Use `crewai triggers list` para verificar quais triggers estão disponíveis para suas integrações conectadas +- Após o deployment, sua crew receberá o payload real do trigger, então teste minuciosamente localmente primeiro Os triggers transformam suas implantações CrewAI em sistemas orientados por eventos, integrando-se perfeitamente aos processos e ferramentas já usados pelo seu time. - - - - Repositório CrewAI AMP Trigger Examples - - diff --git a/docs/pt-BR/enterprise/guides/gmail-trigger.mdx b/docs/pt-BR/enterprise/guides/gmail-trigger.mdx index 2caefc045..0f0663fb6 100644 --- a/docs/pt-BR/enterprise/guides/gmail-trigger.mdx +++ b/docs/pt-BR/enterprise/guides/gmail-trigger.mdx @@ -51,16 +51,25 @@ class GmailProcessingCrew: ) ``` -The Gmail payload will be available via the standard context mechanisms. See the payload samples repository for structure and fields. +The Gmail payload will be available via the standard context mechanisms. -### Sample payloads & crews +### Testando Localmente -The [CrewAI AMP Trigger Examples repository](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/gmail) includes: +Teste sua integração de trigger do Gmail localmente usando a CLI da CrewAI: -- `new-email-payload-1.json` / `new-email-payload-2.json` — production-style new message alerts with matching crews in `new-email-crew.py` -- `thread-updated-sample-1.json` — follow-up messages on an existing thread, processed by `gmail-alert-crew.py` +```bash +# Visualize todos os triggers disponíveis +crewai triggers list -Use these samples to validate your parsing logic locally before wiring the trigger to your live Gmail accounts. +# Simule um trigger do Gmail com payload realista +crewai triggers run gmail/new_email +``` + +O comando `crewai triggers run` executará sua crew com um payload completo do Gmail, permitindo que você teste sua lógica de parsing antes do deployment. + + + Use `crewai triggers run gmail/new_email` (não `crewai run`) para simular execução de trigger durante o desenvolvimento. Após o deployment, sua crew receberá automaticamente o payload do trigger. + ## Monitoring Executions @@ -70,16 +79,10 @@ Track history and performance of triggered runs: List of executions triggered by automation -## Payload Reference - -See the sample payloads and field descriptions: - - - Gmail samples in Trigger Examples Repo - - ## Troubleshooting - Ensure Gmail is connected in Tools & Integrations - Verify the Gmail Trigger is enabled on the Triggers tab +- Teste localmente com `crewai triggers run gmail/new_email` para ver a estrutura exata do payload - Check the execution logs and confirm the payload is passed as `crewai_trigger_payload` +- Lembre-se: use `crewai triggers run` (não `crewai run`) para simular execução de trigger diff --git a/docs/pt-BR/enterprise/guides/google-calendar-trigger.mdx b/docs/pt-BR/enterprise/guides/google-calendar-trigger.mdx index cf2d32471..0d9a7dbc8 100644 --- a/docs/pt-BR/enterprise/guides/google-calendar-trigger.mdx +++ b/docs/pt-BR/enterprise/guides/google-calendar-trigger.mdx @@ -39,16 +39,23 @@ print(result.raw) Use `crewai_trigger_payload` exactly as it is delivered by the trigger so the crew can extract the proper fields. -## Sample payloads & crews +## Testando Localmente -The [Google Calendar examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_calendar) show how to handle multiple event types: +Teste sua integração de trigger do Google Calendar localmente usando a CLI da CrewAI: -- `new-event.json` → standard event creation handled by `calendar-event-crew.py` -- `event-updated.json` / `event-started.json` / `event-ended.json` → in-flight updates processed by `calendar-meeting-crew.py` -- `event-canceled.json` → cancellation workflow that alerts attendees via `calendar-meeting-crew.py` -- Working location events use `calendar-working-location-crew.py` to extract on-site schedules +```bash +# Visualize todos os triggers disponíveis +crewai triggers list -Each crew transforms raw event metadata (attendees, rooms, working locations) into the summaries your teams need. +# Simule um trigger do Google Calendar com payload realista +crewai triggers run google_calendar/event_changed +``` + +O comando `crewai triggers run` executará sua crew com um payload completo do Calendar, permitindo que você teste sua lógica de parsing antes do deployment. + + + Use `crewai triggers run google_calendar/event_changed` (não `crewai run`) para simular execução de trigger durante o desenvolvimento. Após o deployment, sua crew receberá automaticamente o payload do trigger. + ## Monitoring Executions @@ -61,5 +68,7 @@ The **Executions** list in the deployment dashboard tracks every triggered run a ## Troubleshooting - Ensure the correct Google account is connected and the trigger is enabled +- Teste localmente com `crewai triggers run google_calendar/event_changed` para ver a estrutura exata do payload - Confirm your workflow handles all-day events (payloads use `start.date` and `end.date` instead of timestamps) - Check execution logs if reminders or attendee arrays are missing—calendar permissions can limit fields in the payload +- Lembre-se: use `crewai triggers run` (não `crewai run`) para simular execução de trigger diff --git a/docs/pt-BR/enterprise/guides/google-drive-trigger.mdx b/docs/pt-BR/enterprise/guides/google-drive-trigger.mdx index 19c10837b..d4f2f2ed8 100644 --- a/docs/pt-BR/enterprise/guides/google-drive-trigger.mdx +++ b/docs/pt-BR/enterprise/guides/google-drive-trigger.mdx @@ -36,15 +36,23 @@ crew.kickoff({ }) ``` -## Sample payloads & crews +## Testando Localmente -Explore the [Google Drive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/google_drive) to cover different operations: +Teste sua integração de trigger do Google Drive localmente usando a CLI da CrewAI: -- `new-file.json` → new uploads processed by `drive-file-crew.py` -- `updated-file.json` → file edits and metadata changes handled by `drive-file-crew.py` -- `deleted-file.json` → deletion events routed through `drive-file-deletion-crew.py` +```bash +# Visualize todos os triggers disponíveis +crewai triggers list -Each crew highlights the file name, operation type, owner, permissions, and security considerations so downstream systems can respond appropriately. +# Simule um trigger do Google Drive com payload realista +crewai triggers run google_drive/file_changed +``` + +O comando `crewai triggers run` executará sua crew com um payload completo do Drive, permitindo que você teste sua lógica de parsing antes do deployment. + + + Use `crewai triggers run google_drive/file_changed` (não `crewai run`) para simular execução de trigger durante o desenvolvimento. Após o deployment, sua crew receberá automaticamente o payload do trigger. + ## Monitoring Executions @@ -57,5 +65,7 @@ Track history and performance of triggered runs with the **Executions** list in ## Troubleshooting - Verify Google Drive is connected and the trigger toggle is enabled +- Teste localmente com `crewai triggers run google_drive/file_changed` para ver a estrutura exata do payload - If a payload is missing permission data, ensure the connected account has access to the file or folder - The trigger sends file IDs only; use the Drive API if you need to fetch binary content during the crew run +- Lembre-se: use `crewai triggers run` (não `crewai run`) para simular execução de trigger diff --git a/docs/pt-BR/enterprise/guides/microsoft-teams-trigger.mdx b/docs/pt-BR/enterprise/guides/microsoft-teams-trigger.mdx index 10878af40..1dd5a1bb1 100644 --- a/docs/pt-BR/enterprise/guides/microsoft-teams-trigger.mdx +++ b/docs/pt-BR/enterprise/guides/microsoft-teams-trigger.mdx @@ -37,16 +37,28 @@ print(result.raw) The crew parses thread metadata (subject, created time, roster) and generates an action plan for the receiving team. -## Sample payloads & crews +## Testando Localmente -The [Microsoft Teams examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/microsoft-teams) include: +Teste sua integração de trigger do Microsoft Teams localmente usando a CLI da CrewAI: -- `chat-created.json` → chat creation payload processed by `teams-chat-created-crew.py` +```bash +# Visualize todos os triggers disponíveis +crewai triggers list -The crew demonstrates how to extract participants, initial messages, tenant information, and compliance metadata from the Microsoft Graph webhook payload. +# Simule um trigger do Microsoft Teams com payload realista +crewai triggers run microsoft_teams/teams_message_created +``` + +O comando `crewai triggers run` executará sua crew com um payload completo do Teams, permitindo que você teste sua lógica de parsing antes do deployment. + + + Use `crewai triggers run microsoft_teams/teams_message_created` (não `crewai run`) para simular execução de trigger durante o desenvolvimento. Após o deployment, sua crew receberá automaticamente o payload do trigger. + ## Troubleshooting - Ensure the Teams connection is active; it must be refreshed if the tenant revokes permissions +- Teste localmente com `crewai triggers run microsoft_teams/teams_message_created` para ver a estrutura exata do payload - Confirm the webhook subscription in Microsoft 365 is still valid if payloads stop arriving - Review execution logs for payload shape mismatches—Graph notifications may omit fields when a chat is private or restricted +- Lembre-se: use `crewai triggers run` (não `crewai run`) para simular execução de trigger diff --git a/docs/pt-BR/enterprise/guides/onedrive-trigger.mdx b/docs/pt-BR/enterprise/guides/onedrive-trigger.mdx index 51de175db..f3659c5b4 100644 --- a/docs/pt-BR/enterprise/guides/onedrive-trigger.mdx +++ b/docs/pt-BR/enterprise/guides/onedrive-trigger.mdx @@ -36,18 +36,28 @@ crew.kickoff({ The crew inspects file metadata, user activity, and permission changes to produce a compliance-friendly summary. -## Sample payloads & crews +## Testando Localmente -The [OneDrive examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/onedrive) showcase how to: +Teste sua integração de trigger do OneDrive localmente usando a CLI da CrewAI: -- Parse file metadata, size, and folder paths -- Track who created and last modified the file -- Highlight permission and external sharing changes +```bash +# Visualize todos os triggers disponíveis +crewai triggers list -`onedrive-file-crew.py` bundles the analysis and summarization tasks so you can add remediation steps as needed. +# Simule um trigger do OneDrive com payload realista +crewai triggers run microsoft_onedrive/file_changed +``` + +O comando `crewai triggers run` executará sua crew com um payload completo do OneDrive, permitindo que você teste sua lógica de parsing antes do deployment. + + + Use `crewai triggers run microsoft_onedrive/file_changed` (não `crewai run`) para simular execução de trigger durante o desenvolvimento. Após o deployment, sua crew receberá automaticamente o payload do trigger. + ## Troubleshooting - Ensure the connected account has permission to read the file metadata included in the webhook +- Teste localmente com `crewai triggers run microsoft_onedrive/file_changed` para ver a estrutura exata do payload - If the trigger fires but the payload is missing `permissions`, confirm the site-level sharing settings allow Graph to return this field - For large tenants, filter notifications upstream so the crew only runs on relevant directories +- Lembre-se: use `crewai triggers run` (não `crewai run`) para simular execução de trigger diff --git a/docs/pt-BR/enterprise/guides/outlook-trigger.mdx b/docs/pt-BR/enterprise/guides/outlook-trigger.mdx index 21bda5407..c63d3c704 100644 --- a/docs/pt-BR/enterprise/guides/outlook-trigger.mdx +++ b/docs/pt-BR/enterprise/guides/outlook-trigger.mdx @@ -36,17 +36,28 @@ crew.kickoff({ The crew extracts sender details, subject, body preview, and attachments before generating a structured response. -## Sample payloads & crews +## Testando Localmente -Review the [Outlook examples](https://github.com/crewAIInc/crewai-enterprise-trigger-examples/tree/main/outlook) for two common scenarios: +Teste sua integração de trigger do Outlook localmente usando a CLI da CrewAI: -- `new-message.json` → new mail notifications parsed by `outlook-message-crew.py` -- `event-removed.json` → calendar cleanup handled by `outlook-event-removal-crew.py` +```bash +# Visualize todos os triggers disponíveis +crewai triggers list -Each crew demonstrates how to handle Microsoft Graph payloads, normalize headers, and keep humans in-the-loop with concise summaries. +# Simule um trigger do Outlook com payload realista +crewai triggers run microsoft_outlook/email_received +``` + +O comando `crewai triggers run` executará sua crew com um payload completo do Outlook, permitindo que você teste sua lógica de parsing antes do deployment. + + + Use `crewai triggers run microsoft_outlook/email_received` (não `crewai run`) para simular execução de trigger durante o desenvolvimento. Após o deployment, sua crew receberá automaticamente o payload do trigger. + ## Troubleshooting - Verify the Outlook connector is still authorized; the subscription must be renewed periodically +- Teste localmente com `crewai triggers run microsoft_outlook/email_received` para ver a estrutura exata do payload - If attachments are missing, confirm the webhook subscription includes the `includeResourceData` flag - Review execution logs when events fail to match—cancellation payloads lack attendee lists by design and the crew should account for that +- Lembre-se: use `crewai triggers run` (não `crewai run`) para simular execução de trigger