mirror of
https://github.com/simstudioai/sim.git
synced 2026-04-06 03:00:16 -04:00
020037728d
* progress on cred sets * fix credential set system * return data to render credential set in block preview * progress * invite flow * simplify code * fix ui * fix tests * fix types * fix * fix icon for outlook * fix cred set name not showing up for owner * fix rendering of credential set name * fix outlook well known folder id resolution * fix perms for creating cred set * add to docs and simplify ui * consolidate webhook code better * fix tests * fix credential collab logic issue * fix ui * fix lint
94 lines
3.7 KiB
Plaintext
94 lines
3.7 KiB
Plaintext
---
|
|
title: Overview
|
|
description: Triggers are the core ways to start Sim workflows
|
|
---
|
|
|
|
import { Card, Cards } from 'fumadocs-ui/components/card'
|
|
import { Image } from '@/components/ui/image'
|
|
|
|
<div className="flex justify-center">
|
|
<Image
|
|
src="/static/blocks/triggers.png"
|
|
alt="Triggers Overview"
|
|
width={500}
|
|
height={350}
|
|
className="my-6"
|
|
/>
|
|
</div>
|
|
|
|
## Core Triggers
|
|
|
|
Use the Start block for everything originating from the editor, deploy-to-API, or deploy-to-chat experiences. Other triggers remain available for event-driven workflows:
|
|
|
|
<Cards>
|
|
<Card title="Start" href="/triggers/start">
|
|
Unified entry point that supports editor runs, API deployments and chat deployments
|
|
</Card>
|
|
<Card title="Webhook" href="/triggers/webhook">
|
|
Receive external webhook payloads
|
|
</Card>
|
|
<Card title="Schedule" href="/triggers/schedule">
|
|
Cron or interval based execution
|
|
</Card>
|
|
<Card title="RSS Feed" href="/triggers/rss">
|
|
Monitor RSS and Atom feeds for new content
|
|
</Card>
|
|
<Card title="Email Polling Groups" href="#email-polling-groups">
|
|
Monitor team Gmail and Outlook inboxes
|
|
</Card>
|
|
</Cards>
|
|
|
|
## Quick Comparison
|
|
|
|
| Trigger | Start condition |
|
|
|---------|-----------------|
|
|
| **Start** | Editor runs, deploy-to-API requests, or chat messages |
|
|
| **Schedule** | Timer managed in schedule block |
|
|
| **Webhook** | On inbound HTTP request |
|
|
| **RSS Feed** | New item published to feed |
|
|
| **Email Polling Groups** | New email received in team Gmail or Outlook inboxes |
|
|
|
|
> The Start block always exposes `input`, `conversationId`, and `files` fields. Add custom fields to the input format for additional structured data.
|
|
|
|
## Using Triggers
|
|
|
|
1. Drop the Start block in the start slot (or an alternate trigger like Webhook/Schedule).
|
|
2. Configure any required schema or auth.
|
|
3. Connect the block to the rest of the workflow.
|
|
|
|
> Deployments power every trigger. Update the workflow, redeploy, and all trigger entry points pick up the new snapshot. Learn more in [Execution → Deployment Snapshots](/execution).
|
|
|
|
## Manual Execution Priority
|
|
|
|
When you click **Run** in the editor, Sim automatically selects which trigger to execute based on the following priority order:
|
|
|
|
1. **Start Block** (highest priority)
|
|
2. **Schedule Triggers**
|
|
3. **External Triggers** (webhooks, integrations like Slack, Gmail, Airtable, etc.)
|
|
|
|
If your workflow has multiple triggers, the highest priority trigger will be executed. For example, if you have both a Start block and a Webhook trigger, clicking Run will execute the Start block.
|
|
|
|
**External triggers with mock payloads**: When external triggers (webhooks and integrations) are executed manually, Sim automatically generates mock payloads based on the trigger's expected data structure. This ensures downstream blocks can resolve variables correctly during testing.
|
|
|
|
## Email Polling Groups
|
|
|
|
Polling Groups let you monitor multiple team members' Gmail or Outlook inboxes with a single trigger. Requires a Team or Enterprise plan.
|
|
|
|
**Creating a Polling Group** (Admin/Owner)
|
|
|
|
1. Go to **Settings → Email Polling**
|
|
2. Click **Create** and choose Gmail or Outlook
|
|
3. Enter a name for the group
|
|
|
|
**Inviting Members**
|
|
|
|
1. Click **Add Members** on your polling group
|
|
2. Enter email addresses (comma or newline separated, or drag & drop a CSV)
|
|
3. Click **Send Invites**
|
|
|
|
Invitees receive an email with a link to connect their account. Once connected, their inbox is automatically included in the polling group. Invitees don't need to be members of your Sim organization.
|
|
|
|
**Using in a Workflow**
|
|
|
|
When configuring an email trigger, select your polling group from the credentials dropdown instead of an individual account. The system creates webhooks for each member and routes all emails through your workflow.
|