Skip to content

chore(docs): add comprehensive triggers documentation#1446

Draft
a7m-1st wants to merge 2 commits intomainfrom
docs/triggers-documentation
Draft

chore(docs): add comprehensive triggers documentation#1446
a7m-1st wants to merge 2 commits intomainfrom
docs/triggers-documentation

Conversation

@a7m-1st
Copy link
Copy Markdown
Collaborator

@a7m-1st a7m-1st commented Mar 5, 2026

Related Issue

Closes #1444

Description

  1. Triggers Overview (docs/triggers/main.md)

    • Explains how triggers work in Eigent
    • Describes the task queue and execution monitoring
    • Overview of all trigger types with use case guidance
  2. Schedule Trigger (docs/triggers/schedule.md)

    • Step-by-step setup guide for scheduled workflows
    • Coverage of all schedule types: One Time, Daily, Weekly, Monthly
    • Configuration options including failure thresholds and preview scheduling
  3. Slack Trigger (docs/triggers/slack.md)

    • Complete Slack app setup from creation to event subscriptions
    • OAuth scope configuration and permissions
    • Event subscription setup with webhook verification
    • Bot invitation and testing procedures
  4. Webhook Trigger (docs/triggers/webhook.md)

    • HTTP request configuration (GET/POST)
    • Security best practices including rate limiting and validation
    • Request filtering with regex and body content matching
    • Integration examples for external services

Testing Evidence (REQUIRED)

  • I have included human-verified testing evidence in this PR.
  • This PR includes frontend/UI changes, and I attached screenshot(s) or screen recording(s).
  • No frontend/UI changes in this PR.

What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Contribution Guidelines Acknowledgement

- Create triggers overview page explaining how triggers work
- Add schedule trigger documentation with step-by-step setup guide
- Add Slack trigger documentation with full app configuration steps
- Add webhook trigger documentation with security best practices
- Include all supporting screenshots organized by trigger type
- Update docs.json navigation to include new Triggers section

The documentation covers:
- Task queue and execution monitoring
- One-time, daily, weekly, and monthly scheduling
- Complete Slack app setup from creation to event subscriptions
- Webhook configuration with request validation and rate limiting
@a7m-1st a7m-1st self-assigned this Mar 5, 2026
@a7m-1st
Copy link
Copy Markdown
Collaborator Author

a7m-1st commented Mar 5, 2026

Currently need to test with mintlify dev. Pushing some updates later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request] Triggers doc

1 participant