improvement(docs): updated docs with new videos, new tools (#770)
* improvement(docs): updated docs with new videos, new tools (#744) * updated docs with new videos, new tools * update typeform icon * add qdrant docs
@@ -10,7 +10,6 @@
|
||||
"parallel",
|
||||
"response",
|
||||
"router",
|
||||
"webhook_trigger",
|
||||
"workflow"
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,113 +0,0 @@
|
||||
---
|
||||
title: Webhook Trigger
|
||||
description: Trigger workflow execution from external webhooks
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Step, Steps } from 'fumadocs-ui/components/steps'
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card'
|
||||
import { ThemeImage } from '@/components/ui/theme-image'
|
||||
|
||||
The Webhook Trigger block allows external services to trigger your workflow execution through HTTP webhooks. Unlike starter blocks, webhook triggers are pure input sources that start workflows without requiring manual intervention.
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/webhooktrigger-light.png"
|
||||
darkSrc="/static/dark/webhooktrigger-dark.png"
|
||||
alt="Webhook Trigger Block"
|
||||
width={350}
|
||||
height={175}
|
||||
/>
|
||||
|
||||
<Callout>
|
||||
Webhook triggers cannot receive incoming connections and do not expose webhook data to the workflow. They serve as pure execution triggers.
|
||||
</Callout>
|
||||
|
||||
## Overview
|
||||
|
||||
The Webhook Trigger block enables you to:
|
||||
|
||||
<Steps>
|
||||
<Step>
|
||||
<strong>Receive external triggers</strong>: Accept HTTP requests from external services
|
||||
</Step>
|
||||
<Step>
|
||||
<strong>Support multiple providers</strong>: Handle webhooks from Slack, Gmail, GitHub, and more
|
||||
</Step>
|
||||
<Step>
|
||||
<strong>Start workflows automatically</strong>: Execute workflows without manual intervention
|
||||
</Step>
|
||||
<Step>
|
||||
<strong>Provide secure endpoints</strong>: Generate unique webhook URLs for each trigger
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## How It Works
|
||||
|
||||
The Webhook Trigger block operates as a pure input source:
|
||||
|
||||
1. **Generate Endpoint** - Creates a unique webhook URL when configured
|
||||
2. **Receive Request** - Accepts HTTP POST requests from external services
|
||||
3. **Trigger Execution** - Starts the workflow when a valid request is received
|
||||
|
||||
## Configuration Options
|
||||
|
||||
### Webhook Provider
|
||||
|
||||
Choose from supported service providers:
|
||||
|
||||
<Cards>
|
||||
<Card title="Slack" href="#">
|
||||
Receive events from Slack apps and bots
|
||||
</Card>
|
||||
<Card title="Gmail" href="#">
|
||||
Handle email-based triggers and notifications
|
||||
</Card>
|
||||
<Card title="Airtable" href="#">
|
||||
Respond to database changes
|
||||
</Card>
|
||||
<Card title="Telegram" href="#">
|
||||
Process bot messages and updates
|
||||
</Card>
|
||||
<Card title="WhatsApp" href="#">
|
||||
Handle messaging events
|
||||
</Card>
|
||||
<Card title="GitHub" href="#">
|
||||
Process repository events and pull requests
|
||||
</Card>
|
||||
<Card title="Discord" href="#">
|
||||
Respond to Discord server events
|
||||
</Card>
|
||||
<Card title="Stripe" href="#">
|
||||
Handle payment and subscription events
|
||||
</Card>
|
||||
</Cards>
|
||||
|
||||
### Generic Webhooks
|
||||
|
||||
For custom integrations or services not listed above, use the **Generic** provider. This option accepts HTTP POST requests from any client and provides flexible authentication options:
|
||||
|
||||
- **Optional Authentication** - Configure Bearer token or custom header authentication
|
||||
- **IP Restrictions** - Limit access to specific IP addresses
|
||||
- **Request Deduplication** - Automatic duplicate request detection using content hashing
|
||||
- **Flexible Headers** - Support for custom authentication header names
|
||||
|
||||
The Generic provider is ideal for internal services, custom applications, or third-party tools that need to trigger workflows via standard HTTP requests.
|
||||
|
||||
### Webhook Configuration
|
||||
|
||||
Configure provider-specific settings:
|
||||
|
||||
- **Webhook URL** - Automatically generated unique endpoint
|
||||
- **Provider Settings** - Authentication and validation options
|
||||
- **Security** - Built-in rate limiting and provider-specific authentication
|
||||
|
||||
## Best Practices
|
||||
|
||||
- **Use unique webhook URLs** for each integration to maintain security
|
||||
- **Configure proper authentication** when supported by the provider
|
||||
- **Keep workflows independent** of webhook payload structure
|
||||
- **Test webhook endpoints** before deploying to production
|
||||
- **Monitor webhook delivery** through provider dashboards
|
||||
|
||||
|
||||
@@ -161,13 +161,9 @@ Run workflows on-demand through the Sim Studio interface by clicking the "Run" b
|
||||
- One-off tasks
|
||||
- Workflows that need human supervision
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/manual-execution-light.png"
|
||||
darkSrc="/static/dark/manual-execution-dark.png"
|
||||
alt="Manual Execution"
|
||||
width={600}
|
||||
height={400}
|
||||
/>
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/input-format.mp4"></video>
|
||||
</div>
|
||||
|
||||
### Scheduled Execution
|
||||
|
||||
@@ -178,13 +174,9 @@ Configure workflows to run automatically on a specified schedule:
|
||||
- Configure timezone settings
|
||||
- Set minimum and maximum execution intervals
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/scheduled-execution-light.png"
|
||||
darkSrc="/static/dark/scheduled-execution-dark.png"
|
||||
alt="Scheduled Execution"
|
||||
width={600}
|
||||
height={400}
|
||||
/>
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/configure-schedule.mp4"></video>
|
||||
</div>
|
||||
|
||||
### API Endpoints
|
||||
|
||||
@@ -195,13 +187,19 @@ Each workflow can be exposed as an API endpoint:
|
||||
- Send custom inputs via POST requests
|
||||
- Receive execution results as JSON responses
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/api-execution-light.png"
|
||||
darkSrc="/static/dark/api-execution-dark.png"
|
||||
alt="API Execution"
|
||||
width={600}
|
||||
height={400}
|
||||
/>
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/api-deployment.mp4"></video>
|
||||
</div>
|
||||
|
||||
#### Viewing Deployed APIs
|
||||
|
||||
Monitor your deployed workflow APIs and their current state:
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/api-redeployment.mp4"></video>
|
||||
</div>
|
||||
|
||||
This shows how to view the deployed state and compare with the original deployed API configuration.
|
||||
|
||||
### Webhooks
|
||||
|
||||
@@ -212,13 +210,9 @@ Configure workflows to execute in response to external events:
|
||||
- Configure webhook security settings
|
||||
- Support for specialized webhooks (GitHub, Stripe, etc.)
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/webhook-execution-light.png"
|
||||
darkSrc="/static/dark/webhook-execution-dark.png"
|
||||
alt="Webhook Execution"
|
||||
width={600}
|
||||
height={400}
|
||||
/>
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/webhooks.mp4"></video>
|
||||
</div>
|
||||
|
||||
<Callout type="info">
|
||||
The execution method you choose depends on your workflow's purpose. Manual execution is great for
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
"./introduction/index",
|
||||
"./getting-started/index",
|
||||
"---Create---",
|
||||
"triggers",
|
||||
"blocks",
|
||||
"tools",
|
||||
"---Connections---",
|
||||
|
||||
@@ -142,6 +142,25 @@ Get an AI-generated answer to a question with citations from the web using Exa A
|
||||
| `url` | string |
|
||||
| `text` | string |
|
||||
|
||||
### `exa_research`
|
||||
|
||||
Perform comprehensive research using AI to generate detailed reports with citations
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `query` | string | Yes | Research query or topic |
|
||||
| `includeText` | boolean | No | Include full text content in results |
|
||||
| `apiKey` | string | Yes | Exa AI API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `taskId` | string |
|
||||
| `research` | string |
|
||||
|
||||
|
||||
|
||||
## Block Configuration
|
||||
@@ -162,6 +181,7 @@ Get an AI-generated answer to a question with citations from the web using Exa A
|
||||
| `similarLinks` | json | similarLinks output from the block |
|
||||
| `answer` | string | answer output from the block |
|
||||
| `citations` | json | citations output from the block |
|
||||
| `research` | json | research output from the block |
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
@@ -95,6 +95,28 @@ Search for information on the web using Firecrawl
|
||||
| `data` | string |
|
||||
| `warning` | string |
|
||||
|
||||
### `firecrawl_crawl`
|
||||
|
||||
Crawl entire websites and extract structured content from all accessible pages
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `url` | string | Yes | The website URL to crawl |
|
||||
| `limit` | number | No | Maximum number of pages to crawl \(default: 100\) |
|
||||
| `onlyMainContent` | boolean | No | Extract only main content from pages |
|
||||
| `apiKey` | string | Yes | Firecrawl API Key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `jobId` | string |
|
||||
| `pages` | string |
|
||||
| `total` | string |
|
||||
| `creditsUsed` | string |
|
||||
|
||||
|
||||
|
||||
## Block Configuration
|
||||
@@ -116,6 +138,9 @@ Search for information on the web using Firecrawl
|
||||
| `metadata` | json | metadata output from the block |
|
||||
| `data` | json | data output from the block |
|
||||
| `warning` | any | warning output from the block |
|
||||
| `pages` | json | pages output from the block |
|
||||
| `total` | number | total output from the block |
|
||||
| `creditsUsed` | number | creditsUsed output from the block |
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
@@ -37,6 +37,7 @@
|
||||
"qdrant",
|
||||
"reddit",
|
||||
"s3",
|
||||
"schedule",
|
||||
"serper",
|
||||
"slack",
|
||||
"stagehand",
|
||||
@@ -50,6 +51,7 @@
|
||||
"typeform",
|
||||
"vision",
|
||||
"wealthbox",
|
||||
"webhook",
|
||||
"whatsapp",
|
||||
"x",
|
||||
"youtube"
|
||||
|
||||
@@ -62,6 +62,30 @@ Read content from a Notion page
|
||||
| `createdTime` | string |
|
||||
| `url` | string |
|
||||
|
||||
### `notion_read_database`
|
||||
|
||||
Read database information and structure from Notion
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `accessToken` | string | Yes | Notion OAuth access token |
|
||||
| `databaseId` | string | Yes | The ID of the Notion database to read |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `metadata` | string |
|
||||
| `url` | string |
|
||||
| `id` | string |
|
||||
| `createdTime` | string |
|
||||
| `lastEditedTime` | string |
|
||||
| `properties` | string |
|
||||
| `content` | string |
|
||||
| `title` | string |
|
||||
|
||||
### `notion_write`
|
||||
|
||||
Append content to a Notion page
|
||||
@@ -89,10 +113,8 @@ Create a new page in Notion
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `accessToken` | string | Yes | Notion OAuth access token |
|
||||
| `parentType` | string | Yes | Type of parent: |
|
||||
| `parentId` | string | Yes | ID of the parent page or database |
|
||||
| `title` | string | No | Title of the page \(required for parent pages, not for databases\) |
|
||||
| `properties` | json | No | JSON object of properties for database pages |
|
||||
| `parentId` | string | Yes | ID of the parent page |
|
||||
| `title` | string | No | Title of the new page |
|
||||
| `content` | string | No | Optional content to add to the page upon creation |
|
||||
|
||||
#### Output
|
||||
@@ -101,6 +123,77 @@ Create a new page in Notion
|
||||
| --------- | ---- |
|
||||
| `content` | string |
|
||||
|
||||
### `notion_query_database`
|
||||
|
||||
Query and filter Notion database entries with advanced filtering
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `accessToken` | string | Yes | Notion OAuth access token |
|
||||
| `databaseId` | string | Yes | The ID of the database to query |
|
||||
| `filter` | string | No | Filter conditions as JSON \(optional\) |
|
||||
| `sorts` | string | No | Sort criteria as JSON array \(optional\) |
|
||||
| `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `content` | string |
|
||||
| `metadata` | string |
|
||||
| `hasMore` | string |
|
||||
| `nextCursor` | string |
|
||||
| `results` | string |
|
||||
|
||||
### `notion_search`
|
||||
|
||||
Search across all pages and databases in Notion workspace
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `accessToken` | string | Yes | Notion OAuth access token |
|
||||
| `query` | string | No | Search terms \(leave empty to get all pages\) |
|
||||
| `filterType` | string | No | Filter by object type: page, database, or leave empty for all |
|
||||
| `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `content` | string |
|
||||
| `metadata` | string |
|
||||
| `hasMore` | string |
|
||||
| `nextCursor` | string |
|
||||
| `results` | string |
|
||||
|
||||
### `notion_create_database`
|
||||
|
||||
Create a new database in Notion with custom properties
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `accessToken` | string | Yes | Notion OAuth access token |
|
||||
| `parentId` | string | Yes | ID of the parent page where the database will be created |
|
||||
| `title` | string | Yes | Title for the new database |
|
||||
| `properties` | string | No | Database properties as JSON object \(optional, will create a default |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `metadata` | string |
|
||||
| `url` | string |
|
||||
| `createdTime` | string |
|
||||
| `properties` | string |
|
||||
| `content` | string |
|
||||
| `title` | string |
|
||||
|
||||
|
||||
|
||||
## Block Configuration
|
||||
|
||||
@@ -10,7 +10,7 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
color="#1A223F"
|
||||
icon={true}
|
||||
iconSvg={`<svg className="block-icon" fill='none' viewBox='0 0 49 56' xmlns='http://www.w3.org/2000/svg'>
|
||||
<g clip-path='url(#b)'>
|
||||
<g clipPath='url(#b)'>
|
||||
<path
|
||||
d='m38.489 51.477-1.1167-30.787-2.0223-8.1167 13.498 1.429v37.242l-8.2456 4.7589-2.1138-4.5259z'
|
||||
clipRule='evenodd'
|
||||
@@ -168,7 +168,13 @@ Fetch points by ID from a Qdrant collection
|
||||
|
||||
### Outputs
|
||||
|
||||
This block does not produce any outputs.
|
||||
| Output | Type | Description |
|
||||
| ------ | ---- | ----------- |
|
||||
| `matches` | any | matches output from the block |
|
||||
| `upsertedCount` | any | upsertedCount output from the block |
|
||||
| `data` | any | data output from the block |
|
||||
| `status` | any | status output from the block |
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
57
apps/docs/content/docs/tools/schedule.mdx
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Schedule
|
||||
description: Trigger workflow execution on a schedule
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="schedule"
|
||||
color="#7B68EE"
|
||||
icon={true}
|
||||
iconSvg={`<svg className="block-icon"
|
||||
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
|
||||
|
||||
viewBox='0 0 24 24'
|
||||
fill='none'
|
||||
stroke='currentColor'
|
||||
strokeWidth='2'
|
||||
strokeLinecap='round'
|
||||
strokeLinejoin='round'
|
||||
>
|
||||
<path d='M8 2v4' />
|
||||
<path d='M16 2v4' />
|
||||
<rect x='3' y='4' rx='2' />
|
||||
<path d='M3 10h18' />
|
||||
</svg>`}
|
||||
/>
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Configure automated workflow execution with flexible timing options. Set up recurring workflows that run at specific intervals or times.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Block Configuration
|
||||
|
||||
### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `scheduleConfig` | schedule-config | Yes | Schedule Status |
|
||||
| `scheduleType` | dropdown | Yes | Frequency |
|
||||
|
||||
|
||||
|
||||
### Outputs
|
||||
|
||||
This block does not produce any outputs.
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `triggers`
|
||||
- Type: `schedule`
|
||||
@@ -83,6 +83,52 @@ Send messages to Slack channels or users through the Slack API. Supports Slack m
|
||||
| `ts` | string |
|
||||
| `channel` | string |
|
||||
|
||||
### `slack_canvas`
|
||||
|
||||
Create and share Slack canvases in channels. Canvases are collaborative documents within Slack.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||
| `botToken` | string | No | Bot token for Custom Bot |
|
||||
| `accessToken` | string | No | OAuth access token or bot token for Slack API |
|
||||
| `channel` | string | Yes | Target Slack channel \(e.g., #general\) |
|
||||
| `title` | string | Yes | Title of the canvas |
|
||||
| `content` | string | Yes | Canvas content in markdown format |
|
||||
| `document_content` | object | No | Structured canvas document content |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `canvas_id` | string |
|
||||
| `channel` | string |
|
||||
| `title` | string |
|
||||
|
||||
### `slack_message_reader`
|
||||
|
||||
Read the latest messages from Slack channels. Retrieve conversation history with filtering options.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `authMethod` | string | No | Authentication method: oauth or bot_token |
|
||||
| `botToken` | string | No | Bot token for Custom Bot |
|
||||
| `accessToken` | string | No | OAuth access token or bot token for Slack API |
|
||||
| `channel` | string | Yes | Slack channel to read messages from \(e.g., #general\) |
|
||||
| `limit` | number | No | Number of messages to retrieve \(default: 10, max: 100\) |
|
||||
| `oldest` | string | No | Start of time range \(timestamp\) |
|
||||
| `latest` | string | No | End of time range \(timestamp\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `messages` | string |
|
||||
|
||||
|
||||
|
||||
## Block Configuration
|
||||
@@ -101,6 +147,9 @@ Send messages to Slack channels or users through the Slack API. Supports Slack m
|
||||
| ------ | ---- | ----------- |
|
||||
| `ts` | string | ts output from the block |
|
||||
| `channel` | string | channel output from the block |
|
||||
| `canvas_id` | string | canvas_id output from the block |
|
||||
| `title` | string | title output from the block |
|
||||
| `messages` | json | messages output from the block |
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
@@ -85,8 +85,10 @@ Query data from a Supabase table
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
|
||||
| `table` | string | Yes | The name of the Supabase table to query |
|
||||
| `filter` | object | No | Filter to apply to the query |
|
||||
| `apiKey` | string | Yes | Your Supabase client anon key |
|
||||
| `filter` | string | No | PostgREST filter \(e.g., |
|
||||
| `orderBy` | string | No | Column to order by \(add DESC for descending\) |
|
||||
| `limit` | number | No | Maximum number of rows to return |
|
||||
| `apiKey` | string | Yes | Your Supabase service role secret key |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -106,7 +108,7 @@ Insert data into a Supabase table
|
||||
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
|
||||
| `table` | string | Yes | The name of the Supabase table to insert data into |
|
||||
| `data` | any | Yes | The data to insert |
|
||||
| `apiKey` | string | Yes | Your Supabase client anon key |
|
||||
| `apiKey` | string | Yes | Your Supabase service role secret key |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -115,6 +117,65 @@ Insert data into a Supabase table
|
||||
| `message` | string |
|
||||
| `results` | string |
|
||||
|
||||
### `supabase_get_row`
|
||||
|
||||
Get a single row from a Supabase table based on filter criteria
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
|
||||
| `table` | string | Yes | The name of the Supabase table to query |
|
||||
| `filter` | string | Yes | PostgREST filter to find the specific row \(e.g., |
|
||||
| `apiKey` | string | Yes | Your Supabase service role secret key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `message` | string |
|
||||
| `results` | string |
|
||||
|
||||
### `supabase_update`
|
||||
|
||||
Update rows in a Supabase table based on filter criteria
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
|
||||
| `table` | string | Yes | The name of the Supabase table to update |
|
||||
| `filter` | string | Yes | PostgREST filter to identify rows to update \(e.g., |
|
||||
| `data` | object | Yes | Data to update in the matching rows |
|
||||
| `apiKey` | string | Yes | Your Supabase service role secret key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `message` | string |
|
||||
|
||||
### `supabase_delete`
|
||||
|
||||
Delete rows from a Supabase table based on filter criteria
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
|
||||
| `table` | string | Yes | The name of the Supabase table to delete from |
|
||||
| `filter` | string | Yes | PostgREST filter to identify rows to delete \(e.g., |
|
||||
| `apiKey` | string | Yes | Your Supabase service role secret key |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type |
|
||||
| --------- | ---- |
|
||||
| `message` | string |
|
||||
|
||||
|
||||
|
||||
## Block Configuration
|
||||
|
||||
@@ -11,15 +11,22 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
icon={true}
|
||||
iconSvg={`<svg className="block-icon"
|
||||
|
||||
|
||||
|
||||
viewBox='0 0 24 24'
|
||||
fill='none'
|
||||
version='1.1'
|
||||
id='Layer_1'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
xmlnsXlink='http://www.w3.org/1999/xlink'
|
||||
x='0px'
|
||||
y='0px'
|
||||
viewBox='0 0 122.3 80.3'
|
||||
xmlSpace='preserve'
|
||||
>
|
||||
<g transform='translate(1, 4)'>
|
||||
<rect x='0' y='0' rx='2.5' fill='currentColor' />
|
||||
<rect x='8' y='0' rx='4' fill='currentColor' />
|
||||
<g>
|
||||
<path
|
||||
fill='currentColor'
|
||||
d='M94.3,0H65.4c-26,0-28,11.2-28,26.2l0,27.9c0,15.6,2,26.2,28.1,26.2h28.8c26,0,28-11.2,28-26.1V26.2
|
||||
C122.3,11.2,120.3,0,94.3,0z M0,20.1C0,6.9,5.2,0,14,0c8.8,0,14,6.9,14,20.1v40.1c0,13.2-5.2,20.1-14,20.1c-8.8,0-14-6.9-14-20.1
|
||||
V20.1z'
|
||||
/>
|
||||
</g>
|
||||
</svg>`}
|
||||
/>
|
||||
|
||||
46
apps/docs/content/docs/tools/webhook.mdx
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Webhook
|
||||
description: Trigger workflow execution from external webhooks
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="webhook"
|
||||
color="#10B981"
|
||||
icon={true}
|
||||
iconSvg={`<svg className="block-icon"
|
||||
|
||||
fill='currentColor'
|
||||
|
||||
|
||||
viewBox='0 0 24 24'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
>
|
||||
<path d='M17.974 7A4.967 4.967 0 0 0 18 6.5a5.5 5.5 0 1 0-8.672 4.491L7.18 15.114A2.428 2.428 0 0 0 6.496 15 2.5 2.5 0 1 0 9 17.496a2.36 2.36 0 0 0-.93-1.925l2.576-4.943-.41-.241A4.5 4.5 0 1 1 17 6.5a4.8 4.8 0 0 1-.022.452zM6.503 18.999a1.5 1.5 0 1 1 1.496-1.503A1.518 1.518 0 0 1 6.503 19zM18.5 12a5.735 5.735 0 0 0-1.453.157l-2.744-3.941A2.414 2.414 0 0 0 15 6.5a2.544 2.544 0 1 0-1.518 2.284l3.17 4.557.36-.13A4.267 4.267 0 0 1 18.5 13a4.5 4.5 0 1 1-.008 9h-.006a4.684 4.684 0 0 1-3.12-1.355l-.703.71A5.653 5.653 0 0 0 18.49 23h.011a5.5 5.5 0 0 0 0-11zM11 6.5A1.5 1.5 0 1 1 12.5 8 1.509 1.509 0 0 1 11 6.5zM18.5 20a2.5 2.5 0 1 0-2.447-3h-5.05l-.003.497A4.546 4.546 0 0 1 6.5 22 4.526 4.526 0 0 1 2 17.5a4.596 4.596 0 0 1 3.148-4.37l-.296-.954A5.606 5.606 0 0 0 1 17.5 5.532 5.532 0 0 0 6.5 23a5.573 5.573 0 0 0 5.478-5h4.08a2.487 2.487 0 0 0 2.442 2zm0-4a1.5 1.5 0 1 1-1.5 1.5 1.509 1.509 0 0 1 1.5-1.5z' />
|
||||
<path fill='none' d='M0 0h24v24H0z' />
|
||||
</svg>`}
|
||||
/>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Block Configuration
|
||||
|
||||
### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `webhookProvider` | dropdown | Yes | Webhook Provider |
|
||||
|
||||
|
||||
|
||||
### Outputs
|
||||
|
||||
This block does not produce any outputs.
|
||||
|
||||
## Notes
|
||||
|
||||
- Category: `triggers`
|
||||
- Type: `webhook`
|
||||
4
apps/docs/content/docs/triggers/meta.json
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"title": "Triggers",
|
||||
"pages": ["starter", "schedule", "webhook"]
|
||||
}
|
||||
69
apps/docs/content/docs/triggers/schedule.mdx
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title: Schedule
|
||||
description: Automatically trigger workflows on a recurring schedule
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
|
||||
import { ThemeImage } from '@/components/ui/theme-image'
|
||||
|
||||
The Schedule block automatically triggers workflow execution at specified intervals or times.
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/schedule-light.png"
|
||||
darkSrc="/static/dark/schedule-dark.png"
|
||||
alt="Schedule Block"
|
||||
width={350}
|
||||
height={175}
|
||||
/>
|
||||
|
||||
## Schedule Options
|
||||
|
||||
Configure when your workflow runs using the dropdown options:
|
||||
|
||||
<Tabs items={['Simple Intervals', 'Cron Expressions']}>
|
||||
<Tab>
|
||||
<ul className="list-disc space-y-1 pl-6">
|
||||
<li><strong>Every few minutes</strong>: 5, 15, 30 minute intervals</li>
|
||||
<li><strong>Hourly</strong>: Every hour or every few hours</li>
|
||||
<li><strong>Daily</strong>: Once or multiple times per day</li>
|
||||
<li><strong>Weekly</strong>: Specific days of the week</li>
|
||||
<li><strong>Monthly</strong>: Specific days of the month</li>
|
||||
</ul>
|
||||
</Tab>
|
||||
<Tab>
|
||||
<p>Use cron expressions for advanced scheduling:</p>
|
||||
<div className="text-sm space-y-1">
|
||||
<div><code>0 9 * * 1-5</code> - Every weekday at 9 AM</div>
|
||||
<div><code>*/15 * * * *</code> - Every 15 minutes</div>
|
||||
<div><code>0 0 1 * *</code> - First day of each month</div>
|
||||
</div>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Configuring Schedules
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/configure-schedule.mp4"></video>
|
||||
</div>
|
||||
|
||||
When a workflow is scheduled:
|
||||
- The schedule becomes **active** and shows the next execution time
|
||||
- Click the **"Scheduled"** button to deactivate the schedule
|
||||
- Schedules automatically deactivate after **3 consecutive failures**
|
||||
|
||||
## Disabled Schedules
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/schedule-disabled-light.png"
|
||||
darkSrc="/static/dark/schedule-disabled-dark.png"
|
||||
alt="Disabled Schedule"
|
||||
width={500}
|
||||
height={200}
|
||||
/>
|
||||
|
||||
Disabled schedules show when they were last active and can be re-enabled at any time.
|
||||
|
||||
<Callout>
|
||||
Schedule blocks cannot receive incoming connections and serve as pure workflow triggers.
|
||||
</Callout>
|
||||
92
apps/docs/content/docs/triggers/starter.mdx
Normal file
@@ -0,0 +1,92 @@
|
||||
---
|
||||
title: Starter
|
||||
description: Manually initiate workflow execution with input parameters
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
|
||||
import { ThemeImage } from '@/components/ui/theme-image'
|
||||
|
||||
The Starter block allows manual workflow execution with two input modes: structured parameters or conversational chat.
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/starter-light.png"
|
||||
darkSrc="/static/dark/starter-dark.png"
|
||||
alt="Starter Block with Manual and Chat Mode Options"
|
||||
width={350}
|
||||
height={175}
|
||||
/>
|
||||
|
||||
## Execution Modes
|
||||
|
||||
Choose your input method from the dropdown:
|
||||
|
||||
<Tabs items={['Manual Mode', 'Chat Mode']}>
|
||||
<Tab>
|
||||
<div className="space-y-4">
|
||||
<ul className="list-disc space-y-1 pl-6">
|
||||
<li><strong>Structured inputs</strong>: Define specific parameters (text, number, boolean, JSON, file, date)</li>
|
||||
<li><strong>Form interface</strong>: Users fill out a form with predefined fields</li>
|
||||
<li><strong>API friendly</strong>: Perfect for programmatic execution</li>
|
||||
</ul>
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/input-format.mp4"></video>
|
||||
</div>
|
||||
|
||||
<p className="text-sm text-gray-600">Configure input parameters that will be available when deploying as an API endpoint.</p>
|
||||
</div>
|
||||
</Tab>
|
||||
<Tab>
|
||||
<div className="space-y-4">
|
||||
<ul className="list-disc space-y-1 pl-6">
|
||||
<li><strong>Natural language</strong>: Users type questions or requests</li>
|
||||
<li><strong>start.input variable</strong>: Captures all user input as `<start.input>`</li>
|
||||
<li><strong>start.conversationId</strong>: Access conversation ID as `<start.conversationId>`</li>
|
||||
<li><strong>Conversational</strong>: Ideal for AI-powered workflows</li>
|
||||
</ul>
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/chat-input.mp4"></video>
|
||||
</div>
|
||||
|
||||
<p className="text-sm text-gray-600">Chat with your workflow and access both input text and conversation ID for context-aware responses.</p>
|
||||
</div>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Using Chat Variables
|
||||
|
||||
In Chat mode, access user input and conversation context through special variables:
|
||||
|
||||
```yaml
|
||||
# Reference the chat input and conversation ID in your workflow
|
||||
user_message: "<start.input>"
|
||||
conversation_id: "<start.conversationId>"
|
||||
```
|
||||
|
||||
- **`<start.input>`** - Contains the user's message text
|
||||
- **`<start.conversationId>`** - Unique identifier for the conversation thread
|
||||
|
||||
## API Execution
|
||||
|
||||
<Tabs items={['Manual Mode', 'Chat Mode']}>
|
||||
<Tab>
|
||||
```bash
|
||||
curl -X POST "https://api.sim.dev/v1/workflows/{id}/start" \
|
||||
-H "Authorization: Bearer {api-key}" \
|
||||
-d '{"parameters": {"userId": "123", "action": "process"}}'
|
||||
```
|
||||
</Tab>
|
||||
<Tab>
|
||||
```bash
|
||||
curl -X POST "https://api.sim.dev/v1/workflows/{id}/start" \
|
||||
-H "Authorization: Bearer {api-key}" \
|
||||
-d '{"input": "Analyze Q4 sales data"}'
|
||||
```
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
<Callout>
|
||||
Starter blocks are ideal for testing workflows and user-initiated tasks. For automated execution, use Schedule or Webhook triggers.
|
||||
</Callout>
|
||||
53
apps/docs/content/docs/triggers/webhook.mdx
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Webhooks
|
||||
description: Trigger workflow execution from external webhooks
|
||||
---
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs'
|
||||
import { ThemeImage } from '@/components/ui/theme-image'
|
||||
|
||||
The Webhook block allows external services to automatically trigger your workflow execution through HTTP webhooks.
|
||||
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/webhooks.mp4"></video>
|
||||
</div>
|
||||
|
||||
## Supported Providers
|
||||
|
||||
Choose from the dropdown to configure your webhook source:
|
||||
|
||||
<Tabs items={['Popular Services', 'Generic']}>
|
||||
<Tab>
|
||||
<ul className="grid grid-cols-2 gap-1 text-sm">
|
||||
<li>**Slack** - Bot events and messages</li>
|
||||
<li>**Gmail** - Email notifications</li>
|
||||
<li>**GitHub** - Repository events</li>
|
||||
<li>**Discord** - Server events</li>
|
||||
<li>**Airtable** - Database changes</li>
|
||||
<li>**Telegram** - Bot messages</li>
|
||||
<li>**WhatsApp** - Messaging events</li>
|
||||
<li>**Stripe** - Payment events</li>
|
||||
</ul>
|
||||
</Tab>
|
||||
<Tab>
|
||||
<p>For custom integrations:</p>
|
||||
<ul className="list-disc space-y-1 pl-6 text-sm">
|
||||
<li><strong>HTTP POST</strong>: Accepts requests from any client</li>
|
||||
<li><strong>Authentication</strong>: Bearer token or custom headers</li>
|
||||
<li><strong>Security</strong>: IP restrictions and rate limiting</li>
|
||||
<li><strong>Deduplication</strong>: Prevents duplicate requests</li>
|
||||
</ul>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Configure Provider** - Select from dropdown and set up authentication
|
||||
2. **Get Webhook URL** - Automatically generated unique endpoint
|
||||
3. **External Service** - Sends HTTP POST to your webhook URL
|
||||
4. **Workflow Triggers** - Automatically starts when webhook is received
|
||||
|
||||
<Callout>
|
||||
Webhooks cannot receive incoming connections and serve as pure workflow triggers.
|
||||
</Callout>
|
||||
@@ -10,13 +10,9 @@ import { ThemeImage } from '@/components/ui/theme-image'
|
||||
|
||||
Variables in Sim Studio act as a global store for data that can be accessed and modified by any block in your workflow. They provide a powerful way to share information between different parts of your workflow, maintain state, and create more dynamic applications.
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/variables-light.png"
|
||||
darkSrc="/static/dark/variables-dark.png"
|
||||
alt="Variables Panel"
|
||||
width={300}
|
||||
height={175}
|
||||
/>
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/variables.mp4"></video>
|
||||
</div>
|
||||
|
||||
<Callout type="info">
|
||||
Variables allow you to store and share data across your entire workflow, making it easy to
|
||||
@@ -60,13 +56,9 @@ Variables can be accessed from any block in your workflow using the variable dro
|
||||
2. Browse the dropdown menu to select from available variables
|
||||
3. Select the variable you want to use
|
||||
|
||||
<ThemeImage
|
||||
lightSrc="/static/light/variabledropdown-light.png"
|
||||
darkSrc="/static/dark/variabledropdown-dark.png"
|
||||
alt="Variable Dropdown"
|
||||
width={300}
|
||||
height={175}
|
||||
/>
|
||||
<div className="mx-auto w-full overflow-hidden rounded-lg">
|
||||
<video autoPlay loop muted playsInline className="w-full -mb-2 rounded-lg" src="/variables-dropdown.mp4"></video>
|
||||
</div>
|
||||
|
||||
<Callout>
|
||||
You can also drag the connection tag into a field to open the variable dropdown and access
|
||||
|
||||
BIN
apps/docs/public/api-deployment.mp4
Normal file
BIN
apps/docs/public/api-redeployment.mp4
Normal file
BIN
apps/docs/public/chat-input.mp4
Normal file
BIN
apps/docs/public/configure-schedule.mp4
Normal file
BIN
apps/docs/public/input-format.mp4
Normal file
|
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 88 KiB |
BIN
apps/docs/public/static/dark/schedule-dark.png
Normal file
|
After Width: | Height: | Size: 74 KiB |
BIN
apps/docs/public/static/dark/schedule-disabled-dark.png
Normal file
|
After Width: | Height: | Size: 92 KiB |
BIN
apps/docs/public/static/dark/scheduled-dark.png
Normal file
|
After Width: | Height: | Size: 75 KiB |
BIN
apps/docs/public/static/dark/starter-dark.png
Normal file
|
After Width: | Height: | Size: 51 KiB |
BIN
apps/docs/public/static/dark/webhook-dark.png
Normal file
|
After Width: | Height: | Size: 72 KiB |
|
Before Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 102 KiB |
BIN
apps/docs/public/static/light/schedule-disabled-light.png
Normal file
|
After Width: | Height: | Size: 87 KiB |
BIN
apps/docs/public/static/light/schedule-light.png
Normal file
|
After Width: | Height: | Size: 67 KiB |
BIN
apps/docs/public/static/light/scheduled-light.png
Normal file
|
After Width: | Height: | Size: 86 KiB |
BIN
apps/docs/public/static/light/starter-light.png
Normal file
|
After Width: | Height: | Size: 47 KiB |
BIN
apps/docs/public/static/light/webhook-light.png
Normal file
|
After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 36 KiB |
BIN
apps/docs/public/variables-dropdown.mp4
Normal file
BIN
apps/docs/public/variables.mp4
Normal file
BIN
apps/docs/public/webhooks.mp4
Normal file
@@ -1853,15 +1853,22 @@ export function TypeformIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg
|
||||
{...props}
|
||||
width='24'
|
||||
height='24'
|
||||
viewBox='0 0 24 24'
|
||||
fill='none'
|
||||
version='1.1'
|
||||
id='Layer_1'
|
||||
xmlns='http://www.w3.org/2000/svg'
|
||||
xmlnsXlink='http://www.w3.org/1999/xlink'
|
||||
x='0px'
|
||||
y='0px'
|
||||
viewBox='0 0 122.3 80.3'
|
||||
xmlSpace='preserve'
|
||||
>
|
||||
<g transform='translate(1, 4)'>
|
||||
<rect x='0' y='0' width='5' height='16' rx='2.5' fill='currentColor' />
|
||||
<rect x='8' y='0' width='14' height='16' rx='4' fill='currentColor' />
|
||||
<g>
|
||||
<path
|
||||
fill='currentColor'
|
||||
d='M94.3,0H65.4c-26,0-28,11.2-28,26.2l0,27.9c0,15.6,2,26.2,28.1,26.2h28.8c26,0,28-11.2,28-26.1V26.2
|
||||
C122.3,11.2,120.3,0,94.3,0z M0,20.1C0,6.9,5.2,0,14,0c8.8,0,14,6.9,14,20.1v40.1c0,13.2-5.2,20.1-14,20.1c-8.8,0-14-6.9-14-20.1
|
||||
V20.1z'
|
||||
/>
|
||||
</g>
|
||||
</svg>
|
||||
)
|
||||
|
||||