From 47dab6feb0393d328c380fbc2943bfaece955984 Mon Sep 17 00:00:00 2001 From: Waleed Latif Date: Thu, 5 Nov 2026 22:15:50 -0800 Subject: [PATCH 1/2] fix(docs): align navigation and collapse integration fields --- apps/docs/EDITORIAL_GUIDE.md | 2 +- apps/docs/components/docs/navigation.tsx | 2 +- .../components/docs/table-of-contents.tsx | 6 +- apps/docs/content/docs/integrations/apify.mdx | 23 ++++- apps/docs/content/docs/integrations/arxiv.mdx | 15 +++- .../docs/integrations/azure_devops.mdx | 14 ++- .../content/docs/integrations/brandfetch.mdx | 4 + .../content/docs/integrations/calendly.mdx | 4 + apps/docs/content/docs/integrations/clay.mdx | 7 +- .../content/docs/integrations/datagma.mdx | 16 ++++ .../content/docs/integrations/deployments.mdx | 23 ++++- apps/docs/content/docs/integrations/dspy.mdx | 15 +++- .../content/docs/integrations/embeddings.mdx | 27 +++++- .../content/docs/integrations/enrichment.mdx | 7 +- apps/docs/content/docs/integrations/enrow.mdx | 11 ++- apps/docs/content/docs/integrations/exa.mdx | 8 ++ .../docs/content/docs/integrations/extend.mdx | 7 +- .../docs/content/docs/integrations/fathom.mdx | 20 +++++ .../content/docs/integrations/fireflies.mdx | 4 + apps/docs/content/docs/integrations/flint.mdx | 15 +++- apps/docs/content/docs/integrations/gamma.mdx | 23 ++++- .../docs/content/docs/integrations/gitlab.mdx | 14 ++- apps/docs/content/docs/integrations/gmail.mdx | 4 + .../content/docs/integrations/google_ads.mdx | 20 +++++ .../docs/integrations/google_appsheet.mdx | 19 +++- .../docs/integrations/google_books.mdx | 4 + .../docs/integrations/google_contacts.mdx | 27 +++++- .../docs/integrations/google_drive.mdx | 4 + .../docs/integrations/google_forms.mdx | 4 + .../content/docs/integrations/google_meet.mdx | 27 +++++- .../docs/integrations/google_sheets.mdx | 4 + .../docs/integrations/google_tasks.mdx | 20 +++++ .../docs/integrations/google_translate.mdx | 11 ++- .../content/docs/integrations/granola.mdx | 19 ++-- .../content/docs/integrations/greptile.mdx | 15 +++- .../content/docs/integrations/huggingface.mdx | 7 +- .../docs/content/docs/integrations/hunter.mdx | 8 ++ .../content/docs/integrations/icypeas.mdx | 11 ++- .../content/docs/integrations/incidentio.mdx | 19 ++-- .../content/docs/integrations/intercom.mdx | 29 ++++--- apps/docs/content/docs/integrations/jina.mdx | 11 ++- .../content/docs/integrations/jotform.mdx | 4 + apps/docs/content/docs/integrations/ketch.mdx | 23 ++++- .../content/docs/integrations/langsmith.mdx | 16 ++++ apps/docs/content/docs/integrations/latex.mdx | 19 +++- .../content/docs/integrations/lemlist.mdx | 13 ++- .../content/docs/integrations/linkedin.mdx | 11 ++- .../docs/content/docs/integrations/linkup.mdx | 7 +- apps/docs/content/docs/integrations/linq.mdx | 29 ++++--- .../content/docs/integrations/logfire.mdx | 8 ++ .../content/docs/integrations/logrocket.mdx | 27 +++++- apps/docs/content/docs/integrations/logs.mdx | 11 ++- apps/docs/content/docs/integrations/mem0.mdx | 8 ++ .../docs/content/docs/integrations/memory.mdx | 19 +++- .../docs/integrations/microsoft_teams.mdx | 4 + .../docs/integrations/millionverifier.mdx | 11 ++- apps/docs/content/docs/integrations/modal.mdx | 15 +++- .../content/docs/integrations/mongodb.mdx | 27 +++++- apps/docs/content/docs/integrations/mssql.mdx | 20 +++++ apps/docs/content/docs/integrations/mysql.mdx | 27 +++++- .../content/docs/integrations/neverbounce.mdx | 11 ++- .../content/docs/integrations/new_relic.mdx | 12 +++ .../content/docs/integrations/oracledb.mdx | 20 +++++ .../content/docs/integrations/parallel_ai.mdx | 15 +++- .../content/docs/integrations/perplexity.mdx | 11 ++- .../content/docs/integrations/postgresql.mdx | 20 +++++ apps/docs/content/docs/integrations/pulse.mdx | 7 +- .../docs/content/docs/integrations/qdrant.mdx | 15 +++- .../docs/content/docs/integrations/quiver.mdx | 15 +++- apps/docs/content/docs/integrations/rds.mdx | 27 +++++- .../content/docs/integrations/reducto.mdx | 7 +- .../content/docs/integrations/salesforce.mdx | 29 ++++--- .../content/docs/integrations/sendblue.mdx | 8 ++ .../docs/content/docs/integrations/sentry.mdx | 9 +- .../docs/content/docs/integrations/serper.mdx | 7 +- .../content/docs/integrations/servicenow.mdx | 4 + apps/docs/content/docs/integrations/sftp.mdx | 23 ++++- .../content/docs/integrations/similarweb.mdx | 20 +++++ .../content/docs/integrations/sixtyfour.mdx | 12 +++ apps/docs/content/docs/integrations/smtp.mdx | 7 +- .../content/docs/integrations/stagehand.mdx | 4 + .../docs/content/docs/integrations/stripe.mdx | 4 + apps/docs/content/docs/integrations/sts.mdx | 20 +++++ .../docs/content/docs/integrations/tavily.mdx | 8 ++ .../content/docs/integrations/textract.mdx | 8 ++ .../docs/content/docs/integrations/tiktok.mdx | 52 ++++++++--- .../content/docs/integrations/twilio_sms.mdx | 7 +- .../docs/integrations/twilio_voice.mdx | 8 ++ .../content/docs/integrations/wealthbox.mdx | 27 +++++- .../content/docs/integrations/webflow.mdx | 42 +++++++-- .../content/docs/integrations/wikipedia.mdx | 12 +++ apps/docs/content/docs/integrations/wiza.mdx | 4 + .../content/docs/integrations/zerobounce.mdx | 11 ++- .../content/docs/integrations/zoho_desk.mdx | 4 + apps/docs/content/docs/integrations/zoom.mdx | 19 ++-- .../content/docs/integrations/zoominfo.mdx | 16 ++++ apps/docs/scripts/test-navigation-e2e.ts | 86 +++++++++++++++++++ scripts/generate-docs.ts | 24 ++---- 98 files changed, 1321 insertions(+), 143 deletions(-) diff --git a/apps/docs/EDITORIAL_GUIDE.md b/apps/docs/EDITORIAL_GUIDE.md index 60561bd4de5..e7fb832e5ce 100644 --- a/apps/docs/EDITORIAL_GUIDE.md +++ b/apps/docs/EDITORIAL_GUIDE.md @@ -60,7 +60,7 @@ A link replaces repeated detail only after the owner contains it. Keep a concise - Use a callout for a specific prerequisite or a non-obvious security, data-loss, or operational risk that deserves interruption. Use ordinary prose or a table for normal explanation. Keep important limits visible. - Use Markdown lists and tables for simple procedures and reference data. Use tabs for distinct configurations and Steps for substantial sequential procedures. - Integration table cells use ordinary word wrapping so short field names and types stay readable. Keep long tokens within the existing table scroll container; do not let them widen the page. -- On large integration references, keep action and trigger descriptions visible and fold their field tables into `ReferenceDetails`. Preserve headings inside each disclosure so direct links and browser search can reveal them. Setup requirements and consequential warnings stay outside the folded tables. +- On integration references, keep action and trigger descriptions visible and fold their field tables into `ReferenceDetails`, regardless of the number of fields. Preserve headings inside each disclosure so direct links and browser search can reveal them. Setup requirements and consequential warnings stay outside the folded tables. - Integration logos belong beside the page title, using the generated `integration` frontmatter. Keep the regular docs header actions and do not repeat the logo in the article body. - Match inline code to Sim Chat: normal-weight monospace text, tight padding, and the existing borderless filled surface tokens. Scope the treatment to prose code; preserve fenced examples, API route bars, schema controls, and selector labels. - Use the shared `TabsSelect` control for API response and request-example pickers, with accessible names that include the current value, checked radio semantics for single choices, and menus aligned to their triggers. Keep docs pickers nonmodal so they do not hide lazily hydrating siblings. Keep response headings free of inherited extra margins. Scope dependency filter styling to `data-object-search-input`, including schema popovers portaled to the body; focus stays inside the field, and touch fields retain the shared target and text sizes. diff --git a/apps/docs/components/docs/navigation.tsx b/apps/docs/components/docs/navigation.tsx index 73d5eb4f693..cd6b1594f6d 100644 --- a/apps/docs/components/docs/navigation.tsx +++ b/apps/docs/components/docs/navigation.tsx @@ -17,7 +17,7 @@ interface NavigationItemProps extends Omit { } const rowClass = - 'group flex min-h-[30px] w-full items-center gap-1.5 rounded-lg px-2 py-[5px] text-docs-nav text-[var(--docs-text)] transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2' + 'group flex min-h-[30px] w-full items-center gap-1.5 rounded-lg px-2 py-[5px] text-left text-docs-nav text-[var(--docs-text)] transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2' function containsPath(node: NavNode, pathname: string): boolean { return ( diff --git a/apps/docs/components/docs/table-of-contents.tsx b/apps/docs/components/docs/table-of-contents.tsx index ac590fd17b5..4f4b5289e3c 100644 --- a/apps/docs/components/docs/table-of-contents.tsx +++ b/apps/docs/components/docs/table-of-contents.tsx @@ -26,11 +26,11 @@ export function TableOfContents({ headings, active, compact = false }: TableOfCo if (details) details.open = false }} className={cn( - 'dark:-mx-2 block rounded-md pointer-coarse:py-3 text-docs-control leading-5 transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2 dark:px-2 dark:hover:bg-[var(--docs-hover)]', + 'dark:-mx-2 block rounded-md pointer-coarse:py-3 text-docs-control leading-5 transition-colors focus-visible:outline-2 focus-visible:outline-[var(--docs-link)] focus-visible:outline-offset-2 dark:px-2', depth > 2 && 'pl-3 dark:pl-5', active === id - ? 'text-[var(--docs-toc-current)] dark:underline dark:underline-offset-[3px]' - : 'text-[var(--docs-muted)] hover:text-[var(--docs-heading)] dark:hover:text-[var(--docs-muted)]' + ? 'text-[var(--docs-toc-current)] underline underline-offset-[3px]' + : 'text-[var(--docs-muted)]' )} > {title} diff --git a/apps/docs/content/docs/integrations/apify.mdx b/apps/docs/content/docs/integrations/apify.mdx index d0dd8754a23..c0e6a7929d3 100644 --- a/apps/docs/content/docs/integrations/apify.mdx +++ b/apps/docs/content/docs/integrations/apify.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [Apify](https://apify.com/) runs Actors for web scraping and browser automation. Run an Actor synchronously when it can finish within the synchronous endpoint’s five-minute limit. **Run Actor (Async)** starts a provider run and polls it within the same Sim step; it does not return immediately for detached processing. Its polling budget follows Sim’s default synchronous execution timeout. If that wait ends before the Actor finishes, use the returned run ID with **Get Run**, then retrieve dataset items after success. You can also run saved Actor tasks and fetch dataset items directly. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Run any Apify actor or saved task with custom input, fetch dataset items, and check run status. Supports both synchronous and asynchronous execution with automatic dataset fetching. @@ -22,6 +23,8 @@ Run any Apify actor or saved task with custom input, fetch dataset items, and ch Run an APIFY actor synchronously and get results (max 5 minutes) + + #### Input | Parameter | Type | Required | Description | @@ -42,10 +45,14 @@ Run an APIFY actor synchronously and get results (max 5 minutes) | `status` | string | Run status \(SUCCEEDED, FAILED, etc.\) | | `items` | array | Dataset items \(if completed\) | + + ### APIFY Run Actor (Async) Start an APIFY Actor run and poll it within the same workflow step until completion or the polling deadline + + #### Input | Parameter | Type | Required | Description | @@ -69,10 +76,14 @@ Start an APIFY Actor run and poll it within the same workflow step until complet | `datasetId` | string | Dataset ID containing results | | `items` | array | Dataset items \(if completed\) | + + ### APIFY Run Task Run a saved APIFY actor task synchronously and get dataset items (max 5 minutes) + + #### Input | Parameter | Type | Required | Description | @@ -93,10 +104,14 @@ Run a saved APIFY actor task synchronously and get dataset items (max 5 minutes) | `status` | string | Run status \(SUCCEEDED, FAILED, etc.\) | | `items` | array | Dataset items produced by the run | + + ### APIFY Get Dataset Items Retrieve items stored in an APIFY dataset + + #### Input | Parameter | Type | Required | Description | @@ -116,10 +131,14 @@ Retrieve items stored in an APIFY dataset | `items` | array | Items stored in the dataset | | `count` | number | Number of items returned | + + ### APIFY Get Run Get the status and details of an APIFY actor run + + #### Input | Parameter | Type | Required | Description | @@ -140,4 +159,6 @@ Get the status and details of an APIFY actor run | `keyValueStoreId` | string | Default key-value store ID for the run | | `stats` | json | Run statistics \(memory, CPU, duration\) | + + diff --git a/apps/docs/content/docs/integrations/arxiv.mdx b/apps/docs/content/docs/integrations/arxiv.mdx index a764268412d..548c01b97e7 100644 --- a/apps/docs/content/docs/integrations/arxiv.mdx +++ b/apps/docs/content/docs/integrations/arxiv.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [arXiv](https://arxiv.org/) hosts research papers. Search by keyword, author, title, or category, retrieve a paper’s metadata, or list papers by an author. This integration does not require an API key or OAuth connection. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Search arXiv papers, retrieve paper metadata, or list an author’s papers. No API key or OAuth connection is required. @@ -22,6 +23,8 @@ Search arXiv papers, retrieve paper metadata, or list an author’s papers. No A Search for academic papers on ArXiv by keywords, authors, titles, or other fields. + + #### Input | Parameter | Type | Required | Description | @@ -39,10 +42,14 @@ Search for academic papers on ArXiv by keywords, authors, titles, or other field | `papers` | json | Array of papers matching the search query | | `totalResults` | number | Total number of results found for the search query | + + ### ArXiv Get Paper Get detailed information about a specific ArXiv paper by its ID. + + #### Input | Parameter | Type | Required | Description | @@ -55,10 +62,14 @@ Get detailed information about a specific ArXiv paper by its ID. | --------- | ---- | ----------- | | `paper` | json | Detailed information about the requested ArXiv paper | + + ### ArXiv Get Author Papers Search for papers by a specific author on ArXiv. + + #### Input | Parameter | Type | Required | Description | @@ -73,4 +84,6 @@ Search for papers by a specific author on ArXiv. | `authorPapers` | json | Array of papers authored by the specified author | | `totalResults` | number | Total number of papers found for the author | + + diff --git a/apps/docs/content/docs/integrations/azure_devops.mdx b/apps/docs/content/docs/integrations/azure_devops.mdx index 37a22cf2d37..8b2bcc313c2 100644 --- a/apps/docs/content/docs/integrations/azure_devops.mdx +++ b/apps/docs/content/docs/integrations/azure_devops.mdx @@ -616,6 +616,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when an Azure DevOps build fails, is canceled, or partially succeeds + + #### Output | Parameter | Type | Description | @@ -634,13 +636,14 @@ Trigger workflow when an Azure DevOps build fails, is canceled, or partially suc | `finishTime` | string | Build finish time \(ISO 8601\) | | `buildUrl` | string | API URL for the build resource | - ---- + ### Azure DevOps Webhook (All Service Hook Events) Trigger on whichever service hook event types you configure in Azure DevOps. Sim does not filter deliveries for this trigger. + + #### Output | Parameter | Type | Description | @@ -655,13 +658,14 @@ Trigger on whichever service hook event types you configure in Azure DevOps. Sim | `message` | json | Short message object | | `detailedMessage` | json | Detailed message object | - ---- + ### Azure DevOps Work Item Created Trigger workflow when a work item is created in Azure DevOps + + #### Output | Parameter | Type | Description | @@ -679,3 +683,5 @@ Trigger workflow when a work item is created in Azure DevOps | `projectName` | string | Azure DevOps project name | | `workItemUrl` | string | API URL for the work item resource | + + diff --git a/apps/docs/content/docs/integrations/brandfetch.mdx b/apps/docs/content/docs/integrations/brandfetch.mdx index 513fabac904..780a61ea47c 100644 --- a/apps/docs/content/docs/integrations/brandfetch.mdx +++ b/apps/docs/content/docs/integrations/brandfetch.mdx @@ -67,6 +67,8 @@ Retrieve brand assets including logos, colors, fonts, and company info by domain Search for brands by name and find their domains and logos + + #### Input | Parameter | Type | Required | Description | @@ -85,4 +87,6 @@ Search for brands by name and find their domains and logos | ↳ `claimed` | boolean | Whether the brand profile is claimed | | ↳ `icon` | string | Brand icon URL | + + diff --git a/apps/docs/content/docs/integrations/calendly.mdx b/apps/docs/content/docs/integrations/calendly.mdx index 2466bc54149..59b04c7b283 100644 --- a/apps/docs/content/docs/integrations/calendly.mdx +++ b/apps/docs/content/docs/integrations/calendly.mdx @@ -935,6 +935,8 @@ Trigger workflow when someone submits a Calendly routing form Trigger workflow from any Calendly webhook event + + #### Configuration | Parameter | Type | Required | Description | @@ -951,3 +953,5 @@ Trigger workflow from any Calendly webhook event | `created_by` | string | URI of the Calendly user who created this webhook | | `payload` | object | Complete event payload \(structure varies by event type\) | + + diff --git a/apps/docs/content/docs/integrations/clay.mdx b/apps/docs/content/docs/integrations/clay.mdx index a4efa3caf13..92e603b5e2f 100644 --- a/apps/docs/content/docs/integrations/clay.mdx +++ b/apps/docs/content/docs/integrations/clay.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [Clay](https://www.clay.com/) organizes and enriches data in tables. Use the Clay Populate action to send structured data from your Sim workflow to a Clay table through its webhook URL—for example, lead records or research results. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Send structured records to a Clay table through its webhook URL. @@ -22,6 +23,8 @@ Send structured records to a Clay table through its webhook URL. Send structured JSON data to a Clay table webhook and return its response and HTTP metadata. + + #### Input | Parameter | Type | Required | Description | @@ -42,4 +45,6 @@ Send structured JSON data to a Clay table webhook and return its response and HT | ↳ `timestamp` | string | ISO timestamp recorded when the webhook response was processed | | ↳ `contentType` | string | Content type of the response | + + diff --git a/apps/docs/content/docs/integrations/datagma.mdx b/apps/docs/content/docs/integrations/datagma.mdx index df9fdd71d17..3d3158c2659 100644 --- a/apps/docs/content/docs/integrations/datagma.mdx +++ b/apps/docs/content/docs/integrations/datagma.mdx @@ -25,6 +25,8 @@ Integrate Datagma to find verified work emails from a name and company, enrich p Find a verified work email from a person's full name and company. Uses 1 credit when a verified email is found. + + #### Input | Parameter | Type | Required | Description | @@ -47,6 +49,8 @@ Find a verified work email from a person's full name and company. Uses 1 credit | `smtpCheck` | boolean | Whether SMTP validation succeeded | | `catchAll` | boolean | Whether the domain is catch-all | + + ### Datagma Enrich Person Enrich a person's profile using their email, LinkedIn URL, or full name and company. Returns job title, company, location, and social data. Uses 2 credits per match; add 30 credits when a phone number is found. @@ -92,6 +96,8 @@ Enrich a person's profile using their email, LinkedIn URL, or full name and comp Enrich a company profile using a domain, company name, or SIREN number (France). Returns size, industry, revenue, and description. Uses 2 credits per match. + + #### Input | Parameter | Type | Required | Description | @@ -115,10 +121,14 @@ Enrich a company profile using a domain, company name, or SIREN number (France). | `revenueRange` | string | Estimated annual revenue range | | `headquarters` | string | Headquarters location | + + ### Datagma Find Phone Find a mobile phone number from a person's LinkedIn URL. Optionally supply an email to improve match accuracy. Uses 30 credits when a number is found. + + #### Input | Parameter | Type | Required | Description | @@ -136,10 +146,14 @@ Find a mobile phone number from a person's LinkedIn URL. Optionally supply an em | `countryCode` | string | Country code prefix \(e.g., +1\) | | `isWhatsapp` | boolean | Whether the number is linked to WhatsApp | + + ### Datagma Get Credits Check remaining credit balance on a Datagma account. Free — no credits consumed. + + #### Input | Parameter | Type | Required | Description | @@ -152,4 +166,6 @@ Check remaining credit balance on a Datagma account. Free — no credits consume | --------- | ---- | ----------- | | `credits` | number | Remaining Datagma credits | + + diff --git a/apps/docs/content/docs/integrations/deployments.mdx b/apps/docs/content/docs/integrations/deployments.mdx index 1b5a16e885b..714b7b8ed20 100644 --- a/apps/docs/content/docs/integrations/deployments.mdx +++ b/apps/docs/content/docs/integrations/deployments.mdx @@ -6,6 +6,8 @@ integration: color: "#0C0C0C" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use the Deployments block to manage other workflows in the current workspace. Deploy creates a new version; Promote Version to Live makes an existing version live without creating another. Undeploy takes a workflow offline and removes its triggers, webhooks, and schedules. @@ -13,7 +15,6 @@ Use the Deployments block to manage other workflows in the current workspace. De For the deployment UI and execution model, see [Workflow Deployment](/workflows/deployment). {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Deploy, undeploy, and roll back workflows in the current workspace. Promote a previous deployment version to live, list every version, or fetch the deployed workflow state for a specific version. @@ -24,6 +25,8 @@ Deploy, undeploy, and roll back workflows in the current workspace. Promote a pr Deploy a workflow’s current draft state, creating a new deployment version and making it live for API execution. Requires admin permission on the workflow’s workspace. + + #### Input | Parameter | Type | Required | Description | @@ -42,10 +45,14 @@ Deploy a workflow’s current draft state, creating a new deployment version and | `version` | number | The deployment version that is now active | | `warnings` | array | Non-fatal warnings \(e.g. trigger or schedule sync still in progress\) | + + ### Undeploy Workflow Take a deployed workflow offline. API execution stops and schedules, webhooks, and other deployment side effects are removed. Requires admin permission on the workflow’s workspace. + + #### Input | Parameter | Type | Required | Description | @@ -61,10 +68,14 @@ Take a deployed workflow offline. API execution stops and schedules, webhooks, a | `deployedAt` | string | Always null after an undeploy | | `warnings` | array | Non-fatal warnings \(e.g. trigger or schedule cleanup still in progress\) | + + ### Promote Version to Live Make a specific deployment version the live one without creating a new version — the same operation as Promote to live in the deploy modal. Useful for rolling back to a known-good version. Also works on an undeployed workflow: it re-deploys the workflow live at that version. Requires admin permission on the workflow’s workspace. + + #### Input | Parameter | Type | Required | Description | @@ -82,10 +93,14 @@ Make a specific deployment version the live one without creating a new version | `version` | number | The deployment version that is now live | | `warnings` | array | Non-fatal warnings \(e.g. trigger or schedule sync still in progress\) | + + ### List Deployment Versions List every deployment version of a workflow, newest first, including which version is currently live. + + #### Input | Parameter | Type | Required | Description | @@ -99,10 +114,14 @@ List every deployment version of a workflow, newest first, including which versi | `workflowId` | string | ID of the workflow | | `versions` | array | Deployment versions, newest first \(id, version, name, description, isActive, createdAt, createdBy, deployedByName\) | + + ### Get Deployment Version Fetch a single deployment version of a workflow, including its metadata and the full workflow state snapshot that was deployed. + + #### Input | Parameter | Type | Required | Description | @@ -122,4 +141,6 @@ Fetch a single deployment version of a workflow, including its metadata and the | `createdAt` | string | When this version was deployed \(ISO 8601\) | | `deployedState` | json | The full workflow state snapshot \(blocks, edges, loops, parallels, variables\) | + + diff --git a/apps/docs/content/docs/integrations/dspy.mdx b/apps/docs/content/docs/integrations/dspy.mdx index 297a1b9edb6..67588bb807a 100644 --- a/apps/docs/content/docs/integrations/dspy.mdx +++ b/apps/docs/content/docs/integrations/dspy.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [DSPy](https://github.com/stanford-oval/dspy) to call a self-hosted server that exposes your DSPy programs. Configure the server URL, authentication, input fields, and context expected by that endpoint. @@ -13,7 +15,6 @@ Use [DSPy](https://github.com/stanford-oval/dspy) to call a self-hosted server t The block supports Predict, Chain of Thought, and ReAct operations. The behavior of each call depends on the DSPy program and model you deploy; Sim does not host the program for you. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Integrate with your self-hosted DSPy programs for LLM-powered predictions. Supports Predict, Chain of Thought, and ReAct agents. DSPy is the framework for programming—not prompting—language models. @@ -24,6 +25,8 @@ Integrate with your self-hosted DSPy programs for LLM-powered predictions. Suppo Run a prediction using a self-hosted DSPy program endpoint + + #### Input | Parameter | Type | Required | Description | @@ -45,10 +48,14 @@ Run a prediction using a self-hosted DSPy program endpoint | `status` | string | Response status from the DSPy server \(success or error\) | | `rawOutput` | json | The complete raw output from the DSPy program \(result.toDict\(\)\) | + + ### DSPy Chain of Thought Run a Chain of Thought prediction using a self-hosted DSPy ChainOfThought program endpoint + + #### Input | Parameter | Type | Required | Description | @@ -68,10 +75,14 @@ Run a Chain of Thought prediction using a self-hosted DSPy ChainOfThought progra | `status` | string | Response status from the DSPy server \(success or error\) | | `rawOutput` | json | The complete raw output from the DSPy program \(result.toDict\(\)\) | + + ### DSPy ReAct Run a ReAct agent using a self-hosted DSPy ReAct program endpoint for multi-step reasoning and action + + #### Input | Parameter | Type | Required | Description | @@ -97,4 +108,6 @@ Run a ReAct agent using a self-hosted DSPy ReAct program endpoint for multi-step | `status` | string | Response status from the DSPy server \(success or error\) | | `rawOutput` | json | The complete raw output from the DSPy program \(result.toDict\(\)\) | + + diff --git a/apps/docs/content/docs/integrations/embeddings.mdx b/apps/docs/content/docs/integrations/embeddings.mdx index 45b8e1ede80..db50063f541 100644 --- a/apps/docs/content/docs/integrations/embeddings.mdx +++ b/apps/docs/content/docs/integrations/embeddings.mdx @@ -6,6 +6,8 @@ integration: color: "#7B4DFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} An embedding represents text as a numeric vector. Compare vectors to search by meaning, group related text, or find near-duplicates. @@ -31,7 +33,6 @@ Ollama has no task-type or dimension control in this block. Sim uses the model's Knowledge bases embed separately. Each base fixes an embedding model and vector width at creation from the supported knowledge base catalog. Use this block when a workflow needs to generate vectors itself. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Turn text into embedding vectors for semantic search, clustering, and similarity. Supports OpenAI, OpenRouter, Google Gemini, Cohere, and Mistral embedding models, plus embedding models on a self-hosted Ollama. @@ -42,6 +43,8 @@ Turn text into embedding vectors for semantic search, clustering, and similarity Generate embeddings from text using OpenAI's embedding models + + #### Input | Parameter | Type | Required | Description | @@ -64,10 +67,14 @@ Generate embeddings from text using OpenAI's embedding models | ↳ `prompt_tokens` | number | Tokens in the input | | ↳ `total_tokens` | number | Total tokens billed | + + ### OpenRouter Embeddings Generate embeddings through OpenRouter + + #### Input | Parameter | Type | Required | Description | @@ -90,10 +97,14 @@ Generate embeddings through OpenRouter | ↳ `prompt_tokens` | number | Tokens in the input | | ↳ `total_tokens` | number | Total tokens billed | + + ### Gemini Embeddings Generate embeddings from text using Google's Gemini embedding models + + #### Input | Parameter | Type | Required | Description | @@ -116,10 +127,14 @@ Generate embeddings from text using Google's Gemini embedding models | ↳ `prompt_tokens` | number | Tokens in the input | | ↳ `total_tokens` | number | Total tokens billed | + + ### Cohere Embeddings Generate embeddings from text using Cohere's embedding models + + #### Input | Parameter | Type | Required | Description | @@ -142,10 +157,14 @@ Generate embeddings from text using Cohere's embedding models | ↳ `prompt_tokens` | number | Tokens in the input | | ↳ `total_tokens` | number | Total tokens billed | + + ### Mistral Embeddings Generate embeddings from text using Mistral's embedding models + + #### Input | Parameter | Type | Required | Description | @@ -168,10 +187,14 @@ Generate embeddings from text using Mistral's embedding models | ↳ `prompt_tokens` | number | Tokens in the input | | ↳ `total_tokens` | number | Total tokens billed | + + ### Ollama Embeddings Generate embeddings on a self-hosted Ollama server + + #### Input | Parameter | Type | Required | Description | @@ -191,4 +214,6 @@ Generate embeddings on a self-hosted Ollama server | ↳ `prompt_tokens` | number | Tokens in the input | | ↳ `total_tokens` | number | Total tokens billed | + + diff --git a/apps/docs/content/docs/integrations/enrichment.mdx b/apps/docs/content/docs/integrations/enrichment.mdx index fd851ee233a..2d197d98810 100644 --- a/apps/docs/content/docs/integrations/enrichment.mdx +++ b/apps/docs/content/docs/integrations/enrichment.mdx @@ -6,6 +6,8 @@ integration: color: "#9333EA" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use the built-in Data Enrichment block to fill missing fields such as work email, phone number, company domain, and company information. Select a registered enrichment and map the record's input fields; Sim uses the same ordered provider cascade as table enrichments until a provider returns a match. @@ -13,7 +15,6 @@ Use the built-in Data Enrichment block to fill missing fields such as work email Read the result to determine whether a match was found and which provider supplied it. For example, map a person's name and company into **Work Email** rather than calling each provider separately. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Run a Sim enrichment to look up data — work email, phone number, company domain, company info, and more — from the fields you map in. Uses the same provider cascade as table enrichments. @@ -24,6 +25,8 @@ Run a Sim enrichment to look up data — work email, phone number, company domai Run a Sim enrichment (e.g. Work Email, Phone Number) and return its outputs + + #### Input | Parameter | Type | Required | Description | @@ -38,4 +41,6 @@ Run a Sim enrichment (e.g. Work Email, Phone Number) and return its outputs | `matched` | boolean | Whether the enrichment found a result | | `provider` | string | Provider whose result was returned \(e.g. "Hunter", "People Data Labs"\) | + + diff --git a/apps/docs/content/docs/integrations/enrow.mdx b/apps/docs/content/docs/integrations/enrow.mdx index 837fe2f0ad5..fd537f4af1b 100644 --- a/apps/docs/content/docs/integrations/enrow.mdx +++ b/apps/docs/content/docs/integrations/enrow.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Enrow](https://enrow.io/) to find a professional email from a person's full name and company, or check an existing email's deliverability. Inspect the returned verification result before using the address downstream. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Find verified B2B email addresses from a full name and company, or verify the deliverability of an existing email. Inspect the returned qualification before using an email address. @@ -22,6 +23,8 @@ Find verified B2B email addresses from a full name and company, or verify the de Find a verified B2B email address from a full name and company domain or name. Uses the Enrow async finder — submits a search and polls until the result is ready. Costs 1 credit per valid email found. (https://docs.enrow.io/api-reference/email-finder/find-single) + + #### Input | Parameter | Type | Required | Description | @@ -44,10 +47,14 @@ Find a verified B2B email address from a full name and company domain or name. U | `company_name` | string | Company name associated with the result | | `company_domain` | string | Company domain associated with the result | + + ### Enrow Verify Email Verify the deliverability of an email address using the Enrow async verifier. Submits a verification request and polls until the result is ready. Costs 0.25 credits per verification. (https://docs.enrow.io/api-reference/email-verifier/verify-single) + + #### Input | Parameter | Type | Required | Description | @@ -63,4 +70,6 @@ Verify the deliverability of an email address using the Enrow async verifier. Su | `email` | string | Email address found or verified | | `qualification` | string | Enrow quality result: "valid" or "invalid" | + + diff --git a/apps/docs/content/docs/integrations/exa.mdx b/apps/docs/content/docs/integrations/exa.mdx index 88f75e710fe..0e5c657fc05 100644 --- a/apps/docs/content/docs/integrations/exa.mdx +++ b/apps/docs/content/docs/integrations/exa.mdx @@ -172,6 +172,8 @@ Find webpages similar to a given URL using Exa AI. Deprecated by Exa in favor of Get an AI-generated answer to a question with citations from the web using Exa AI. + + #### Input | Parameter | Type | Required | Description | @@ -195,10 +197,14 @@ Get an AI-generated answer to a question with citations from the web using Exa A | ↳ `publishedDate` | string | Publication date of the cited source | | `requestId` | string | Exa request identifier, useful for support | + + ### Exa Agent Run a deep research task with Exa Agent. Handles multi-step list building, enrichment, and research, returning a written answer with field-level citations and optional structured output. + + #### Input | Parameter | Type | Required | Description | @@ -222,4 +228,6 @@ Run a deep research task with Exa Agent. Handles multi-step list building, enric | `grounding` | json | Field-level citations backing the agent output | | `research` | array | The agent answer in the shape the retired Research operation emitted, so workflows that reference it keep resolving | + + diff --git a/apps/docs/content/docs/integrations/extend.mdx b/apps/docs/content/docs/integrations/extend.mdx index af47769076c..cb54644bdcb 100644 --- a/apps/docs/content/docs/integrations/extend.mdx +++ b/apps/docs/content/docs/integrations/extend.mdx @@ -6,12 +6,13 @@ integration: color: "#000000" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Extend](https://www.extend.ai/) to parse a document supplied as a file or file reference. The result includes structured chunks and block-level elements, the page count, and credits consumed. Pass those outputs to later steps for extraction or document review. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Parse and extract structured content from documents or file references. @@ -22,6 +23,8 @@ Parse and extract structured content from documents or file references. Parse and extract content from documents using Extend AI + + #### Input | Parameter | Type | Required | Description | @@ -43,4 +46,6 @@ Parse and extract content from documents using Extend AI | `pageCount` | number | Number of pages processed | | `creditsUsed` | number | API credits consumed | + + diff --git a/apps/docs/content/docs/integrations/fathom.mdx b/apps/docs/content/docs/integrations/fathom.mdx index 153f55f40c7..2e18443faa4 100644 --- a/apps/docs/content/docs/integrations/fathom.mdx +++ b/apps/docs/content/docs/integrations/fathom.mdx @@ -123,6 +123,8 @@ List recent meetings recorded by the user or shared to their team. List meeting types configured in your Fathom organization. + + #### Input | Parameter | Type | Required | Description | @@ -140,10 +142,14 @@ List meeting types configured in your Fathom organization. | ↳ `created_at` | string | Date the meeting type was created | | `next_cursor` | string | Pagination cursor for next page | + + ### Fathom Get Summary Get the call summary for a specific meeting recording. + + #### Input | Parameter | Type | Required | Description | @@ -158,10 +164,14 @@ Get the call summary for a specific meeting recording. | `template_name` | string | Name of the summary template used | | `markdown_formatted` | string | Markdown-formatted summary text | + + ### Fathom Get Transcript Get the full transcript for a specific meeting recording. + + #### Input | Parameter | Type | Required | Description | @@ -180,10 +190,14 @@ Get the full transcript for a specific meeting recording. | ↳ `text` | string | Transcript text | | ↳ `timestamp` | string | Timestamp \(HH:MM:SS\) | + + ### Fathom List Team Members List team members in your Fathom organization. + + #### Input | Parameter | Type | Required | Description | @@ -202,10 +216,14 @@ List team members in your Fathom organization. | ↳ `created_at` | string | Date the member was added | | `next_cursor` | string | Pagination cursor for next page | + + ### Fathom List Teams List teams in your Fathom organization. + + #### Input | Parameter | Type | Required | Description | @@ -222,6 +240,8 @@ List teams in your Fathom organization. | ↳ `created_at` | string | Date the team was created | | `next_cursor` | string | Pagination cursor for next page | + + ## Triggers diff --git a/apps/docs/content/docs/integrations/fireflies.mdx b/apps/docs/content/docs/integrations/fireflies.mdx index b60330507be..9540c7072c6 100644 --- a/apps/docs/content/docs/integrations/fireflies.mdx +++ b/apps/docs/content/docs/integrations/fireflies.mdx @@ -297,6 +297,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when a Fireflies meeting transcription is complete + + #### Configuration | Parameter | Type | Required | Description | @@ -312,3 +314,5 @@ Trigger workflow when a Fireflies meeting transcription is complete | `clientReferenceId` | string | Custom reference ID if set during upload | | `timestamp` | number | Unix timestamp in milliseconds when the event was fired \(V2 webhooks\) | + + diff --git a/apps/docs/content/docs/integrations/flint.mdx b/apps/docs/content/docs/integrations/flint.mdx index 06c4fa695c8..48f581b7553 100644 --- a/apps/docs/content/docs/integrations/flint.mdx +++ b/apps/docs/content/docs/integrations/flint.mdx @@ -6,12 +6,13 @@ integration: color: "#F6F54F" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Flint](https://www.flint.com/) in Sim to start site changes from a natural-language prompt, generate up to 10 pages from a template, and check task status. Create an API key in your Flint team settings. Leave publishing off when changes need review, then use **Get Task** to collect preview URLs and the list of created, modified, or deleted pages. Poll the task until it finishes and inspect its error if it fails. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Create background agent tasks that modify your Flint sites from natural-language prompts, generate batches of pages from a template, and check task status and results. @@ -22,6 +23,8 @@ Create background agent tasks that modify your Flint sites from natural-language Start a background Flint agent task that modifies a site from a natural-language prompt. + + #### Input | Parameter | Type | Required | Description | @@ -40,10 +43,14 @@ Start a background Flint agent task that modifies a site from a natural-language | `status` | string | Initial task status \(running\) | | `createdAt` | string | ISO 8601 timestamp when the task was created | + + ### Flint Generate Pages Start a background Flint agent task that generates up to 10 pages from a template page. + + #### Input | Parameter | Type | Required | Description | @@ -63,10 +70,14 @@ Start a background Flint agent task that generates up to 10 pages from a templat | `status` | string | Initial task status \(running\) | | `createdAt` | string | ISO 8601 timestamp when the task was created | + + ### Flint Get Task Get the status and results of a background Flint agent task. + + #### Input | Parameter | Type | Required | Description | @@ -85,4 +96,6 @@ Get the status and results of a background Flint agent task. | `pagesDeleted` | array | Pages deleted by the task \(populated when completed\) | | `errorMessage` | string | Error message when the task failed | + + diff --git a/apps/docs/content/docs/integrations/gamma.mdx b/apps/docs/content/docs/integrations/gamma.mdx index aa01e68d077..e47cbfaa8b4 100644 --- a/apps/docs/content/docs/integrations/gamma.mdx +++ b/apps/docs/content/docs/integrations/gamma.mdx @@ -6,12 +6,13 @@ integration: color: "#002253" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Gamma](https://gamma.app/) to generate presentations, documents, webpages, or social posts from text or an existing template. Poll Check Status for asynchronous jobs and use the returned Gamma URL when generation completes. Themes and folders control styling and organization. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Generate presentations, documents, webpages, and social posts from text, create from templates, check generation status, and browse themes and folders. @@ -22,6 +23,8 @@ Generate presentations, documents, webpages, and social posts from text, create Generate a new Gamma presentation, document, webpage, or social post from text input. + + #### Input | Parameter | Type | Required | Description | @@ -51,10 +54,14 @@ Generate a new Gamma presentation, document, webpage, or social post from text i | --------- | ---- | ----------- | | `generationId` | string | The ID of the generation job. Use with Check Status to poll for completion. | + + ### Gamma Generate from Template Generate a new Gamma by adapting an existing template with a prompt. + + #### Input | Parameter | Type | Required | Description | @@ -74,10 +81,14 @@ Generate a new Gamma by adapting an existing template with a prompt. | --------- | ---- | ----------- | | `generationId` | string | The ID of the generation job. Use with Check Status to poll for completion. | + + ### Gamma Check Status Check the status of a Gamma generation job. Returns the gamma URL when completed, or error details if failed. + + #### Input | Parameter | Type | Required | Description | @@ -99,10 +110,14 @@ Check the status of a Gamma generation job. Returns the gamma URL when completed | ↳ `message` | string | Human-readable error message | | ↳ `statusCode` | number | HTTP status code of the error | + + ### Gamma List Themes List available themes in your Gamma workspace. Returns theme IDs, names, and keywords for styling. + + #### Input | Parameter | Type | Required | Description | @@ -125,10 +140,14 @@ List available themes in your Gamma workspace. Returns theme IDs, names, and key | `hasMore` | boolean | Whether more results are available on the next page | | `nextCursor` | string | Pagination cursor to pass as the after parameter for the next page | + + ### Gamma List Folders List available folders in your Gamma workspace. Returns folder IDs and names for organizing generated content. + + #### Input | Parameter | Type | Required | Description | @@ -148,4 +167,6 @@ List available folders in your Gamma workspace. Returns folder IDs and names for | `hasMore` | boolean | Whether more results are available on the next page | | `nextCursor` | string | Pagination cursor to pass as the after parameter for the next page | + + diff --git a/apps/docs/content/docs/integrations/gitlab.mdx b/apps/docs/content/docs/integrations/gitlab.mdx index c65f0df9892..7f88acc2e1b 100644 --- a/apps/docs/content/docs/integrations/gitlab.mdx +++ b/apps/docs/content/docs/integrations/gitlab.mdx @@ -2127,6 +2127,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when a comment is added on a commit, merge request, or issue + + #### Configuration | Parameter | Type | Required | Description | @@ -2157,13 +2159,14 @@ Trigger workflow when a comment is added on a commit, merge request, or issue | ↳ `action` | string | Action \(create, update\) | | ↳ `url` | string | Comment URL | - ---- + ### GitLab Event Trigger workflow from any GitLab webhook event + + #### Configuration | Parameter | Type | Required | Description | @@ -2186,8 +2189,7 @@ Trigger workflow from any GitLab webhook event | ↳ `path_with_namespace` | string | Full path \(namespace/project\) | | `object_attributes` | json | Event-specific attributes \(varies by object_kind\) | - ---- + ### GitLab Issue @@ -2320,6 +2322,8 @@ Trigger workflow when a pipeline status changes in GitLab Trigger workflow when commits are pushed to a GitLab project + + #### Configuration | Parameter | Type | Required | Description | @@ -2350,3 +2354,5 @@ Trigger workflow when commits are pushed to a GitLab project | ↳ `path_with_namespace` | string | Full path \(namespace/project\) | | `commits` | json | Array of commit objects included in this push | + + diff --git a/apps/docs/content/docs/integrations/gmail.mdx b/apps/docs/content/docs/integrations/gmail.mdx index 9457e9ca524..f5928706260 100644 --- a/apps/docs/content/docs/integrations/gmail.mdx +++ b/apps/docs/content/docs/integrations/gmail.mdx @@ -396,6 +396,8 @@ These triggers poll for new data on a schedule. Triggers when new emails are received in Gmail (requires Gmail credentials) + + #### Configuration | Parameter | Type | Required | Description | @@ -426,3 +428,5 @@ Triggers when new emails are received in Gmail (requires Gmail credentials) | ↳ `attachments` | file[] | Array of email attachments as files \(if includeAttachments is enabled\) | | `timestamp` | string | Event timestamp | + + diff --git a/apps/docs/content/docs/integrations/google_ads.mdx b/apps/docs/content/docs/integrations/google_ads.mdx index 47454b2d3a3..284899ef02c 100644 --- a/apps/docs/content/docs/integrations/google_ads.mdx +++ b/apps/docs/content/docs/integrations/google_ads.mdx @@ -45,6 +45,8 @@ Connect to Google Ads to list accessible accounts, list campaigns, view ad group List Google Ads accounts directly accessible by the authenticated user; query customer_client for manager subaccounts + + #### Input | Parameter | Type | Required | Description | @@ -57,10 +59,14 @@ List Google Ads accounts directly accessible by the authenticated user; query cu | `customerIds` | array | Customer IDs directly accessible by the user | | `totalCount` | number | Total number of accessible customer accounts | + + ### Google Ads Search (GAQL) Run a custom Google Ads Query Language (GAQL) query + + #### Input | Parameter | Type | Required | Description | @@ -78,10 +84,14 @@ Run a custom Google Ads Query Language (GAQL) query | `totalResultsCount` | number | Total matching rows ignoring LIMIT, when returned by Google | | `nextPageToken` | string | Token for the next page; keep the same query and customer | + + ### List Google Ads Campaigns List campaigns in a Google Ads account with optional status filtering + + #### Input | Parameter | Type | Required | Description | @@ -107,10 +117,14 @@ List campaigns in a Google Ads account with optional status filtering | ↳ `budgetAmountMicros` | string | Daily budget in micros \(divide by 1,000,000 for currency value\) | | `totalCount` | number | Number of campaigns in this page | + + ### Google Ads Campaign Performance Get performance metrics for Google Ads campaigns over a date range + + #### Input | Parameter | Type | Required | Description | @@ -140,10 +154,14 @@ Get performance metrics for Google Ads campaigns over a date range | ↳ `date` | string | Date for this row \(YYYY-MM-DD\) | | `totalCount` | number | Number of rows in this page | + + ### List Google Ads Ad Groups List ad groups in a Google Ads campaign + + #### Input | Parameter | Type | Required | Description | @@ -169,6 +187,8 @@ List ad groups in a Google Ads campaign | ↳ `campaignName` | string | Parent campaign name | | `totalCount` | number | Number of ad groups in this page | + + ### Google Ads Ad Performance Get performance metrics for individual ads over a date range diff --git a/apps/docs/content/docs/integrations/google_appsheet.mdx b/apps/docs/content/docs/integrations/google_appsheet.mdx index 125e3c18815..261cd4b77ce 100644 --- a/apps/docs/content/docs/integrations/google_appsheet.mdx +++ b/apps/docs/content/docs/integrations/google_appsheet.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Google AppSheet](https://about.appsheet.com/) to find, add, edit, and delete table rows. Use Selector expressions to filter results, and identify existing rows by their key column. @@ -23,7 +25,6 @@ Google AppSheet authenticates with a static Application Access Key rather than O The [AppSheet API requires an Enterprise plan](https://support.google.com/appsheet/answer/10105769?hl=en). An organization policy can prevent app creators from enabling external API access. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Find, add, edit, and delete rows in an AppSheet table using the AppSheet API. Requires an AppSheet Enterprise plan with the API enabled and an Application Access Key. @@ -34,6 +35,8 @@ Find, add, edit, and delete rows in an AppSheet table using the AppSheet API. Re Read rows from an AppSheet table. Omit the selector to return every row, or provide a Selector expression (Filter/Select/OrderBy/Top) to narrow and shape the results. + + #### Input | Parameter | Type | Required | Description | @@ -52,10 +55,14 @@ Read rows from an AppSheet table. Omit the selector to return every row, or prov | `metadata` | json | Operation metadata | | ↳ `rowCount` | number | Number of rows returned | + + ### AppSheet Add Rows Add new rows to an AppSheet table. The key column value must be provided explicitly, or omitted when its Initial value expression generates it automatically (e.g. UNIQUEID()). + + #### Input | Parameter | Type | Required | Description | @@ -74,10 +81,14 @@ Add new rows to an AppSheet table. The key column value must be provided explici | `metadata` | json | Operation metadata | | ↳ `rowCount` | number | Number of rows added | + + ### AppSheet Edit Rows Update existing rows in an AppSheet table. Each row must explicitly include the key column name and value, plus any columns to change. + + #### Input | Parameter | Type | Required | Description | @@ -96,10 +107,14 @@ Update existing rows in an AppSheet table. Each row must explicitly include the | `metadata` | json | Operation metadata | | ↳ `rowCount` | number | Number of rows updated | + + ### AppSheet Delete Rows Delete rows from an AppSheet table. Each row only needs to include the key column name and value. + + #### Input | Parameter | Type | Required | Description | @@ -118,4 +133,6 @@ Delete rows from an AppSheet table. Each row only needs to include the key colum | `metadata` | json | Operation metadata | | ↳ `rowCount` | number | Number of rows deleted | + + diff --git a/apps/docs/content/docs/integrations/google_books.mdx b/apps/docs/content/docs/integrations/google_books.mdx index 103eed9dc49..cc9b73b7d5b 100644 --- a/apps/docs/content/docs/integrations/google_books.mdx +++ b/apps/docs/content/docs/integrations/google_books.mdx @@ -68,6 +68,8 @@ Search for books using the Google Books API Get detailed information about a specific book volume + + #### Input | Parameter | Type | Required | Description | @@ -98,4 +100,6 @@ Get detailed information about a specific book volume | `isbn10` | string | ISBN-10 identifier | | `isbn13` | string | ISBN-13 identifier | + + diff --git a/apps/docs/content/docs/integrations/google_contacts.mdx b/apps/docs/content/docs/integrations/google_contacts.mdx index 8d536b29945..90220a0443a 100644 --- a/apps/docs/content/docs/integrations/google_contacts.mdx +++ b/apps/docs/content/docs/integrations/google_contacts.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [Google Contacts](https://contacts.google.com/) stores contact records for a Google account. Search or list contacts to obtain their resource names, then use those names to read, update, or delete records. Create contacts with the name, email, phone, and other fields needed by your workflow. {/* MANUAL-CONTENT-END */} - ## OAuth scopes [#oauth-scopes] Sim requests these scopes when someone connects a Google Contacts account. For a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations and OAuth](/platform/self-hosting/integrations-oauth) for setup. @@ -37,6 +38,8 @@ Create, read, update, delete, list, and search contacts. Create a new contact in Google Contacts + + #### Input | Parameter | Type | Required | Description | @@ -58,10 +61,14 @@ Create a new contact in Google Contacts | `content` | string | Contact creation confirmation message | | `metadata` | json | Created contact metadata including resource name and details | + + ### Google Contacts Get Get a specific contact from Google Contacts + + #### Input | Parameter | Type | Required | Description | @@ -75,10 +82,14 @@ Get a specific contact from Google Contacts | `content` | string | Contact retrieval confirmation message | | `metadata` | json | Contact details including name, email, phone, and organization | + + ### Google Contacts List List contacts from Google Contacts + + #### Input | Parameter | Type | Required | Description | @@ -94,10 +105,14 @@ List contacts from Google Contacts | `content` | string | Summary of found contacts count | | `metadata` | json | List of contacts with pagination tokens | + + ### Google Contacts Search Search contacts in Google Contacts by name, email, phone, or organization + + #### Input | Parameter | Type | Required | Description | @@ -112,10 +127,14 @@ Search contacts in Google Contacts by name, email, phone, or organization | `content` | string | Summary of search results count | | `metadata` | json | Search results with matching contacts | + + ### Google Contacts Update Update an existing contact in Google Contacts + + #### Input | Parameter | Type | Required | Description | @@ -139,10 +158,14 @@ Update an existing contact in Google Contacts | `content` | string | Contact update confirmation message | | `metadata` | json | Updated contact metadata | + + ### Google Contacts Delete Delete a contact from Google Contacts + + #### Input | Parameter | Type | Required | Description | @@ -156,4 +179,6 @@ Delete a contact from Google Contacts | `content` | string | Contact deletion confirmation message | | `metadata` | json | Deletion details including resource name | + + diff --git a/apps/docs/content/docs/integrations/google_drive.mdx b/apps/docs/content/docs/integrations/google_drive.mdx index ca172a07a7f..f70b5e1c0c0 100644 --- a/apps/docs/content/docs/integrations/google_drive.mdx +++ b/apps/docs/content/docs/integrations/google_drive.mdx @@ -985,6 +985,8 @@ These triggers poll for new data on a schedule. Triggers when files are created, modified, or deleted in Google Drive + + #### Configuration | Parameter | Type | Required | Description | @@ -1015,3 +1017,5 @@ Triggers when files are created, modified, or deleted in Google Drive | `eventType` | string | Change type: "created", "modified", or "deleted" | | `timestamp` | string | Event timestamp in ISO format | + + diff --git a/apps/docs/content/docs/integrations/google_forms.mdx b/apps/docs/content/docs/integrations/google_forms.mdx index cdb9e199a1e..e72ba1e3319 100644 --- a/apps/docs/content/docs/integrations/google_forms.mdx +++ b/apps/docs/content/docs/integrations/google_forms.mdx @@ -315,6 +315,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow from Google Form submissions (via Apps Script forwarder) + + #### Configuration | Parameter | Type | Required | Description | @@ -336,3 +338,5 @@ Trigger workflow from Google Form submissions (via Apps Script forwarder) | `answers` | object | Normalized map of question -> answer | | `raw` | object | Original payload \(when enabled\) | + + diff --git a/apps/docs/content/docs/integrations/google_meet.mdx b/apps/docs/content/docs/integrations/google_meet.mdx index f20cb882302..87a35b8f48d 100644 --- a/apps/docs/content/docs/integrations/google_meet.mdx +++ b/apps/docs/content/docs/integrations/google_meet.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [Google Meet](https://meet.google.com/) provides meeting spaces and conference records. Create or configure a meeting space, inspect participants and past conferences, or end an active conference. Select the space or conference identifier required by the operation. {/* MANUAL-CONTENT-END */} - ## OAuth scopes [#oauth-scopes] Sim requests these scopes when someone connects a Google Meet account. For a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations and OAuth](/platform/self-hosting/integrations-oauth) for setup. @@ -38,6 +39,8 @@ Create meeting spaces, get space details, end conferences, list conference recor Create a new Google Meet meeting space + + #### Input | Parameter | Type | Required | Description | @@ -55,10 +58,14 @@ Create a new Google Meet meeting space | `accessType` | string | Access type configuration | | `entryPointAccess` | string | Entry point access configuration | + + ### Google Meet Get Space Get details of a Google Meet meeting space by name or meeting code + + #### Input | Parameter | Type | Required | Description | @@ -76,10 +83,14 @@ Get details of a Google Meet meeting space by name or meeting code | `entryPointAccess` | string | Entry point access configuration | | `activeConference` | string | Active conference record name | + + ### Google Meet End Conference End the active conference in a Google Meet space + + #### Input | Parameter | Type | Required | Description | @@ -92,10 +103,14 @@ End the active conference in a Google Meet space | --------- | ---- | ----------- | | `ended` | boolean | Whether the conference was ended successfully | + + ### Google Meet List Conference Records List conference records for meetings you organized + + #### Input | Parameter | Type | Required | Description | @@ -111,10 +126,14 @@ List conference records for meetings you organized | `conferenceRecords` | json | List of conference records with name, start/end times, and space | | `nextPageToken` | string | Token for next page of results | + + ### Google Meet Get Conference Record Get details of a specific conference record + + #### Input | Parameter | Type | Required | Description | @@ -131,10 +150,14 @@ Get details of a specific conference record | `expireTime` | string | Conference record expiration time | | `space` | string | Associated space resource name | + + ### Google Meet List Participants List participants of a conference record + + #### Input | Parameter | Type | Required | Description | @@ -152,4 +175,6 @@ List participants of a conference record | `nextPageToken` | string | Token for next page of results | | `totalSize` | number | Total number of participants | + + diff --git a/apps/docs/content/docs/integrations/google_sheets.mdx b/apps/docs/content/docs/integrations/google_sheets.mdx index fd148766dd7..97fa3d0edce 100644 --- a/apps/docs/content/docs/integrations/google_sheets.mdx +++ b/apps/docs/content/docs/integrations/google_sheets.mdx @@ -448,6 +448,8 @@ These triggers poll for new data on a schedule. Triggers when new rows are added to a Google Sheet + + #### Configuration | Parameter | Type | Required | Description | @@ -472,3 +474,5 @@ Triggers when new rows are added to a Google Sheet | `sheetName` | string | The sheet tab name | | `timestamp` | string | Event timestamp in ISO format | + + diff --git a/apps/docs/content/docs/integrations/google_tasks.mdx b/apps/docs/content/docs/integrations/google_tasks.mdx index 3ccfca30a3a..85f987a6465 100644 --- a/apps/docs/content/docs/integrations/google_tasks.mdx +++ b/apps/docs/content/docs/integrations/google_tasks.mdx @@ -38,6 +38,8 @@ Create, read, update, delete, and list tasks and task lists. Create a new task in a Google Tasks list + + #### Input | Parameter | Type | Required | Description | @@ -67,6 +69,8 @@ Create a new task in a Google Tasks list | `completed` | string | Completion date | | `deleted` | boolean | Whether the task is deleted | + + ### Google Tasks List Tasks List all tasks in a Google Tasks list @@ -119,6 +123,8 @@ List all tasks in a Google Tasks list Retrieve a specific task by ID from a Google Tasks list + + #### Input | Parameter | Type | Required | Description | @@ -143,10 +149,14 @@ Retrieve a specific task by ID from a Google Tasks list | `completed` | string | Completion date | | `deleted` | boolean | Whether the task is deleted | + + ### Google Tasks Update Task Update an existing task in a Google Tasks list + + #### Input | Parameter | Type | Required | Description | @@ -175,10 +185,14 @@ Update an existing task in a Google Tasks list | `completed` | string | Completion date | | `deleted` | boolean | Whether the task is deleted | + + ### Google Tasks Delete Task Delete a task from a Google Tasks list + + #### Input | Parameter | Type | Required | Description | @@ -193,10 +207,14 @@ Delete a task from a Google Tasks list | `taskId` | string | Deleted task ID | | `deleted` | boolean | Whether deletion was successful | + + ### Google Tasks List Task Lists Retrieve all task lists for the authenticated user + + #### Input | Parameter | Type | Required | Description | @@ -215,4 +233,6 @@ Retrieve all task lists for the authenticated user | ↳ `selfLink` | string | URL pointing to this task list | | `nextPageToken` | string | Token for retrieving the next page of results | + + diff --git a/apps/docs/content/docs/integrations/google_translate.mdx b/apps/docs/content/docs/integrations/google_translate.mdx index 82e419d6b0e..4c0ae99efc2 100644 --- a/apps/docs/content/docs/integrations/google_translate.mdx +++ b/apps/docs/content/docs/integrations/google_translate.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [Google Cloud Translation](https://cloud.google.com/translate) translates text and detects its source language. Provide text and a target language for translation, or use language detection when the source language is unknown. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Translate and detect languages using the Google Cloud Translation API. Supports auto-detection of the source language. @@ -22,6 +23,8 @@ Translate and detect languages using the Google Cloud Translation API. Supports Translate text between languages using the Google Cloud Translation API. Supports auto-detection of the source language. + + #### Input | Parameter | Type | Required | Description | @@ -39,10 +42,14 @@ Translate text between languages using the Google Cloud Translation API. Support | `translatedText` | string | The translated text | | `detectedSourceLanguage` | string | The detected source language code \(if source was not specified\) | + + ### Google Translate Detect Language Detect the language of text using the Google Cloud Translation API. + + #### Input | Parameter | Type | Required | Description | @@ -57,4 +64,6 @@ Detect the language of text using the Google Cloud Translation API. | `language` | string | The detected language code \(e.g., "en", "es", "fr"\) | | `confidence` | number | Confidence score of the detection | + + diff --git a/apps/docs/content/docs/integrations/granola.mdx b/apps/docs/content/docs/integrations/granola.mdx index bf09496e4aa..483206f7571 100644 --- a/apps/docs/content/docs/integrations/granola.mdx +++ b/apps/docs/content/docs/integrations/granola.mdx @@ -333,6 +333,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow on any Granola note event + + #### Configuration | Parameter | Type | Required | Description | @@ -352,13 +354,14 @@ Trigger workflow on any Granola note event | `changed_fields` | json | Note fields that changed. Present on note.edited events \(currently always \["summary"\]\); null otherwise. | | `payload` | json | Full raw webhook body as delivered by Granola. | - ---- + ### Granola Note Access Granted Trigger workflow when a Granola note is shared with you, directly or via a folder + + #### Configuration | Parameter | Type | Required | Description | @@ -378,13 +381,14 @@ Trigger workflow when a Granola note is shared with you, directly or via a folde | `changed_fields` | json | Note fields that changed. Present on note.edited events \(currently always \["summary"\]\); null otherwise. | | `payload` | json | Full raw webhook body as delivered by Granola. | - ---- + ### Granola Note Edited Trigger workflow when a Granola note summary is edited or regenerated + + #### Configuration | Parameter | Type | Required | Description | @@ -404,13 +408,14 @@ Trigger workflow when a Granola note summary is edited or regenerated | `changed_fields` | json | Note fields that changed. Present on note.edited events \(currently always \["summary"\]\); null otherwise. | | `payload` | json | Full raw webhook body as delivered by Granola. | - ---- + ### Granola Note Generated Trigger workflow when the first AI summary for a Granola note is generated + + #### Configuration | Parameter | Type | Required | Description | @@ -430,3 +435,5 @@ Trigger workflow when the first AI summary for a Granola note is generated | `changed_fields` | json | Note fields that changed. Present on note.edited events \(currently always \["summary"\]\); null otherwise. | | `payload` | json | Full raw webhook body as delivered by Granola. | + + diff --git a/apps/docs/content/docs/integrations/greptile.mdx b/apps/docs/content/docs/integrations/greptile.mdx index 78cbba68830..35a2ecf8f76 100644 --- a/apps/docs/content/docs/integrations/greptile.mdx +++ b/apps/docs/content/docs/integrations/greptile.mdx @@ -6,12 +6,13 @@ integration: color: "#181C1E" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [Greptile](https://www.greptile.com/) searches and answers questions about code repositories. Index a repository and check its status before querying it, then use natural-language questions or code search to retrieve answers and relevant files. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Query and search codebases using natural language with Greptile. Get AI-generated answers about your code, find relevant files, and understand complex codebases. @@ -22,6 +23,8 @@ Query and search codebases using natural language with Greptile. Get AI-generate Query repositories in natural language and get answers with relevant code references. Greptile uses AI to understand your codebase and answer questions. + + #### Input | Parameter | Type | Required | Description | @@ -48,10 +51,14 @@ Query repositories in natural language and get answers with relevant code refere | ↳ `summary` | string | Summary of the code section | | ↳ `distance` | number | Similarity score \(lower = more relevant\) | + + ### Greptile Index Repository Submit a repository to be indexed by Greptile. Indexing must complete before the repository can be queried. Small repos take 3-5 minutes, larger ones can take over an hour. + + #### Input | Parameter | Type | Required | Description | @@ -72,10 +79,14 @@ Submit a repository to be indexed by Greptile. Indexing must complete before the | `statusEndpoint` | string | URL endpoint to check indexing status | | `message` | string | Status message about the indexing operation | + + ### Greptile Repository Status Check the indexing status of a repository. Use this to verify if a repository is ready to be queried or to monitor indexing progress. + + #### Input | Parameter | Type | Required | Description | @@ -100,4 +111,6 @@ Check the indexing status of a repository. Use this to verify if a repository is | `sampleQuestions` | array | Sample questions for the indexed repository | | `sha` | string | Git commit SHA of the indexed version | + + diff --git a/apps/docs/content/docs/integrations/huggingface.mdx b/apps/docs/content/docs/integrations/huggingface.mdx index 9b1695572da..545d678fffa 100644 --- a/apps/docs/content/docs/integrations/huggingface.mdx +++ b/apps/docs/content/docs/integrations/huggingface.mdx @@ -6,12 +6,13 @@ integration: color: "#0B0F19" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Hugging Face](https://huggingface.co/) in Sim to generate text completions with the Hugging Face Inference API. Choose a model and supply the prompt for the workflow step. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Generate completions with the Hugging Face Inference API. @@ -22,6 +23,8 @@ Generate completions with the Hugging Face Inference API. Generate completions using Hugging Face Inference API + + #### Input | Parameter | Type | Required | Description | @@ -47,4 +50,6 @@ Generate completions using Hugging Face Inference API | ↳ `completion_tokens` | number | Number of tokens in the completion | | ↳ `total_tokens` | number | Total number of tokens used | + + diff --git a/apps/docs/content/docs/integrations/hunter.mdx b/apps/docs/content/docs/integrations/hunter.mdx index 31e98a173a8..8def1a85920 100644 --- a/apps/docs/content/docs/integrations/hunter.mdx +++ b/apps/docs/content/docs/integrations/hunter.mdx @@ -23,6 +23,8 @@ Search domains, find email addresses, verify email addresses, discover companies Returns companies matching a set of criteria using Hunter.io AI-powered search. + + #### Input | Parameter | Type | Required | Description | @@ -45,6 +47,8 @@ Returns companies matching a set of criteria using Hunter.io AI-powered search. | ↳ `generic_emails` | number | Count of generic \(role-based\) emails | | ↳ `total_emails` | number | Total emails found for the company | + + ### Hunter Domain Search Returns all the email addresses found using one given domain name, with sources. @@ -185,6 +189,8 @@ Verifies the deliverability of an email address and provides detailed verificati Enriches company data using domain name. + + #### Input | Parameter | Type | Required | Description | @@ -215,6 +221,8 @@ Enriches company data using domain name. | `phone` | string | Company phone number | | `tech` | array | Technologies used by the company | + + ### Hunter Email Count Returns the total number of email addresses found for a domain or company. diff --git a/apps/docs/content/docs/integrations/icypeas.mdx b/apps/docs/content/docs/integrations/icypeas.mdx index 9aabd52db86..e578ba66430 100644 --- a/apps/docs/content/docs/integrations/icypeas.mdx +++ b/apps/docs/content/docs/integrations/icypeas.mdx @@ -6,12 +6,13 @@ integration: color: "#d4d4d4" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Icypeas](https://icypeas.com/) to find a professional email address from a person's name and company domain, or verify an existing address. Results are asynchronous: the integration polls for the result before returning it to the workflow. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Integrate Icypeas to find a professional email address from a name and company domain, or verify whether an existing email is valid and deliverable. Results are returned asynchronously via polling. @@ -22,6 +23,8 @@ Integrate Icypeas to find a professional email address from a name and company d Find a professional email address from a first name, last name, and company domain or name. Submits the search and polls until a result is available. Costs 1 credit per found email (https://www.icypeas.com/pricing). + + #### Input | Parameter | Type | Required | Description | @@ -42,10 +45,14 @@ Find a professional email address from a first name, last name, and company doma | `firstname` | string | Found person's first name | | `lastname` | string | Found person's last name | + + ### Icypeas Verify Email Verify whether an email address is valid and deliverable. Submits the verification and polls until a result is available. Costs 0.1 credit per verification (https://www.icypeas.com/pricing). + + #### Input | Parameter | Type | Required | Description | @@ -63,4 +70,6 @@ Verify whether an email address is valid and deliverable. Submits the verificati | `item` | json | Full raw item object returned by the Icypeas results endpoint | | `valid` | boolean | Whether the email is valid/deliverable \(true for FOUND/DEBITED status\) | + + diff --git a/apps/docs/content/docs/integrations/incidentio.mdx b/apps/docs/content/docs/integrations/incidentio.mdx index 43f95eee63e..5e9f8f96c29 100644 --- a/apps/docs/content/docs/integrations/incidentio.mdx +++ b/apps/docs/content/docs/integrations/incidentio.mdx @@ -2393,6 +2393,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when an alert is created in incident.io + + #### Configuration | Parameter | Type | Required | Description | @@ -2417,13 +2419,14 @@ Trigger workflow when an alert is created in incident.io | `updated_at` | string | ISO 8601 timestamp when the alert was last updated. | | `resolved_at` | string | ISO 8601 timestamp when the alert was resolved, when applicable. | - ---- + ### incident.io Incident Created Trigger workflow when an incident is created in incident.io + + #### Configuration | Parameter | Type | Required | Description | @@ -2452,13 +2455,14 @@ Trigger workflow when an incident is created in incident.io | `previous_status` | json | Previous status object \(status-updated events only; null otherwise\). | | `update_message` | string | Update message accompanying a status change \(status-updated events only; null otherwise\). | - ---- + ### incident.io Incident Status Updated Trigger workflow when an incident's status changes in incident.io + + #### Configuration | Parameter | Type | Required | Description | @@ -2487,13 +2491,14 @@ Trigger workflow when an incident's status changes in incident.io | `previous_status` | json | Previous status object \(status-updated events only; null otherwise\). | | `update_message` | string | Update message accompanying a status change \(status-updated events only; null otherwise\). | - ---- + ### incident.io Incident Updated Trigger workflow when an incident is updated in incident.io + + #### Configuration | Parameter | Type | Required | Description | @@ -2522,3 +2527,5 @@ Trigger workflow when an incident is updated in incident.io | `previous_status` | json | Previous status object \(status-updated events only; null otherwise\). | | `update_message` | string | Update message accompanying a status change \(status-updated events only; null otherwise\). | + + diff --git a/apps/docs/content/docs/integrations/intercom.mdx b/apps/docs/content/docs/integrations/intercom.mdx index cd69ffd8ac8..a5aeb158d97 100644 --- a/apps/docs/content/docs/integrations/intercom.mdx +++ b/apps/docs/content/docs/integrations/intercom.mdx @@ -1207,6 +1207,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when a new lead is created in Intercom + + #### Configuration | Parameter | Type | Required | Description | @@ -1225,13 +1227,14 @@ Trigger workflow when a new lead is created in Intercom | `first_sent_at` | number | Unix timestamp of first delivery attempt | | `data` | json | Event data containing the contact object. Access via data.item for contact details including id, role, email, name, phone, external_id, custom_attributes, location, avatar, tags, companies, and timestamps | - ---- + ### Intercom Conversation Closed Trigger workflow when a conversation is closed in Intercom + + #### Configuration | Parameter | Type | Required | Description | @@ -1250,13 +1253,14 @@ Trigger workflow when a conversation is closed in Intercom | `first_sent_at` | number | Unix timestamp of first delivery attempt | | `data` | json | Event data containing the conversation object. Access via data.item for conversation details including id, state, open, assignee, contacts, conversation_parts, tags, and source | - ---- + ### Intercom Conversation Created Trigger workflow when a new conversation is created in Intercom + + #### Configuration | Parameter | Type | Required | Description | @@ -1275,13 +1279,14 @@ Trigger workflow when a new conversation is created in Intercom | `first_sent_at` | number | Unix timestamp of first delivery attempt | | `data` | json | Event data containing the conversation object. Access via data.item for conversation details including id, state, open, assignee, contacts, conversation_parts, tags, and source | - ---- + ### Intercom Conversation Reply Trigger workflow when someone replies to an Intercom conversation + + #### Configuration | Parameter | Type | Required | Description | @@ -1300,13 +1305,14 @@ Trigger workflow when someone replies to an Intercom conversation | `first_sent_at` | number | Unix timestamp of first delivery attempt | | `data` | json | Event data containing the conversation object. Access via data.item for conversation details including id, state, open, assignee, contacts, conversation_parts, tags, and source | - ---- + ### Intercom User Created Trigger workflow when a new user is created in Intercom + + #### Configuration | Parameter | Type | Required | Description | @@ -1325,13 +1331,14 @@ Trigger workflow when a new user is created in Intercom | `first_sent_at` | number | Unix timestamp of first delivery attempt | | `data` | json | Event data containing the contact object. Access via data.item for contact details including id, role, email, name, phone, external_id, custom_attributes, location, avatar, tags, companies, and timestamps | - ---- + ### Intercom Webhook (All Events) Trigger workflow on any Intercom webhook event + + #### Configuration | Parameter | Type | Required | Description | @@ -1350,3 +1357,5 @@ Trigger workflow on any Intercom webhook event | `first_sent_at` | number | Unix timestamp of first delivery attempt | | `data` | json | Event data containing the affected object. Access via data.item for the resource \(conversation, contact, company, ticket, etc.\) | + + diff --git a/apps/docs/content/docs/integrations/jina.mdx b/apps/docs/content/docs/integrations/jina.mdx index 31cb43eba91..9e2f15758fe 100644 --- a/apps/docs/content/docs/integrations/jina.mdx +++ b/apps/docs/content/docs/integrations/jina.mdx @@ -6,12 +6,13 @@ integration: color: "#333333" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Jina AI](https://jina.ai/) Reader to extract content from a URL, or Search to retrieve web results. Configure the parsing and output-format options for the content your downstream blocks need. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Search the web and get LLM-friendly results, or extract clean content from specific URLs with advanced parsing options. @@ -22,6 +23,8 @@ Search the web and get LLM-friendly results, or extract clean content from speci Extract and process web content into clean, LLM-friendly text using Jina AI Reader. Supports advanced content parsing, link gathering, and multiple output formats with configurable processing options. + + #### Input | Parameter | Type | Required | Description | @@ -49,10 +52,14 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read | `content` | string | The extracted content from the URL, processed into clean, LLM-friendly text | | `tokensUsed` | number | Number of Jina tokens consumed by this request | + + ### Jina Search Search the web and return top 5 results with LLM-friendly content. Each result is automatically processed through Jina Reader API. Supports geographic filtering, site restrictions, and pagination. + + #### Input | Parameter | Type | Required | Description | @@ -83,4 +90,6 @@ Search the web and return top 5 results with LLM-friendly content. Each result i | ↳ `tokens` | number | Number of tokens consumed by this request | | `tokensUsed` | number | Number of Jina tokens consumed by this request | + + diff --git a/apps/docs/content/docs/integrations/jotform.mdx b/apps/docs/content/docs/integrations/jotform.mdx index 5079f3697cb..c8635101e58 100644 --- a/apps/docs/content/docs/integrations/jotform.mdx +++ b/apps/docs/content/docs/integrations/jotform.mdx @@ -1336,6 +1336,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when a Jotform form receives a new submission + + #### Configuration | Parameter | Type | Required | Description | @@ -1358,3 +1360,5 @@ Trigger workflow when a Jotform form receives a new submission | `rawRequest` | json | The submitted form body. Answers are keyed q\{questionId\}_\{slugifiedLabel\} and hold a string, or an object for a multi-part question such as name or address. A file answer instead appears under the plain slugified label as an array of upload URLs, with the chosen filenames under temp_upload. The body also carries form-internal fields such as slug, buildDate, submitSource, and jsExecutionTracker. | | `raw` | json | Complete original webhook payload from Jotform | + + diff --git a/apps/docs/content/docs/integrations/ketch.mdx b/apps/docs/content/docs/integrations/ketch.mdx index 14ca8435e50..2c1262df10a 100644 --- a/apps/docs/content/docs/integrations/ketch.mdx +++ b/apps/docs/content/docs/integrations/ketch.mdx @@ -6,6 +6,8 @@ integration: color: "#9B5CFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Ketch](https://www.ketch.com/) to read or update consent and subscription preferences and submit data-subject rights requests. @@ -13,7 +15,6 @@ Use [Ketch](https://www.ketch.com/) to read or update consent and subscription p Add a Ketch block and provide your organization code, property code, and environment code. The Ketch Web API is a public API — no API key or OAuth credentials are required. Identity is determined by the organization and property codes along with the data subject's identity (e.g., email address). {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Retrieve and update consent preferences, manage subscription topics and controls, and submit data subject rights requests for access, deletion, correction, or processing restriction. @@ -24,6 +25,8 @@ Retrieve and update consent preferences, manage subscription topics and controls Retrieve consent status for a data subject. Returns the current consent preferences for each configured purpose. + + #### Input | Parameter | Type | Required | Description | @@ -44,10 +47,14 @@ Retrieve consent status for a data subject. Returns the current consent preferen | ↳ `legalBasisCode` | string | Legal basis code \(e.g., "consent_optin", "consent_optout", "disclosure", "other"\) | | `vendors` | object | Map of vendor consent statuses | + + ### Ketch Set Consent Update consent preferences for a data subject. Sets the consent status for specified purposes with the appropriate legal basis. + + #### Input | Parameter | Type | Required | Description | @@ -68,10 +75,14 @@ Update consent preferences for a data subject. Sets the consent status for speci | ↳ `allowed` | string | Consent status for the purpose: "granted" or "denied" | | ↳ `legalBasisCode` | string | Legal basis code \(e.g., "consent_optin", "consent_optout", "disclosure", "other"\) | + + ### Ketch Get Subscriptions Retrieve subscription preferences for a data subject. Returns the current subscription topic and control statuses. + + #### Input | Parameter | Type | Required | Description | @@ -88,10 +99,14 @@ Retrieve subscription preferences for a data subject. Returns the current subscr | `topics` | object | Map of topic codes to contact method settings \(e.g., \{"newsletter": \{"email": \{"status": "granted"\}\}\}\) | | `controls` | object | Map of control codes to settings \(e.g., \{"global_unsubscribe": \{"status": "denied"\}\}\) | + + ### Ketch Set Subscriptions Update subscription preferences for a data subject. Sets topic and control statuses for email, SMS, and other contact methods. + + #### Input | Parameter | Type | Required | Description | @@ -109,10 +124,14 @@ Update subscription preferences for a data subject. Sets topic and control statu | --------- | ---- | ----------- | | `success` | boolean | Whether the subscription preferences were updated | + + ### Ketch Invoke Right Submit a data subject rights request (e.g., access, delete, correct, restrict processing). Initiates a privacy rights workflow in Ketch. + + #### Input | Parameter | Type | Required | Description | @@ -132,4 +151,6 @@ Submit a data subject rights request (e.g., access, delete, correct, restrict pr | `success` | boolean | Whether the rights request was submitted | | `message` | string | Response message from Ketch | + + diff --git a/apps/docs/content/docs/integrations/langsmith.mdx b/apps/docs/content/docs/integrations/langsmith.mdx index 93f69870a5e..9424423025c 100644 --- a/apps/docs/content/docs/integrations/langsmith.mdx +++ b/apps/docs/content/docs/integrations/langsmith.mdx @@ -62,6 +62,8 @@ Forward a single run to LangSmith for ingestion. Forward multiple runs to LangSmith in a single batch. + + #### Input | Parameter | Type | Required | Description | @@ -79,10 +81,14 @@ Forward multiple runs to LangSmith in a single batch. | `message` | string | Response message from LangSmith | | `messages` | array | Per-run response messages, when provided | + + ### LangSmith Update Run Patch an existing LangSmith run with outputs, status, or timing once it completes. + + #### Input | Parameter | Type | Required | Description | @@ -102,10 +108,14 @@ Patch an existing LangSmith run with outputs, status, or timing once it complete No output fields are documented for this action. + + ### LangSmith Get Run Retrieve a single LangSmith run by ID. + + #### Input | Parameter | Type | Required | Description | @@ -134,10 +144,14 @@ Retrieve a single LangSmith run by ID. | `totalTokens` | number | Total tokens consumed by the run | | `totalCost` | string | Total cost of the run | + + ### LangSmith Create Feedback Attach a score, correction, or comment to a LangSmith run. + + #### Input | Parameter | Type | Required | Description | @@ -163,4 +177,6 @@ Attach a score, correction, or comment to a LangSmith run. | `comment` | string | Comment recorded for the feedback | | `createdAt` | string | When the feedback was created \(ISO\) | + + diff --git a/apps/docs/content/docs/integrations/latex.mdx b/apps/docs/content/docs/integrations/latex.mdx index 41ee909f15e..e432a0eaa7a 100644 --- a/apps/docs/content/docs/integrations/latex.mdx +++ b/apps/docs/content/docs/integrations/latex.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [LaTeX](https://www.latex-project.org/) compiles plain-text document source into PDFs. Provide the source, select a compiler, and attach any required images, included files, or bibliographies. You can also inspect the available TeX Live packages and system fonts. No OAuth connection or API key is required. @@ -13,7 +15,6 @@ integration: Note: compilation runs on the public [LaTeX-on-HTTP](https://github.com/YtoTech/latex-on-http) service at latex.ytotech.com, so the document source and any attached resources are sent to that third-party service. Avoid compiling documents whose contents must not leave your environment. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Compiles LaTeX source into a PDF file with pdflatex, xelatex, lualatex, platex, uplatex, or context, and supports additional resources such as images, included .tex files, and bibliographies. Can also look up the TeX Live packages and system fonts available to the compiler. Does not require OAuth or an API key. Compilation runs on the public LaTeX-on-HTTP service (latex.ytotech.com), so document source and resources are sent to that third-party service. @@ -24,6 +25,8 @@ Compiles LaTeX source into a PDF file with pdflatex, xelatex, lualatex, platex, Compile a LaTeX document into a PDF via the public LaTeX-on-HTTP service (latex.ytotech.com). Supports pdflatex, xelatex, lualatex, platex, uplatex, and context, plus supporting resources such as images, included .tex files, and bibliographies. + + #### Input | Parameter | Type | Required | Description | @@ -42,10 +45,14 @@ Compile a LaTeX document into a PDF via the public LaTeX-on-HTTP service (latex. | `fileName` | string | Name of the compiled PDF file | | `compiler` | string | LaTeX compiler used for the build | + + ### LaTeX Search Packages Search the TeX Live packages available to the LaTeX compiler by name or description, e.g. to check which packages can be used in a document. + + #### Input | Parameter | Type | Required | Description | @@ -64,10 +71,14 @@ Search the TeX Live packages available to the LaTeX compiler by name or descript | ↳ `ctanUrl` | string | CTAN page for the package | | `totalMatches` | number | Total number of packages matching the query, before truncation | + + ### LaTeX Get Package Get details about a specific TeX Live package available to the LaTeX compiler, including whether it is installed, its description, license, and related packages. + + #### Input | Parameter | Type | Required | Description | @@ -90,10 +101,14 @@ Get details about a specific TeX Live package available to the LaTeX compiler, i | ↳ `homepage` | string | Package homepage URL | | ↳ `ctanUrl` | string | CTAN page for the package | + + ### LaTeX List Fonts List the system fonts available to the LaTeX compiler, optionally filtered by name, e.g. to pick a font for xelatex or lualatex documents using fontspec. + + #### Input | Parameter | Type | Required | Description | @@ -111,4 +126,6 @@ List the system fonts available to the LaTeX compiler, optionally filtered by na | ↳ `styles` | array | Available styles, e.g. Bold or Italic | | `totalMatches` | number | Total number of fonts matching the filter, before truncation | + + diff --git a/apps/docs/content/docs/integrations/lemlist.mdx b/apps/docs/content/docs/integrations/lemlist.mdx index de6e54986fb..b6477687b85 100644 --- a/apps/docs/content/docs/integrations/lemlist.mdx +++ b/apps/docs/content/docs/integrations/lemlist.mdx @@ -15,7 +15,6 @@ Use [Lemlist](https://lemlist.com) to retrieve campaign activities and replies, Triggers can start workflows from Lemlist activity events. Use activity data to summarize campaign performance, sync replies to a CRM, or decide which leads need follow-up. The block does not expose campaign creation or multi-channel sequence management. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Retrieve campaign activities and replies, get lead information, and send emails through the Lemlist inbox. @@ -26,6 +25,8 @@ Retrieve campaign activities and replies, get lead information, and send emails Retrieves campaign activities and steps performed, including email opens, clicks, replies, and other events. + + #### Input | Parameter | Type | Required | Description | @@ -52,10 +53,14 @@ Retrieves campaign activities and steps performed, including email opens, clicks | ↳ `createdAt` | string | When the activity occurred | | `count` | number | Number of activities returned | + + ### Lemlist Get Lead Retrieves lead information by email address or lead ID. + + #### Input | Parameter | Type | Required | Description | @@ -79,10 +84,14 @@ Retrieves lead information by email address or lead ID. | `contactId` | string | Contact ID | | `emailStatus` | string | Email deliverability status | + + ### Lemlist Send Email Sends an email to a contact through the Lemlist inbox. + + #### Input | Parameter | Type | Required | Description | @@ -103,6 +112,8 @@ Sends an email to a contact through the Lemlist inbox. | --------- | ---- | ----------- | | `ok` | boolean | Whether the email was sent successfully | + + ## Triggers diff --git a/apps/docs/content/docs/integrations/linkedin.mdx b/apps/docs/content/docs/integrations/linkedin.mdx index 41c39fb0108..40e12795d5a 100644 --- a/apps/docs/content/docs/integrations/linkedin.mdx +++ b/apps/docs/content/docs/integrations/linkedin.mdx @@ -6,12 +6,13 @@ integration: color: "#0072B1" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [LinkedIn](https://www.linkedin.com) to publish to your personal feed and retrieve your profile information from a workflow. {/* MANUAL-CONTENT-END */} - ## OAuth scopes [#oauth-scopes] Sim requests these scopes when someone connects a LinkedIn account. For a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations and OAuth](/platform/self-hosting/integrations-oauth) for setup. @@ -38,6 +39,8 @@ Share posts to your personal feed and access your LinkedIn profile information. Share a post to your personal LinkedIn feed + + #### Input | Parameter | Type | Required | Description | @@ -54,10 +57,14 @@ Share a post to your personal LinkedIn feed | `profile` | json | LinkedIn profile information | | `error` | string | Error message if operation failed | + + ### Get LinkedIn Profile Retrieve your LinkedIn profile information + + #### Input | Parameter | Type | Required | Description | @@ -72,4 +79,6 @@ Retrieve your LinkedIn profile information | `profile` | json | LinkedIn profile information | | `error` | string | Error message if operation failed | + + diff --git a/apps/docs/content/docs/integrations/linkup.mdx b/apps/docs/content/docs/integrations/linkup.mdx index 6c85519c93f..336b6427b6f 100644 --- a/apps/docs/content/docs/integrations/linkup.mdx +++ b/apps/docs/content/docs/integrations/linkup.mdx @@ -6,6 +6,8 @@ integration: color: "#D6D3C7" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Linkup](https://linkup.so) to search the web from a workflow or an agent's tool set. Choose the supported search depth and output type for your query; results can include source URLs for downstream citation. @@ -13,7 +15,6 @@ Use [Linkup](https://linkup.so) to search the web from a workflow or an agent's Supply your Linkup API key and query in the block. When using it as an agent tool, the agent decides when to call it based on its instructions. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Search the web with a Linkup API key, query, supported search depth, and output type. @@ -24,6 +25,8 @@ Search the web with a Linkup API key, query, supported search depth, and output Search the web for information using Linkup + + #### Input | Parameter | Type | Required | Description | @@ -47,4 +50,6 @@ Search the web for information using Linkup | `answer` | string | The sourced answer to the search query | | `sources` | array | Array of sources used to compile the answer, each containing name, url, and snippet | + + diff --git a/apps/docs/content/docs/integrations/linq.mdx b/apps/docs/content/docs/integrations/linq.mdx index 43dce8c689d..e47fbd52339 100644 --- a/apps/docs/content/docs/integrations/linq.mdx +++ b/apps/docs/content/docs/integrations/linq.mdx @@ -915,6 +915,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when a message is delivered + + #### Configuration | Parameter | Type | Required | Description | @@ -932,13 +934,14 @@ Trigger workflow when a message is delivered | `webhookVersion` | string | Payload schema version of the delivered event | | `data` | json | Full event payload \(shape varies by event type — message, reaction, chat, etc.\) | - ---- + ### Linq Message Failed Trigger workflow when a message fails to deliver + + #### Configuration | Parameter | Type | Required | Description | @@ -956,13 +959,14 @@ Trigger workflow when a message fails to deliver | `webhookVersion` | string | Payload schema version of the delivered event | | `data` | json | Full event payload \(shape varies by event type — message, reaction, chat, etc.\) | - ---- + ### Linq Message Read Trigger workflow when a message is read + + #### Configuration | Parameter | Type | Required | Description | @@ -980,13 +984,14 @@ Trigger workflow when a message is read | `webhookVersion` | string | Payload schema version of the delivered event | | `data` | json | Full event payload \(shape varies by event type — message, reaction, chat, etc.\) | - ---- + ### Linq Message Received Trigger workflow when an inbound message is received + + #### Configuration | Parameter | Type | Required | Description | @@ -1004,13 +1009,14 @@ Trigger workflow when an inbound message is received | `webhookVersion` | string | Payload schema version of the delivered event | | `data` | json | Full event payload \(shape varies by event type — message, reaction, chat, etc.\) | - ---- + ### Linq Reaction Added Trigger workflow when a reaction is added to a message + + #### Configuration | Parameter | Type | Required | Description | @@ -1028,13 +1034,14 @@ Trigger workflow when a reaction is added to a message | `webhookVersion` | string | Payload schema version of the delivered event | | `data` | json | Full event payload \(shape varies by event type — message, reaction, chat, etc.\) | - ---- + ### Linq Webhook (All Events) Trigger on any Linq webhook event (messages, reactions, chats, and more) + + #### Configuration | Parameter | Type | Required | Description | @@ -1052,3 +1059,5 @@ Trigger on any Linq webhook event (messages, reactions, chats, and more) | `webhookVersion` | string | Payload schema version of the delivered event | | `data` | json | Full event payload \(shape varies by event type — message, reaction, chat, etc.\) | + + diff --git a/apps/docs/content/docs/integrations/logfire.mdx b/apps/docs/content/docs/integrations/logfire.mdx index aa7f669a350..6c6b3a0b056 100644 --- a/apps/docs/content/docs/integrations/logfire.mdx +++ b/apps/docs/content/docs/integrations/logfire.mdx @@ -27,6 +27,8 @@ Run SQL over your observability data, search spans and logs with structured filt Run a read-only SQL query against Logfire traces, logs, and metrics. Reads the records and metrics tables using PostgreSQL-compatible syntax. + + #### Input | Parameter | Type | Required | Description | @@ -52,6 +54,8 @@ Run a read-only SQL query against Logfire traces, logs, and metrics. Reads the r | ↳ `nullable` | boolean | Whether the column is nullable | | `rowCount` | number | Number of rows returned | + + ### Logfire Search Records Search Logfire spans and logs using structured filters for message text, service, span name, severity, environment, and exceptions. Returns the most recent matches first without writing SQL. @@ -147,6 +151,8 @@ Fetch every span and log belonging to a Logfire trace, ordered from earliest to Resolve which Logfire organization and project a read token belongs to. Useful for confirming a credential targets the expected project before querying it. + + #### Input | Parameter | Type | Required | Description | @@ -164,4 +170,6 @@ Resolve which Logfire organization and project a read token belongs to. Useful f | `expiresAt` | string | When the read token expires. Null when it never expires. | | `spendingCapReachedAt` | string | When the organization's spending cap was reached, which stops queries. Null when it has not been reached. | + + diff --git a/apps/docs/content/docs/integrations/logrocket.mdx b/apps/docs/content/docs/integrations/logrocket.mdx index 6c5b7273537..23cfb74e7c7 100644 --- a/apps/docs/content/docs/integrations/logrocket.mdx +++ b/apps/docs/content/docs/integrations/logrocket.mdx @@ -6,6 +6,8 @@ integration: color: "#764ABC" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [LogRocket](https://logrocket.com/) to request Galileo Highlights for a user's sessions, update user names, emails, and traits, retrieve JSON Lines export URLs, inspect the session-access audit log, and register releases for source-map decoding. @@ -15,7 +17,6 @@ Use [LogRocket](https://logrocket.com/) to request Galileo Highlights for a user For session, issue, and metric queries beyond this block, inspect LogRocket's [MCP server](https://docs.logrocket.com/docs/mcp) at `https://mcp.logrocket.com/mcp` and add it as a separate MCP connection in Sim. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Request AI session highlights for a user, poll for the result, list exported session files, read the audit log, create or update user profiles, and register releases so source maps decode their stack traces. @@ -26,6 +27,8 @@ Request AI session highlights for a user, poll for the result, list exported ses Start a Galileo session highlights job for a user. Returns a request ID to poll with LogRocket's Get Highlights operation. + + #### Input | Parameter | Type | Required | Description | @@ -47,10 +50,14 @@ Start a Galileo session highlights job for a user. Returns a request ID to poll | --------- | ---- | ----------- | | `id` | string | Request ID used to retrieve the highlights result | + + ### LogRocket Get Highlights Retrieve the result of a Galileo session highlights request. Status is PENDING until generation finishes, then READY or FAILED. + + #### Input | Parameter | Type | Required | Description | @@ -74,10 +81,14 @@ Retrieve the result of a Galileo session highlights request. Status is PENDING u | ↳ `sessionID` | number | Session number within the recording | | ↳ `highlights` | string | Highlights for this session | + + ### LogRocket List Exported Sessions List exported session files from the LogRocket Data Export API. Returns download URLs for JSON Lines exports, oldest first, plus a cursor for the next page. + + #### Input | Parameter | Type | Required | Description | @@ -98,10 +109,14 @@ List exported session files from the LogRocket Data Export API. Returns download | ↳ `url` | string | Download URL for the JSON Lines export file | | `cursor` | string | Opaque cursor for the next page of results | + + ### LogRocket Get Audit Logs Export audit log entries from LogRocket, recording who viewed sessions and what actions were taken. Paginated with a cursor. + + #### Input | Parameter | Type | Required | Description | @@ -126,10 +141,14 @@ Export audit log entries from LogRocket, recording who viewed sessions and what | `cursor` | string | Opaque cursor for the next page of results | | `hasNext` | boolean | Whether more audit logs exist beyond this page | + + ### LogRocket Identify User Create or update a LogRocket user profile with demographic, financial, and engagement traits. + + #### Input | Parameter | Type | Required | Description | @@ -153,10 +172,14 @@ Create or update a LogRocket user profile with demographic, financial, and engag | `email` | string | Email stored on the profile | | `traits` | json | Custom traits stored on the profile, with every value coerced to a string | + + ### LogRocket Create Release Register a release version in LogRocket so uploaded source maps can decode stack traces for it. Fails with a conflict if the version already exists. + + #### Input | Parameter | Type | Required | Description | @@ -173,4 +196,6 @@ Register a release version in LogRocket so uploaded source maps can decode stack | --------- | ---- | ----------- | | `version` | string | Release version that was registered | + + diff --git a/apps/docs/content/docs/integrations/logs.mdx b/apps/docs/content/docs/integrations/logs.mdx index d9f9ca40b01..6056fcc8838 100644 --- a/apps/docs/content/docs/integrations/logs.mdx +++ b/apps/docs/content/docs/integrations/logs.mdx @@ -6,12 +6,13 @@ integration: color: "#EAB308" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} The Logs block queries workflow run history in the current workspace. **Query Logs** filters runs and returns matching run IDs; **Get Run Details** retrieves one run’s status, trigger, timing, cost, final output, and trace spans. See [Using Logs in Workflows](/workflows/blocks/logs) for a query-and-inspect example. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Query workflow run logs in the current workspace with the same filters as the Logs page, returning matching run IDs. Fetch full details for a single run, including its trace spans. @@ -22,6 +23,8 @@ Query workflow run logs in the current workspace with the same filters as the Lo Query workflow run logs in the current workspace with the full Logs-page filter set. Returns matching run IDs. + + #### Input | Parameter | Type | Required | Description | @@ -47,10 +50,14 @@ Query workflow run logs in the current workspace with the full Logs-page filter | --------- | ---- | ----------- | | `runIds` | array | IDs of the runs matching the filters | + + ### Get Run Details Fetch details for a single workflow run by its run ID, including the full trace spans. + + #### Input | Parameter | Type | Required | Description | @@ -72,4 +79,6 @@ Fetch details for a single workflow run by its run ID, including the full trace | `traceSpans` | array | Full trace spans for the run | | `finalOutput` | json | Final output of the run | + + diff --git a/apps/docs/content/docs/integrations/mem0.mdx b/apps/docs/content/docs/integrations/mem0.mdx index e87b624af1f..74e3aebe6da 100644 --- a/apps/docs/content/docs/integrations/mem0.mdx +++ b/apps/docs/content/docs/integrations/mem0.mdx @@ -23,6 +23,8 @@ Add, search, and retrieve memories. Add memories to Mem0 for persistent storage and retrieval + + #### Input | Parameter | Type | Required | Description | @@ -39,10 +41,14 @@ Add memories to Mem0 for persistent storage and retrieval | `status` | string | Processing status returned by Mem0 | | `event_id` | string | Event ID for polling memory processing status | + + ### Search Memories Search for memories in Mem0 using semantic search + + #### Input | Parameter | Type | Required | Description | @@ -71,6 +77,8 @@ Search for memories in Mem0 using semantic search | ↳ `score` | number | Similarity score from vector search | | `ids` | array | Array of memory IDs found in the search results | + + ### Get Memories Retrieve memories from Mem0 by ID or filter criteria diff --git a/apps/docs/content/docs/integrations/memory.mdx b/apps/docs/content/docs/integrations/memory.mdx index 3d2cdb3ed8c..c26546766d3 100644 --- a/apps/docs/content/docs/integrations/memory.mdx +++ b/apps/docs/content/docs/integrations/memory.mdx @@ -6,12 +6,13 @@ integration: color: "#F64F9E" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use the Memory block to store and retrieve messages across workflow runs. Add messages with the same conversation identifier to append to an existing conversation, retrieve one conversation or all memories, and delete memories that are no longer needed. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Add, get a memory, get all memories, and delete memories. @@ -22,6 +23,8 @@ Add, get a memory, get all memories, and delete memories. Add a new memory to the database or append to existing memory with the same ID. + + #### Input | Parameter | Type | Required | Description | @@ -39,10 +42,14 @@ Add a new memory to the database or append to existing memory with the same ID. | `memories` | array | Array of memory objects including the new or updated memory | | `error` | string | Error message if operation failed | + + ### Get Memory Retrieve memory by conversationId. Returns matching memories. + + #### Input | Parameter | Type | Required | Description | @@ -59,10 +66,14 @@ Retrieve memory by conversationId. Returns matching memories. | `message` | string | Success or error message | | `error` | string | Error message if operation failed | + + ### Get All Memories Retrieve all memories from the database + + #### Input | Parameter | Type | Required | Description | @@ -77,10 +88,14 @@ Retrieve all memories from the database | `message` | string | Success or error message | | `error` | string | Error message if operation failed | + + ### Delete Memory Delete memories by conversationId. + + #### Input | Parameter | Type | Required | Description | @@ -96,4 +111,6 @@ Delete memories by conversationId. | `message` | string | Success or error message | | `error` | string | Error message if operation failed | + + diff --git a/apps/docs/content/docs/integrations/microsoft_teams.mdx b/apps/docs/content/docs/integrations/microsoft_teams.mdx index a18e58327e4..7b5cc1f9aee 100644 --- a/apps/docs/content/docs/integrations/microsoft_teams.mdx +++ b/apps/docs/content/docs/integrations/microsoft_teams.mdx @@ -577,6 +577,8 @@ Trigger workflows when the outgoing webhook is @mentioned in a Microsoft Teams c Trigger workflows from Microsoft Teams chat message notifications via Microsoft Graph subscriptions. Notifications share a seven-day deduplication window keyed by subscription and message ID, so later edits may not start a separate run. + + #### Configuration | Parameter | Type | Required | Description | @@ -596,3 +598,5 @@ Trigger workflows from Microsoft Teams chat message notifications via Microsoft | `created_at` | string | Message timestamp | | `attachments` | file[] | Uploaded attachments as files | + + diff --git a/apps/docs/content/docs/integrations/millionverifier.mdx b/apps/docs/content/docs/integrations/millionverifier.mdx index 58eddfa02b3..ced7af74ddd 100644 --- a/apps/docs/content/docs/integrations/millionverifier.mdx +++ b/apps/docs/content/docs/integrations/millionverifier.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use MillionVerifier to verify an email and check remaining verification credits. Results classify the address as ok, catch-all, unknown, invalid, disposable, or unverified, with role-account and free-provider flags. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Integrate MillionVerifier to verify email deliverability in real time — classify addresses as valid, invalid, catch-all, disposable, or unknown — and check your remaining verification credits. @@ -22,6 +23,8 @@ Integrate MillionVerifier to verify email deliverability in real time — classi Verify the deliverability of an email address. Uses one verification credit. + + #### Input | Parameter | Type | Required | Description | @@ -41,10 +44,14 @@ Verify the deliverability of an email address. Uses one verification credit. | `didYouMean` | string | Suggested correction for a likely typo | | `subResult` | string | Additional MillionVerifier classification detail | + + ### MillionVerifier Get Credits Retrieve the remaining verification credits for the authenticated account. + + #### Input | Parameter | Type | Required | Description | @@ -57,4 +64,6 @@ Retrieve the remaining verification credits for the authenticated account. | --------- | ---- | ----------- | | `credits` | number | Remaining verification credits | + + diff --git a/apps/docs/content/docs/integrations/modal.mdx b/apps/docs/content/docs/integrations/modal.mdx index 1d129716526..d92ee07274c 100644 --- a/apps/docs/content/docs/integrations/modal.mdx +++ b/apps/docs/content/docs/integrations/modal.mdx @@ -6,6 +6,8 @@ integration: color: "#000000" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Modal](https://modal.com/) to call a deployed Web Function or Server over HTTPS, generate chat completions from a model served on a Modal Endpoint, or list available models. @@ -13,7 +15,6 @@ Use [Modal](https://modal.com/) to call a deployed Web Function or Server over H Create a proxy auth token in the Modal workspace settings and provide its token ID and secret. The endpoint or function must already be deployed; the block invokes it rather than provisioning compute. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Invoke a deployed Web Function or Server over HTTPS with proxy-token auth, generate completions from a model served by a Modal Endpoint, and list the models a token can reach. @@ -24,6 +25,8 @@ Invoke a deployed Web Function or Server over HTTPS with proxy-token auth, gener Invoke a deployed Modal Web Function or Server over HTTPS + + #### Input | Parameter | Type | Required | Description | @@ -44,10 +47,14 @@ Invoke a deployed Modal Web Function or Server over HTTPS | `status` | number | HTTP status code of the response | | `headers` | json | Response headers as key-value pairs | + + ### Modal Chat Completion Generate a chat completion from a model served by a Modal Endpoint + + #### Input | Parameter | Type | Required | Description | @@ -74,10 +81,14 @@ Generate a chat completion from a model served by a Modal Endpoint | ↳ `completion_tokens` | number | Number of tokens in the completion | | ↳ `total_tokens` | number | Total number of tokens used | + + ### Modal List Models List the model IDs a Modal proxy token can reach on an endpoint + + #### Input | Parameter | Type | Required | Description | @@ -93,4 +104,6 @@ List the model IDs a Modal proxy token can reach on an endpoint | `models` | array | Models the token can reach on the endpoint | | `count` | number | Number of models returned | + + diff --git a/apps/docs/content/docs/integrations/mongodb.mdx b/apps/docs/content/docs/integrations/mongodb.mdx index 01dcdb6d5a2..3317de7a94e 100644 --- a/apps/docs/content/docs/integrations/mongodb.mdx +++ b/apps/docs/content/docs/integrations/mongodb.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [MongoDB](https://www.mongodb.com/) to query collections, insert one or more documents, update or delete documents selected by a filter, and run aggregation pipelines. Configure the database connection and collection for the selected operation. @@ -13,7 +15,6 @@ Use [MongoDB](https://www.mongodb.com/) to query collections, insert one or more The `mongodb_query`, `mongodb_insert`, `mongodb_update`, `mongodb_delete`, and `mongodb_execute` operations return data for later workflow steps. Check the write filter and single/multiple-document option before updating or deleting records. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Find, insert, update, delete, and aggregate data. @@ -24,6 +25,8 @@ Find, insert, update, delete, and aggregate data. Execute find operation on MongoDB collection + + #### Input | Parameter | Type | Required | Description | @@ -48,10 +51,14 @@ Execute find operation on MongoDB collection | `documents` | array | Array of documents returned from the query | | `documentCount` | number | Number of documents returned | + + ### MongoDB Insert Insert documents into MongoDB collection + + #### Input | Parameter | Type | Required | Description | @@ -75,10 +82,14 @@ Insert documents into MongoDB collection | `insertedId` | string | ID of inserted document \(single insert\) | | `insertedIds` | array | Array of inserted document IDs \(multiple insert\) | + + ### MongoDB Update Update documents in MongoDB collection + + #### Input | Parameter | Type | Required | Description | @@ -106,10 +117,14 @@ Update documents in MongoDB collection | `documentCount` | number | Total number of documents affected | | `insertedId` | string | ID of inserted document \(if upsert\) | + + ### MongoDB Delete Delete documents from MongoDB collection + + #### Input | Parameter | Type | Required | Description | @@ -133,10 +148,14 @@ Delete documents from MongoDB collection | `deletedCount` | number | Number of documents deleted | | `documentCount` | number | Total number of documents affected | + + ### MongoDB Execute Execute MongoDB aggregation pipeline + + #### Input | Parameter | Type | Required | Description | @@ -159,10 +178,14 @@ Execute MongoDB aggregation pipeline | `documents` | array | Array of documents returned from aggregation | | `documentCount` | number | Number of documents returned | + + ### MongoDB Introspect Introspect MongoDB database to list databases, collections, and indexes + + #### Input | Parameter | Type | Required | Description | @@ -183,4 +206,6 @@ Introspect MongoDB database to list databases, collections, and indexes | `databases` | array | Array of database names | | `collections` | array | Array of collection info with name, type, document count, and indexes | + + diff --git a/apps/docs/content/docs/integrations/mssql.mdx b/apps/docs/content/docs/integrations/mssql.mdx index 9c600ba7c7f..4ddf6d463d4 100644 --- a/apps/docs/content/docs/integrations/mssql.mdx +++ b/apps/docs/content/docs/integrations/mssql.mdx @@ -23,6 +23,8 @@ Query, insert, update, delete, execute raw T-SQL, and introspect schemas. Execute a SELECT query on a Microsoft SQL Server database + + #### Input | Parameter | Type | Required | Description | @@ -47,10 +49,14 @@ Execute a SELECT query on a Microsoft SQL Server database | `truncated` | boolean | Present and true only when rows were dropped to stay inside the response ceilings. Absent means the recordset is complete | | `truncationReason` | string | Which ceiling was hit and how to read the remaining rows | + + ### Microsoft SQL Server Insert Insert data into a Microsoft SQL Server table + + #### Input | Parameter | Type | Required | Description | @@ -76,10 +82,14 @@ Insert data into a Microsoft SQL Server table | `truncated` | boolean | Present and true only when rows were dropped to stay inside the response ceilings. Absent means the recordset is complete | | `truncationReason` | string | Which ceiling was hit and how to read the remaining rows | + + ### Microsoft SQL Server Update Update rows in a Microsoft SQL Server table + + #### Input | Parameter | Type | Required | Description | @@ -106,10 +116,14 @@ Update rows in a Microsoft SQL Server table | `truncated` | boolean | Present and true only when rows were dropped to stay inside the response ceilings. Absent means the recordset is complete | | `truncationReason` | string | Which ceiling was hit and how to read the remaining rows | + + ### Microsoft SQL Server Delete Delete rows from a Microsoft SQL Server table + + #### Input | Parameter | Type | Required | Description | @@ -135,10 +149,14 @@ Delete rows from a Microsoft SQL Server table | `truncated` | boolean | Present and true only when rows were dropped to stay inside the response ceilings. Absent means the recordset is complete | | `truncationReason` | string | Which ceiling was hit and how to read the remaining rows | + + ### Microsoft SQL Server Execute Execute a raw T-SQL statement on a Microsoft SQL Server database + + #### Input | Parameter | Type | Required | Description | @@ -163,6 +181,8 @@ Execute a raw T-SQL statement on a Microsoft SQL Server database | `truncated` | boolean | Present and true only when rows were dropped to stay inside the response ceilings. Absent means the recordset is complete | | `truncationReason` | string | Which ceiling was hit and how to read the remaining rows | + + ### Microsoft SQL Server Introspect Introspect a Microsoft SQL Server schema to retrieve table structures, columns, keys, and indexes. Results only cover objects the login can see, so a low-privilege account returns a partial schema rather than an error diff --git a/apps/docs/content/docs/integrations/mysql.mdx b/apps/docs/content/docs/integrations/mysql.mdx index 5f0f1e383b8..f4624bec7da 100644 --- a/apps/docs/content/docs/integrations/mysql.mdx +++ b/apps/docs/content/docs/integrations/mysql.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [MySQL](https://www.mysql.com/) to query rows, insert or modify records, execute raw SQL, and inspect databases, tables, columns, keys, and indexes. Configure the host, port, database, credentials, and SSL mode for the target server. @@ -13,7 +15,6 @@ Use [MySQL](https://www.mysql.com/) to query rows, insert or modify records, exe Query returns rows and a row count. Insert, update, and delete operations accept the data or WHERE clause documented below. Raw SQL can also change schema; use a database account with the permissions the workflow needs. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Query, insert, update, delete, and execute raw SQL. @@ -24,6 +25,8 @@ Query, insert, update, delete, and execute raw SQL. Execute SELECT query on MySQL database + + #### Input | Parameter | Type | Required | Description | @@ -44,10 +47,14 @@ Execute SELECT query on MySQL database | `rows` | array | Array of rows returned from the query | | `rowCount` | number | Number of rows returned | + + ### MySQL Insert Insert new record into MySQL database + + #### Input | Parameter | Type | Required | Description | @@ -69,10 +76,14 @@ Insert new record into MySQL database | `rows` | array | Array of inserted rows | | `rowCount` | number | Number of rows inserted | + + ### MySQL Update Update existing records in MySQL database + + #### Input | Parameter | Type | Required | Description | @@ -95,10 +106,14 @@ Update existing records in MySQL database | `rows` | array | Array of updated rows | | `rowCount` | number | Number of rows updated | + + ### MySQL Delete Delete records from MySQL database + + #### Input | Parameter | Type | Required | Description | @@ -120,10 +135,14 @@ Delete records from MySQL database | `rows` | array | Array of deleted rows | | `rowCount` | number | Number of rows deleted | + + ### MySQL Execute Execute raw SQL query on MySQL database + + #### Input | Parameter | Type | Required | Description | @@ -144,10 +163,14 @@ Execute raw SQL query on MySQL database | `rows` | array | Array of rows returned from the query | | `rowCount` | number | Number of rows affected | + + ### MySQL Introspect Introspect MySQL database schema to retrieve table structures, columns, and relationships + + #### Input | Parameter | Type | Required | Description | @@ -167,4 +190,6 @@ Introspect MySQL database schema to retrieve table structures, columns, and rela | `tables` | array | Array of table schemas with columns, keys, and indexes | | `databases` | array | List of available databases on the server | + + diff --git a/apps/docs/content/docs/integrations/neverbounce.mdx b/apps/docs/content/docs/integrations/neverbounce.mdx index 853a9025aee..81f70a9b501 100644 --- a/apps/docs/content/docs/integrations/neverbounce.mdx +++ b/apps/docs/content/docs/integrations/neverbounce.mdx @@ -6,12 +6,13 @@ integration: color: "#064AF4" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use NeverBounce to verify an email address and read remaining paid and free verification credits. Results classify the address as valid, invalid, disposable, catch-all, or unknown and include role-account and free-provider flags. Treat catch-all and unknown results as inconclusive rather than confirmed delivery. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Integrate NeverBounce to verify email deliverability in real time — classify addresses as valid, invalid, catch-all, disposable, or unknown — and check your remaining verification credits. @@ -22,6 +23,8 @@ Integrate NeverBounce to verify email deliverability in real time — classify a Verify the deliverability of an email address. Uses one verification credit. + + #### Input | Parameter | Type | Required | Description | @@ -41,10 +44,14 @@ Verify the deliverability of an email address. Uses one verification credit. | `didYouMean` | string | Suggested correction for a likely typo | | `flags` | array | Raw NeverBounce flags for the address | + + ### NeverBounce Get Credits Retrieve the remaining paid and free verification credits for the account. + + #### Input | Parameter | Type | Required | Description | @@ -58,4 +65,6 @@ Retrieve the remaining paid and free verification credits for the account. | `credits` | number | Remaining paid verification credits | | `freeCredits` | number | Remaining free verification credits | + + diff --git a/apps/docs/content/docs/integrations/new_relic.mdx b/apps/docs/content/docs/integrations/new_relic.mdx index 544f3d818af..1f137bd3f51 100644 --- a/apps/docs/content/docs/integrations/new_relic.mdx +++ b/apps/docs/content/docs/integrations/new_relic.mdx @@ -25,6 +25,8 @@ Run NRQL queries, search monitored entities, fetch entity details, and record de Run a NRQL query against a New Relic account using NerdGraph. + + #### Input | Parameter | Type | Required | Description | @@ -42,10 +44,14 @@ Run a NRQL query against a New Relic account using NerdGraph. | `results` | array | NRQL result rows. Row fields depend on the query projection. | | `resultCount` | number | Number of NRQL result rows returned | + + ### New Relic Search Entities Search New Relic entities by name, GUID, domain type, tags, or reporting state. + + #### Input | Parameter | Type | Required | Description | @@ -73,10 +79,14 @@ Search New Relic entities by name, GUID, domain type, tags, or reporting state. | ↳ `values` | array | Tag values | | `nextCursor` | string | Cursor for the next page of results | + + ### New Relic Get Entity Fetch a New Relic entity by GUID. + + #### Input | Parameter | Type | Required | Description | @@ -100,6 +110,8 @@ Fetch a New Relic entity by GUID. | ↳ `key` | string | Tag key | | ↳ `values` | array | Tag values | + + ### New Relic Create Deployment Event Record a deployment change event in New Relic change tracking. diff --git a/apps/docs/content/docs/integrations/oracledb.mdx b/apps/docs/content/docs/integrations/oracledb.mdx index d897a80220b..5664ce6813f 100644 --- a/apps/docs/content/docs/integrations/oracledb.mdx +++ b/apps/docs/content/docs/integrations/oracledb.mdx @@ -48,6 +48,8 @@ Query, modify, and inspect Oracle Database over Oracle Net using TCP or verified Run one read-only Oracle SELECT statement or ordinary SELECT CTE with optional named IN binds + + #### Input | Parameter | Type | Required | Description | @@ -67,10 +69,14 @@ Run one read-only Oracle SELECT statement or ordinary SELECT CTE with optional n | `truncated` | boolean | True when rows were dropped to stay inside the row or byte ceiling | | `truncationReason` | string | The response ceiling that was reached | + + ### Oracle Database Insert Insert one JSON object as a row in an Oracle Database table using bound values + + #### Input | Parameter | Type | Required | Description | @@ -91,10 +97,14 @@ Insert one JSON object as a row in an Oracle Database table using bound values | `truncated` | boolean | True when rows were dropped to stay inside the row or byte ceiling | | `truncationReason` | string | The response ceiling that was reached | + + ### Oracle Database Update Update Oracle Database rows selected by a required WHERE expression, using bound values for changed columns + + #### Input | Parameter | Type | Required | Description | @@ -116,10 +126,14 @@ Update Oracle Database rows selected by a required WHERE expression, using bound | `truncated` | boolean | True when rows were dropped to stay inside the row or byte ceiling | | `truncationReason` | string | The response ceiling that was reached | + + ### Oracle Database Delete Delete Oracle Database rows selected by a required WHERE expression + + #### Input | Parameter | Type | Required | Description | @@ -140,10 +154,14 @@ Delete Oracle Database rows selected by a required WHERE expression | `truncated` | boolean | True when rows were dropped to stay inside the row or byte ceiling | | `truncationReason` | string | The response ceiling that was reached | + + ### Oracle Database Execute Execute one allowed Oracle SQL statement: SELECT, INSERT, UPDATE, DELETE, MERGE, CREATE, ALTER, DROP, or EXPLAIN PLAN + + #### Input | Parameter | Type | Required | Description | @@ -163,6 +181,8 @@ Execute one allowed Oracle SQL statement: SELECT, INSERT, UPDATE, DELETE, MERGE, | `truncated` | boolean | True when rows were dropped to stay inside the row or byte ceiling | | `truncationReason` | string | The response ceiling that was reached | + + ### Oracle Database Introspect Inspect accessible Oracle tables, columns, keys, non-primary-key indexes, and table-owning schemas using ALL_* dictionary views diff --git a/apps/docs/content/docs/integrations/parallel_ai.mdx b/apps/docs/content/docs/integrations/parallel_ai.mdx index 338eb5b8faa..402e3e34543 100644 --- a/apps/docs/content/docs/integrations/parallel_ai.mdx +++ b/apps/docs/content/docs/integrations/parallel_ai.mdx @@ -6,12 +6,13 @@ integration: color: "#1D1C1A" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Parallel AI](https://parallel.ai/) to search the web, extract content from URLs, or start a deep-research task. Search accepts an objective and query controls, while extraction accepts the target URLs. Set the available result and content limits to keep downstream inputs bounded, and connect a Parallel API key. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Search the web, extract information from URLs, and conduct deep research. @@ -22,6 +23,8 @@ Search the web, extract information from URLs, and conduct deep research. Search the web with Parallel AI and return matching pages with content excerpts. + + #### Input | Parameter | Type | Required | Description | @@ -46,10 +49,14 @@ Search the web with Parallel AI and return matching pages with content excerpts. | ↳ `publish_date` | string | Publication date of the page \(YYYY-MM-DD\) | | ↳ `excerpts` | array | LLM-optimized excerpts from the page | + + ### Parallel AI Extract Extract targeted information from specific URLs using Parallel AI. Processes provided URLs to pull relevant content based on your objective. + + #### Input | Parameter | Type | Required | Description | @@ -76,10 +83,14 @@ Extract targeted information from specific URLs using Parallel AI. Processes pro | ↳ `http_status_code` | number | HTTP status returned by the page, if any | | ↳ `content` | string | Error detail | + + ### Parallel AI Deep Research Research the web with Parallel AI and synthesize findings from multiple sources with citations. Can take up to 45 minutes to complete. + + #### Input | Parameter | Type | Required | Description | @@ -108,4 +119,6 @@ Research the web with Parallel AI and synthesize findings from multiple sources | ↳ `excerpts` | array | Relevant excerpts from the source | | ↳ `confidence` | string | Confidence level \(low, medium, high\) | + + diff --git a/apps/docs/content/docs/integrations/perplexity.mdx b/apps/docs/content/docs/integrations/perplexity.mdx index 3f7dd63ef3d..78cb601a226 100644 --- a/apps/docs/content/docs/integrations/perplexity.mdx +++ b/apps/docs/content/docs/integrations/perplexity.mdx @@ -6,12 +6,13 @@ integration: color: "#20808D" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Perplexity](https://www.perplexity.ai) to generate chat responses with web citations or search the web with filtering. Pass the returned content and source references to downstream blocks as needed. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Generate completions using Perplexity AI chat models or perform web searches with advanced filtering. @@ -22,6 +23,8 @@ Generate completions using Perplexity AI chat models or perform web searches wit Generate completions using Perplexity AI chat models + + #### Input | Parameter | Type | Required | Description | @@ -44,10 +47,14 @@ Generate completions using Perplexity AI chat models | ↳ `completion_tokens` | number | Number of tokens in the completion | | ↳ `total_tokens` | number | Total number of tokens used | + + ### Perplexity Search Get ranked search results from Perplexity's continuously refreshed index with advanced filtering and customization options + + #### Input | Parameter | Type | Required | Description | @@ -73,4 +80,6 @@ Get ranked search results from Perplexity's continuously refreshed index with ad | ↳ `date` | string | Date the page was crawled and added to Perplexity's index | | ↳ `last_updated` | string | Date the page was last updated in Perplexity's index | + + diff --git a/apps/docs/content/docs/integrations/postgresql.mdx b/apps/docs/content/docs/integrations/postgresql.mdx index dfb4fa61470..c5ffbc47a8f 100644 --- a/apps/docs/content/docs/integrations/postgresql.mdx +++ b/apps/docs/content/docs/integrations/postgresql.mdx @@ -23,6 +23,8 @@ Query or modify PostgreSQL rows, execute SQL, and inspect tables, columns, keys, Execute a SELECT query on PostgreSQL database + + #### Input | Parameter | Type | Required | Description | @@ -43,10 +45,14 @@ Execute a SELECT query on PostgreSQL database | `rows` | array | Array of rows returned from the query | | `rowCount` | number | Number of rows returned | + + ### PostgreSQL Insert Insert data into PostgreSQL database + + #### Input | Parameter | Type | Required | Description | @@ -68,10 +74,14 @@ Insert data into PostgreSQL database | `rows` | array | Inserted data \(if RETURNING clause used\) | | `rowCount` | number | Number of rows inserted | + + ### PostgreSQL Update Update data in PostgreSQL database + + #### Input | Parameter | Type | Required | Description | @@ -94,10 +104,14 @@ Update data in PostgreSQL database | `rows` | array | Updated data \(if RETURNING clause used\) | | `rowCount` | number | Number of rows updated | + + ### PostgreSQL Delete Delete data from PostgreSQL database + + #### Input | Parameter | Type | Required | Description | @@ -119,10 +133,14 @@ Delete data from PostgreSQL database | `rows` | array | Deleted data \(if RETURNING clause used\) | | `rowCount` | number | Number of rows deleted | + + ### PostgreSQL Execute Execute raw SQL query on PostgreSQL database + + #### Input | Parameter | Type | Required | Description | @@ -143,6 +161,8 @@ Execute raw SQL query on PostgreSQL database | `rows` | array | Array of rows returned from the query | | `rowCount` | number | Number of rows affected | + + ### PostgreSQL Introspect Introspect PostgreSQL database schema to retrieve table structures, columns, and relationships diff --git a/apps/docs/content/docs/integrations/pulse.mdx b/apps/docs/content/docs/integrations/pulse.mdx index 0c89da9c7c9..b91ebfc1e12 100644 --- a/apps/docs/content/docs/integrations/pulse.mdx +++ b/apps/docs/content/docs/integrations/pulse.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Pulse](https://www.runpulse.com) to extract text and structured content from PDFs, images, and Office files with optical character recognition (OCR). Supply a file URL or upload, select pages when needed, and choose the supported Markdown, text, or JSON output options. @@ -13,7 +15,6 @@ Use [Pulse](https://www.runpulse.com) to extract text and structured content fro Optional figure and table extraction returns captions and descriptions. The result also includes processing metadata such as file type, page count, and processing time. Pass the extracted content to later steps for review or summarization. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Extract text from PDF documents, images, and Office files via upload or file references. @@ -24,6 +25,8 @@ Extract text from PDF documents, images, and Office files via upload or file ref Parse documents (PDF, images, Office docs) using Pulse OCR API + + #### Input | Parameter | Type | Required | Description | @@ -48,4 +51,6 @@ Parse documents (PDF, images, Office docs) using Pulse OCR API | `chunks` | json | Chunked content if chunking was enabled | | `figures` | json | Extracted figures; returned only when the hidden extractFigure input is enabled | + + diff --git a/apps/docs/content/docs/integrations/qdrant.mdx b/apps/docs/content/docs/integrations/qdrant.mdx index 45b9131cfef..cb3023fb45f 100644 --- a/apps/docs/content/docs/integrations/qdrant.mdx +++ b/apps/docs/content/docs/integrations/qdrant.mdx @@ -6,12 +6,13 @@ integration: color: "#1A223F" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Qdrant](https://qdrant.tech) in Sim to upsert points, search for similar vectors with optional payload filters, and fetch points by ID. Points contain vectors and associated payload data; fetch and search options control which fields are returned. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Upsert, search, and fetch points. @@ -22,6 +23,8 @@ Upsert, search, and fetch points. Insert or update points in a Qdrant collection + + #### Input | Parameter | Type | Required | Description | @@ -40,10 +43,14 @@ Insert or update points in a Qdrant collection | ↳ `operation_id` | number | Operation ID for async tracking | | ↳ `status` | string | Operation status \(acknowledged, completed\) | + + ### Qdrant Search Vector Search for similar vectors in a Qdrant collection + + #### Input | Parameter | Type | Required | Description | @@ -72,10 +79,14 @@ Search for similar vectors in a Qdrant collection | ↳ `shard_key` | string | Shard key for routing | | ↳ `order_value` | number | Order value for sorting | + + ### Qdrant Fetch Points Fetch points by ID from a Qdrant collection + + #### Input | Parameter | Type | Required | Description | @@ -100,4 +111,6 @@ Fetch points by ID from a Qdrant collection | ↳ `shard_key` | string | Shard key for routing | | ↳ `order_value` | number | Order value for sorting | + + diff --git a/apps/docs/content/docs/integrations/quiver.mdx b/apps/docs/content/docs/integrations/quiver.mdx index 35259abd222..337da479f53 100644 --- a/apps/docs/content/docs/integrations/quiver.mdx +++ b/apps/docs/content/docs/integrations/quiver.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [QuiverAI](https://quiver.ai/) to generate SVG graphics from text or vectorize a raster image. Supply up to four reference images for generation, and configure temperature, output count, and token limits where supported. @@ -13,7 +15,6 @@ Use [QuiverAI](https://quiver.ai/) to generate SVG graphics from text or vectori **List Models** reports available models and capabilities. Generated SVG markup and stored files are returned for downstream processing, storage, or delivery. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Generate SVG images from text prompts or vectorize raster images into SVGs using QuiverAI. Supports reference images, style instructions, and multiple output generation. @@ -24,6 +25,8 @@ Generate SVG images from text prompts or vectorize raster images into SVGs using Generate SVG images from text prompts using QuiverAI + + #### Input | Parameter | Type | Required | Description | @@ -50,10 +53,14 @@ Generate SVG images from text prompts using QuiverAI | ↳ `inputTokens` | number | Input tokens used | | ↳ `outputTokens` | number | Output tokens used | + + ### Quiver Image to SVG Convert raster images into vector SVG format using QuiverAI + + #### Input | Parameter | Type | Required | Description | @@ -79,10 +86,14 @@ Convert raster images into vector SVG format using QuiverAI | ↳ `inputTokens` | number | Input tokens used | | ↳ `outputTokens` | number | Output tokens used | + + ### Quiver List Models List all available QuiverAI models + + #### Input | Parameter | Type | Required | Description | @@ -108,4 +119,6 @@ List all available QuiverAI models | ↳ `supportedOperations` | json | Available operations \(svg_generate, svg_edit, svg_animate, svg_vectorize, chat_completions\) | | ↳ `supportedSamplingParameters` | json | Supported sampling parameters \(temperature, top_p, top_k, repetition_penalty, presence_penalty, stop\) | + + diff --git a/apps/docs/content/docs/integrations/rds.mdx b/apps/docs/content/docs/integrations/rds.mdx index c550cd67fc1..e1c7aa78bcd 100644 --- a/apps/docs/content/docs/integrations/rds.mdx +++ b/apps/docs/content/docs/integrations/rds.mdx @@ -6,12 +6,13 @@ integration: color: "linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Amazon RDS Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) through the Data API to query or modify rows, execute SQL, and inspect the database schema from a workflow. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Integrate Amazon RDS Aurora Serverless into the workflow using the Data API. Can query, insert, update, delete, and execute raw SQL without managing database connections. @@ -22,6 +23,8 @@ Integrate Amazon RDS Aurora Serverless into the workflow using the Data API. Can Execute a SELECT query on Amazon RDS using the Data API + + #### Input | Parameter | Type | Required | Description | @@ -42,10 +45,14 @@ Execute a SELECT query on Amazon RDS using the Data API | `rows` | array | Array of rows returned from the query | | `rowCount` | number | Number of rows returned | + + ### RDS Insert Insert data into an Amazon RDS table using the Data API + + #### Input | Parameter | Type | Required | Description | @@ -67,10 +74,14 @@ Insert data into an Amazon RDS table using the Data API | `rows` | array | Array of inserted rows | | `rowCount` | number | Number of rows inserted | + + ### RDS Update Update data in an Amazon RDS table using the Data API + + #### Input | Parameter | Type | Required | Description | @@ -93,10 +104,14 @@ Update data in an Amazon RDS table using the Data API | `rows` | array | Array of updated rows | | `rowCount` | number | Number of rows updated | + + ### RDS Delete Delete data from an Amazon RDS table using the Data API + + #### Input | Parameter | Type | Required | Description | @@ -118,10 +133,14 @@ Delete data from an Amazon RDS table using the Data API | `rows` | array | Array of deleted rows | | `rowCount` | number | Number of rows deleted | + + ### RDS Execute Execute raw SQL on Amazon RDS using the Data API + + #### Input | Parameter | Type | Required | Description | @@ -142,10 +161,14 @@ Execute raw SQL on Amazon RDS using the Data API | `rows` | array | Array of rows returned or affected | | `rowCount` | number | Number of rows affected | + + ### RDS Introspect Introspect Amazon RDS Aurora database schema to retrieve table structures, columns, and relationships + + #### Input | Parameter | Type | Required | Description | @@ -168,4 +191,6 @@ Introspect Amazon RDS Aurora database schema to retrieve table structures, colum | `tables` | array | Array of table schemas with columns, keys, and indexes | | `schemas` | array | List of available schemas in the database | + + diff --git a/apps/docs/content/docs/integrations/reducto.mdx b/apps/docs/content/docs/integrations/reducto.mdx index 41a2b4bc5c1..f22dbf6bc94 100644 --- a/apps/docs/content/docs/integrations/reducto.mdx +++ b/apps/docs/content/docs/integrations/reducto.mdx @@ -6,12 +6,13 @@ integration: color: "#5c0c5c" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Reducto](https://reducto.ai/) to extract content from a PDF supplied as an upload or file reference. Optionally select 1-indexed pages and choose Markdown or HTML for table output. The result includes parsed chunks and blocks, job metadata, and usage information. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Extract text from uploaded PDF documents or file references. @@ -22,6 +23,8 @@ Extract text from uploaded PDF documents or file references. Parse PDF documents using Reducto OCR API + + #### Input | Parameter | Type | Required | Description | @@ -42,4 +45,6 @@ Parse PDF documents using Reducto OCR API | `pdf_url` | string | Storage URL of converted PDF | | `studio_link` | string | Link to Reducto studio interface | + + diff --git a/apps/docs/content/docs/integrations/salesforce.mdx b/apps/docs/content/docs/integrations/salesforce.mdx index 96c091005b2..754b7c3c70d 100644 --- a/apps/docs/content/docs/integrations/salesforce.mdx +++ b/apps/docs/content/docs/integrations/salesforce.mdx @@ -1266,6 +1266,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when a case status changes + + #### Configuration | Parameter | Type | Required | Description | @@ -1294,13 +1296,14 @@ Trigger workflow when a case status changes | `newStatus` | string | New case status | | `payload` | json | Full webhook payload | - ---- + ### Salesforce Opportunity Stage Changed Trigger workflow when an opportunity stage changes + + #### Configuration | Parameter | Type | Required | Description | @@ -1329,13 +1332,14 @@ Trigger workflow when an opportunity stage changes | `newStage` | string | New stage name | | `payload` | json | Full webhook payload | - ---- + ### Salesforce Record Created Trigger workflow when a Salesforce record is created + + #### Configuration | Parameter | Type | Required | Description | @@ -1362,13 +1366,14 @@ Trigger workflow when a Salesforce record is created | `changedFields` | json | Fields that were changed \(for update events\) | | `payload` | json | Full webhook payload | - ---- + ### Salesforce Record Deleted Trigger workflow when a Salesforce record is deleted + + #### Configuration | Parameter | Type | Required | Description | @@ -1395,13 +1400,14 @@ Trigger workflow when a Salesforce record is deleted | `changedFields` | json | Fields that were changed \(for update events\) | | `payload` | json | Full webhook payload | - ---- + ### Salesforce Record Updated Trigger workflow when a Salesforce record is updated + + #### Configuration | Parameter | Type | Required | Description | @@ -1428,13 +1434,14 @@ Trigger workflow when a Salesforce record is updated | `changedFields` | json | Fields that were changed \(for update events\) | | `payload` | json | Full webhook payload | - ---- + ### Salesforce Webhook (All Events) Trigger workflow on any Salesforce webhook event + + #### Configuration | Parameter | Type | Required | Description | @@ -1454,3 +1461,5 @@ Trigger workflow on any Salesforce webhook event | `record` | json | Full record data | | `payload` | json | Full webhook payload | + + diff --git a/apps/docs/content/docs/integrations/sendblue.mdx b/apps/docs/content/docs/integrations/sendblue.mdx index 9772a6a7659..3a65ce61b5f 100644 --- a/apps/docs/content/docs/integrations/sendblue.mdx +++ b/apps/docs/content/docs/integrations/sendblue.mdx @@ -127,6 +127,8 @@ Send an iMessage or SMS to a group of recipients via Sendblue. Check whether a phone number can receive iMessage or only SMS. + + #### Input | Parameter | Type | Required | Description | @@ -142,10 +144,14 @@ Check whether a phone number can receive iMessage or only SMS. | `number` | string | The evaluated phone number in E.164 format | | `service` | string | The service the number supports: iMessage or SMS | + + ### Sendblue Send Typing Indicator Display a typing indicator to a recipient (not supported in group chats). + + #### Input | Parameter | Type | Required | Description | @@ -166,6 +172,8 @@ Display a typing indicator to a recipient (not supported in group chats). | `number` | string | The recipient phone number | | `error_message` | string | Error details, null on success | + + ### Sendblue Get Message Retrieve a single message and its current status by message handle/ID. diff --git a/apps/docs/content/docs/integrations/sentry.mdx b/apps/docs/content/docs/integrations/sentry.mdx index 010ce8320fb..4c7120ad937 100644 --- a/apps/docs/content/docs/integrations/sentry.mdx +++ b/apps/docs/content/docs/integrations/sentry.mdx @@ -772,6 +772,8 @@ Trigger workflow when a new error event is created in Sentry Trigger workflow when a Sentry issue alert rule fires + + #### Configuration | Parameter | Type | Required | Description | @@ -791,8 +793,7 @@ Trigger workflow when a Sentry issue alert rule fires | ↳ `title` | string | Alert rule name | | ↳ `settings` | json | Alert rule action settings \(name/value pairs\) | - ---- + ### Sentry Issue Created @@ -918,6 +919,8 @@ Trigger workflow when an issue is resolved in Sentry Trigger workflow when a Sentry metric alert changes state (critical, warning, resolved) + + #### Configuration | Parameter | Type | Required | Description | @@ -936,3 +939,5 @@ Trigger workflow when a Sentry metric alert changes state (critical, warning, re | `description_title` | string | Human-friendly title of the alert | | `web_url` | string | API URL for the incident | + + diff --git a/apps/docs/content/docs/integrations/serper.mdx b/apps/docs/content/docs/integrations/serper.mdx index d60ee159a1d..52b112f879f 100644 --- a/apps/docs/content/docs/integrations/serper.mdx +++ b/apps/docs/content/docs/integrations/serper.mdx @@ -6,12 +6,13 @@ integration: color: "#2B3543" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} [Serper](https://serper.dev/) provides web search results for a query. Use the returned titles, snippets, and URLs as inputs to later workflow steps, and configure the search options listed below. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Search the web. @@ -22,6 +23,8 @@ Search the web. Search Google through the Serper.dev API for web, news, places, images, videos, shopping, scholar, or patent results. Available response sections include organic results, a knowledge graph, an answer box, related questions, related searches, and top stories. + + #### Input | Parameter | Type | Required | Description | @@ -51,4 +54,6 @@ Search Google through the Serper.dev API for web, news, places, images, videos, | ↳ `price` | string | Price \(shopping\) | | ↳ `duration` | string | Duration \(videos\) | + + diff --git a/apps/docs/content/docs/integrations/servicenow.mdx b/apps/docs/content/docs/integrations/servicenow.mdx index b25fb3cb501..91f21ff398e 100644 --- a/apps/docs/content/docs/integrations/servicenow.mdx +++ b/apps/docs/content/docs/integrations/servicenow.mdx @@ -1826,6 +1826,8 @@ Trigger workflow when an incident is updated in ServiceNow Trigger workflow on any ServiceNow webhook event + + #### Configuration | Parameter | Type | Required | Description | @@ -1854,3 +1856,5 @@ Trigger workflow on any ServiceNow webhook event | `category` | string | Record category | | `record` | json | Full record data from the webhook payload | + + diff --git a/apps/docs/content/docs/integrations/sftp.mdx b/apps/docs/content/docs/integrations/sftp.mdx index 800704930be..bbcc56e1ffa 100644 --- a/apps/docs/content/docs/integrations/sftp.mdx +++ b/apps/docs/content/docs/integrations/sftp.mdx @@ -6,6 +6,8 @@ integration: color: "#2D3748" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use SFTP (SSH File Transfer Protocol) to upload or download files, list directories with optional metadata, delete files or directories, and create directories on a remote server. Authenticate with a password or OpenSSH private key; provide a passphrase for an encrypted key. @@ -13,7 +15,6 @@ Use SFTP (SSH File Transfer Protocol) to upload or download files, list director Uploads accept workspace files or direct text content. The current Download operation returns a stored file reference for later workflow steps. Recursive deletion removes directory contents, so check the target path before enabling it. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Upload, download, list, and manage files on remote servers via SFTP. Supports both password and private key authentication for secure file transfers. @@ -24,6 +25,8 @@ Upload, download, list, and manage files on remote servers via SFTP. Supports bo Upload files to a remote SFTP server + + #### Input | Parameter | Type | Required | Description | @@ -49,10 +52,14 @@ Upload files to a remote SFTP server | `uploadedFiles` | json | Array of uploaded file details \(name, remotePath, size\) | | `message` | string | Operation status message | + + ### SFTP Download Download a file from a remote SFTP server + + #### Input | Parameter | Type | Required | Description | @@ -71,10 +78,14 @@ Download a file from a remote SFTP server | --------- | ---- | ----------- | | `file` | file | Downloaded file stored in execution files | + + ### SFTP List Directory List files and directories on a remote SFTP server + + #### Input | Parameter | Type | Required | Description | @@ -98,10 +109,14 @@ List files and directories on a remote SFTP server | `count` | number | Number of entries in the directory | | `message` | string | Operation status message | + + ### SFTP Delete Delete a file or directory on a remote SFTP server + + #### Input | Parameter | Type | Required | Description | @@ -123,10 +138,14 @@ Delete a file or directory on a remote SFTP server | `deletedPath` | string | Path that was deleted | | `message` | string | Operation status message | + + ### SFTP Create Directory Create a directory on a remote SFTP server + + #### Input | Parameter | Type | Required | Description | @@ -148,4 +167,6 @@ Create a directory on a remote SFTP server | `createdPath` | string | Path of the created directory | | `message` | string | Operation status message | + + diff --git a/apps/docs/content/docs/integrations/similarweb.mdx b/apps/docs/content/docs/integrations/similarweb.mdx index 007e7e1bb4f..cf74d3d35ca 100644 --- a/apps/docs/content/docs/integrations/similarweb.mdx +++ b/apps/docs/content/docs/integrations/similarweb.mdx @@ -65,6 +65,8 @@ Get website traffic, rankings, engagement, and traffic sources. Get total website visits over time (desktop and mobile combined) + + #### Input | Parameter | Type | Required | Description | @@ -89,10 +91,14 @@ Get total website visits over time (desktop and mobile combined) | ↳ `date` | string | Date \(YYYY-MM-DD\) | | ↳ `visits` | number | Number of visits | + + ### SimilarWeb Bounce Rate Get website bounce rate over time (desktop and mobile combined) + + #### Input | Parameter | Type | Required | Description | @@ -117,10 +123,14 @@ Get website bounce rate over time (desktop and mobile combined) | ↳ `date` | string | Date \(YYYY-MM-DD\) | | ↳ `bounceRate` | number | Bounce rate \(0-1\) | + + ### SimilarWeb Pages Per Visit Get average pages per visit over time (desktop and mobile combined) + + #### Input | Parameter | Type | Required | Description | @@ -145,10 +155,14 @@ Get average pages per visit over time (desktop and mobile combined) | ↳ `date` | string | Date \(YYYY-MM-DD\) | | ↳ `pagesPerVisit` | number | Average pages per visit | + + ### SimilarWeb Visit Duration Get average desktop visit duration over time (in seconds) + + #### Input | Parameter | Type | Required | Description | @@ -173,10 +187,14 @@ Get average desktop visit duration over time (in seconds) | ↳ `date` | string | Date \(YYYY-MM-DD\) | | ↳ `durationSeconds` | number | Average visit duration in seconds | + + ### SimilarWeb Page Views Get total page views over time (desktop and mobile combined) + + #### Input | Parameter | Type | Required | Description | @@ -201,4 +219,6 @@ Get total page views over time (desktop and mobile combined) | ↳ `date` | string | Date \(YYYY-MM-DD\) | | ↳ `pageViews` | number | Total page views | + + diff --git a/apps/docs/content/docs/integrations/sixtyfour.mdx b/apps/docs/content/docs/integrations/sixtyfour.mdx index 673d8cec96c..39dd2922e65 100644 --- a/apps/docs/content/docs/integrations/sixtyfour.mdx +++ b/apps/docs/content/docs/integrations/sixtyfour.mdx @@ -23,6 +23,8 @@ Find emails, phone numbers, and enrich lead or company data with contact informa Find phone numbers for a lead using Sixtyfour AI. + + #### Input | Parameter | Type | Required | Description | @@ -43,6 +45,8 @@ Find phone numbers for a lead using Sixtyfour AI. | `phone` | string | Phone number\(s\) found | | `linkedinUrl` | string | LinkedIn profile URL | + + ### Sixtyfour Find Email Find email addresses for a lead using Sixtyfour AI. @@ -86,6 +90,8 @@ Find email addresses for a lead using Sixtyfour AI. Enrich lead information with contact details, social profiles, and company data using Sixtyfour AI. + + #### Input | Parameter | Type | Required | Description | @@ -104,10 +110,14 @@ Enrich lead information with contact details, social profiles, and company data | `references` | json | Source URLs and descriptions used for enrichment | | `confidenceScore` | number | Quality score for the returned data \(0-10\) | + + ### Sixtyfour Enrich Company Enrich company data with additional information and find associated people using Sixtyfour AI. + + #### Input | Parameter | Type | Required | Description | @@ -131,4 +141,6 @@ Enrich company data with additional information and find associated people using | `confidenceScore` | number | Quality score for the returned data \(0-10\) | | `orgChart` | json | Org chart returned when fullOrgChart is enabled | + + diff --git a/apps/docs/content/docs/integrations/smtp.mdx b/apps/docs/content/docs/integrations/smtp.mdx index a4860edb3b6..87eb4521a4d 100644 --- a/apps/docs/content/docs/integrations/smtp.mdx +++ b/apps/docs/content/docs/integrations/smtp.mdx @@ -6,12 +6,13 @@ integration: color: "#2D3748" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} The SMTP block sends email through a mail server using its hostname, port, security protocol, and credentials. Set the sender, recipients, subject, and plain-text or HTML body; add CC, BCC, reply-to, and attachments as needed. Inspect the returned send status and message ID, or the error if sending fails. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Send email through an SMTP server using its host, port, security protocol, and credentials. Configure recipients, message content, and optional attachments. @@ -22,6 +23,8 @@ Send email through an SMTP server using its host, port, security protocol, and c Send emails via SMTP server + + #### Input | Parameter | Type | Required | Description | @@ -52,4 +55,6 @@ Send emails via SMTP server | `subject` | string | Email subject | | `error` | string | Error message if sending failed | + + diff --git a/apps/docs/content/docs/integrations/stagehand.mdx b/apps/docs/content/docs/integrations/stagehand.mdx index ed7ccaa79f8..84680b2fc0e 100644 --- a/apps/docs/content/docs/integrations/stagehand.mdx +++ b/apps/docs/content/docs/integrations/stagehand.mdx @@ -23,6 +23,8 @@ Extract structured data from webpages or run an autonomous agent to perform task Extract structured data from a webpage using Stagehand + + #### Input | Parameter | Type | Required | Description | @@ -39,6 +41,8 @@ Extract structured data from a webpage using Stagehand | --------- | ---- | ----------- | | `data` | object | Extracted structured data matching the provided schema | + + ### Stagehand Agent Run an autonomous web agent to complete tasks and extract structured data diff --git a/apps/docs/content/docs/integrations/stripe.mdx b/apps/docs/content/docs/integrations/stripe.mdx index f01bd1a292f..df414b2abc2 100644 --- a/apps/docs/content/docs/integrations/stripe.mdx +++ b/apps/docs/content/docs/integrations/stripe.mdx @@ -3126,6 +3126,8 @@ A trigger starts a workflow when a supported event occurs in this service. Triggers when Stripe events occur (payments, subscriptions, invoices, etc.) + + #### Configuration | Parameter | Type | Required | Description | @@ -3147,3 +3149,5 @@ Triggers when Stripe events occur (payments, subscriptions, invoices, etc.) | `pending_webhooks` | number | Number of webhooks yet to be delivered for this event | | `request` | json | Information about the API request that triggered this event \(id, idempotency_key\) | + + diff --git a/apps/docs/content/docs/integrations/sts.mdx b/apps/docs/content/docs/integrations/sts.mdx index af17d5f6da0..3d3be97dae7 100644 --- a/apps/docs/content/docs/integrations/sts.mdx +++ b/apps/docs/content/docs/integrations/sts.mdx @@ -62,6 +62,8 @@ Assume an IAM role and receive temporary security credentials Assume an IAM role using an OIDC/OAuth 2.0 web identity token (e.g. GitHub Actions OIDC, EKS IRSA, Google/Facebook federation) and receive temporary security credentials + + #### Input | Parameter | Type | Required | Description | @@ -91,10 +93,14 @@ Assume an IAM role using an OIDC/OAuth 2.0 web identity token (e.g. GitHub Actio | `packedPolicySize` | number | Percentage of allowed policy size used | | `sourceIdentity` | string | Source identity set on the role session, if any | + + ### STS Assume Role With SAML Assume an IAM role using a SAML 2.0 authentication response from an enterprise identity provider and receive temporary security credentials + + #### Input | Parameter | Type | Required | Description | @@ -125,10 +131,14 @@ Assume an IAM role using a SAML 2.0 authentication response from an enterprise i | `packedPolicySize` | number | Percentage of allowed policy size used | | `sourceIdentity` | string | Source identity set on the role session, if any | + + ### STS Get Caller Identity Get details about the IAM user or role whose credentials are used to call the API + + #### Input | Parameter | Type | Required | Description | @@ -145,10 +155,14 @@ Get details about the IAM user or role whose credentials are used to call the AP | `arn` | string | ARN of the calling entity | | `userId` | string | Unique identifier of the calling entity | + + ### STS Get Session Token Get temporary security credentials for an IAM user, optionally with MFA + + #### Input | Parameter | Type | Required | Description | @@ -169,10 +183,14 @@ Get temporary security credentials for an IAM user, optionally with MFA | `sessionToken` | string | Temporary session token | | `expiration` | string | Credential expiration timestamp | + + ### STS Get Access Key Info Get the AWS account ID associated with an access key + + #### Input | Parameter | Type | Required | Description | @@ -188,4 +206,6 @@ Get the AWS account ID associated with an access key | --------- | ---- | ----------- | | `account` | string | AWS account ID that owns the access key | + + diff --git a/apps/docs/content/docs/integrations/tavily.mdx b/apps/docs/content/docs/integrations/tavily.mdx index f8de904f51d..cc85ce655d0 100644 --- a/apps/docs/content/docs/integrations/tavily.mdx +++ b/apps/docs/content/docs/integrations/tavily.mdx @@ -73,6 +73,8 @@ Perform AI-powered web searches using Tavily's search API. Returns structured re Extract raw content from multiple web pages simultaneously using Tavily's extraction API. Supports basic and advanced extraction depths with detailed error reporting for failed URLs. + + #### Input | Parameter | Type | Required | Description | @@ -98,6 +100,8 @@ Extract raw content from multiple web pages simultaneously using Tavily's extrac | ↳ `error` | string | Error message describing why extraction failed | | `response_time` | number | Time taken for the extraction request in seconds | + + ### Tavily Crawl Systematically crawl and extract content from websites using Tavily's crawl API. Supports depth control, path filtering, domain restrictions, and natural language instructions for targeted crawling. @@ -142,6 +146,8 @@ Systematically crawl and extract content from websites using Tavily's crawl API. Discover and visualize website structure using Tavily's map API. Maps out all accessible URLs from a base URL with depth control, path filtering, and domain restrictions. + + #### Input | Parameter | Type | Required | Description | @@ -168,4 +174,6 @@ Discover and visualize website structure using Tavily's map API. Maps out all ac | `response_time` | number | Time taken for the map request in seconds | | `request_id` | string | Unique identifier for support reference | + + diff --git a/apps/docs/content/docs/integrations/textract.mdx b/apps/docs/content/docs/integrations/textract.mdx index 535fb7cdc81..f00beb21805 100644 --- a/apps/docs/content/docs/integrations/textract.mdx +++ b/apps/docs/content/docs/integrations/textract.mdx @@ -83,6 +83,8 @@ Parse documents using AWS Textract OCR and document analysis Extract structured invoice and receipt fields using AWS Textract AnalyzeExpense + + #### Input | Parameter | Type | Required | Description | @@ -110,10 +112,14 @@ Extract structured invoice and receipt fields using AWS Textract AnalyzeExpense | ↳ `pages` | number | Number of pages in the document | | `modelVersion` | string | Version of the AnalyzeExpense model used \(multi-page/async only\) | + + ### AWS Textract Analyze ID Extract identity document fields using AWS Textract AnalyzeID + + #### Input | Parameter | Type | Required | Description | @@ -143,4 +149,6 @@ Extract identity document fields using AWS Textract AnalyzeID | ↳ `pages` | number | Number of pages analyzed | | `modelVersion` | string | Version of the AnalyzeID model used for processing | + + diff --git a/apps/docs/content/docs/integrations/tiktok.mdx b/apps/docs/content/docs/integrations/tiktok.mdx index dcdc18ce82b..ec4d601ef92 100644 --- a/apps/docs/content/docs/integrations/tiktok.mdx +++ b/apps/docs/content/docs/integrations/tiktok.mdx @@ -6,12 +6,13 @@ integration: color: "#000000" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [TikTok](https://www.tiktok.com/) to read the authenticated creator's profile and videos, send a video to their inbox as a draft, and track publishing status. The creator reviews and publishes drafts in TikTok; this integration does not publish them unattended. Webhooks can notify workflows about post and authorization changes. {/* MANUAL-CONTENT-END */} - ## OAuth scopes [#oauth-scopes] Sim requests these scopes when someone connects a TikTok account. For a self-hosted deployment, register your own app with the provider using the settings below. See [Integrations and OAuth](/platform/self-hosting/integrations-oauth) for setup. @@ -39,6 +40,8 @@ Get user profile information including follower counts and video statistics. Lis Get the authenticated TikTok user profile information including display name, avatar, bio, follower count, and video statistics. + + #### Input | Parameter | Type | Required | Description | @@ -62,10 +65,14 @@ Get the authenticated TikTok user profile information including display name, av | `videoCount` | number | Total number of public videos | | `avatarFile` | file | Downloadable copy of the profile avatar image \(largest available variant\), stored as a workflow file so it can be chained into file-consuming blocks \(e.g. attached to an email\). | + + ### TikTok List Videos Get a list of the authenticated user's TikTok videos with cover images, titles, and metadata. Supports pagination. + + #### Input | Parameter | Type | Required | Description | @@ -96,10 +103,14 @@ Get a list of the authenticated user's TikTok videos with cover images, titles, | `cursor` | number | Cursor for fetching the next page of results | | `hasMore` | boolean | Whether there are more videos to fetch | + + ### TikTok Query Videos Query specific TikTok videos by their IDs to get fresh metadata including cover images, embed links, and video details. + + #### Input | Parameter | Type | Required | Description | @@ -127,10 +138,14 @@ Query specific TikTok videos by their IDs to get fresh metadata including cover | ↳ `commentCount` | number | Number of comments | | ↳ `shareCount` | number | Number of shares | + + ### TikTok Upload Video Draft Send an uploaded video to the authenticated user's TikTok inbox for manual editing and posting. The user must open TikTok and tap the inbox notification to complete the post. Rate limit: 6 requests per minute per user. + + #### Input | Parameter | Type | Required | Description | @@ -143,10 +158,14 @@ Send an uploaded video to the authenticated user's TikTok inbox for manual editi | --------- | ---- | ----------- | | `publishId` | string | Unique identifier for tracking the draft status. Use this with the Get Post Status tool to check when the user has completed posting from their inbox. | + + ### TikTok Get Post Status Check the status of a video draft upload. Use the publishId returned from Upload Video Draft to track progress. + + #### Input | Parameter | Type | Required | Description | @@ -163,6 +182,8 @@ Check the status of a video draft upload. Use the publishId returned from Upload | `uploadedBytes` | number | Number of bytes uploaded to TikTok for FILE_UPLOAD posts | | `downloadedBytes` | number | Number of bytes TikTok reports as downloaded | + + ## Triggers @@ -173,6 +194,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger when a user deauthorizes your TikTok app + + #### Configuration | Parameter | Type | Required | Description | @@ -189,13 +212,14 @@ Trigger when a user deauthorizes your TikTok app | `clientKey` | string | TikTok app client_key that received the event | | `reason` | number | Revocation reason \(0 unknown, 1 user disconnect, 2 account deleted, 3 age change, 4 banned, 5 developer revoke\) | - ---- + ### TikTok Post Inbox Delivered Trigger when a draft notification is delivered to the creator inbox + + #### Configuration | Parameter | Type | Required | Description | @@ -213,13 +237,14 @@ Trigger when a draft notification is delivered to the creator inbox | `publishId` | string | Content Posting API publish_id | | `publishType` | string | Publish type \(e.g. DIRECT_POST, INBOX_SHARE\) | - ---- + ### TikTok Post No Longer Public Trigger when a post is no longer publicly viewable on TikTok + + #### Configuration | Parameter | Type | Required | Description | @@ -238,13 +263,14 @@ Trigger when a post is no longer publicly viewable on TikTok | `publishType` | string | Publish type \(e.g. DIRECT_POST, INBOX_SHARE\) | | `postId` | string | TikTok post_id when the post is publicly available | - ---- + ### TikTok Post Publicly Available Trigger when a published post becomes publicly viewable on TikTok + + #### Configuration | Parameter | Type | Required | Description | @@ -263,13 +289,14 @@ Trigger when a published post becomes publicly viewable on TikTok | `publishType` | string | Publish type \(e.g. DIRECT_POST, INBOX_SHARE\) | | `postId` | string | TikTok post_id when the post is publicly available | - ---- + ### TikTok Post Publish Complete Trigger when a TikTok Content Posting publish completes + + #### Configuration | Parameter | Type | Required | Description | @@ -287,13 +314,14 @@ Trigger when a TikTok Content Posting publish completes | `publishId` | string | Content Posting API publish_id | | `publishType` | string | Publish type \(e.g. DIRECT_POST, INBOX_SHARE\) | - ---- + ### TikTok Post Publish Failed Trigger when a TikTok Content Posting publish fails + + #### Configuration | Parameter | Type | Required | Description | @@ -312,3 +340,5 @@ Trigger when a TikTok Content Posting publish fails | `publishType` | string | Publish type \(e.g. DIRECT_POST, INBOX_SHARE\) | | `failReason` | string | Failure reason enum from TikTok when publishing fails | + + diff --git a/apps/docs/content/docs/integrations/twilio_sms.mdx b/apps/docs/content/docs/integrations/twilio_sms.mdx index bd2670d7025..f0d3e00b4b5 100644 --- a/apps/docs/content/docs/integrations/twilio_sms.mdx +++ b/apps/docs/content/docs/integrations/twilio_sms.mdx @@ -6,12 +6,13 @@ integration: color: "#F22F46" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Twilio SMS](https://www.twilio.com/en-us/sms) to send a text message from a workflow. Configure the Twilio credentials, sending number, recipient, and message body documented below. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Send SMS messages. @@ -22,6 +23,8 @@ Send SMS messages. Send text messages to single or multiple recipients using the Twilio API. + + #### Input | Parameter | Type | Required | Description | @@ -42,4 +45,6 @@ Send text messages to single or multiple recipients using the Twilio API. | `fromNumber` | string | Phone number message was sent from | | `toNumber` | string | Phone number message was sent to | + + diff --git a/apps/docs/content/docs/integrations/twilio_voice.mdx b/apps/docs/content/docs/integrations/twilio_voice.mdx index 0fa321c9d49..d6b3458e6fe 100644 --- a/apps/docs/content/docs/integrations/twilio_voice.mdx +++ b/apps/docs/content/docs/integrations/twilio_voice.mdx @@ -63,6 +63,8 @@ Make an outbound phone call using Twilio Voice API. Retrieve a list of calls made to and from an account. + + #### Input | Parameter | Type | Required | Description | @@ -87,10 +89,14 @@ Retrieve a list of calls made to and from an account. | `pageSize` | number | Number of calls per page | | `error` | string | Error message if retrieval failed | + + ### Twilio Voice Get Recording Retrieve call recording information and transcription (if enabled via TwiML). + + #### Input | Parameter | Type | Required | Description | @@ -121,6 +127,8 @@ Retrieve call recording information and transcription (if enabled via TwiML). | `transcriptionPriceUnit` | string | Currency of the transcription price | | `error` | string | Error message if retrieval failed | + + ## Triggers diff --git a/apps/docs/content/docs/integrations/wealthbox.mdx b/apps/docs/content/docs/integrations/wealthbox.mdx index ed78427b243..c1481d1d349 100644 --- a/apps/docs/content/docs/integrations/wealthbox.mdx +++ b/apps/docs/content/docs/integrations/wealthbox.mdx @@ -6,6 +6,8 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Wealthbox](https://www.wealthbox.com/) to read and write client notes, contacts, and tasks. A workflow can turn meeting output into a note, retrieve client context, or create follow-up work. @@ -13,7 +15,6 @@ Use [Wealthbox](https://www.wealthbox.com/) to read and write client notes, cont Connect with OAuth or a supported [API access token](/integrations/wealthbox-service-account). Each credential uses the connected Wealthbox user's permissions. Contact writes create new contacts; note and task writes also support updates. {/* MANUAL-CONTENT-END */} - Connection guides: [API access tokens](/integrations/wealthbox-service-account). ## OAuth scopes [#oauth-scopes] @@ -40,6 +41,8 @@ Read or write Wealthbox notes, contacts, and tasks with OAuth or a supported API Read content from a Wealthbox note + + #### Input | Parameter | Type | Required | Description | @@ -59,10 +62,14 @@ Read content from a Wealthbox note | ↳ `noteId` | string | ID of the note | | ↳ `itemType` | string | Type of item \(note\) | + + ### Write Wealthbox Note Create or update a Wealthbox note + + #### Input | Parameter | Type | Required | Description | @@ -83,10 +90,14 @@ Create or update a Wealthbox note | ↳ `noteId` | string | ID of the created/updated note | | ↳ `itemType` | string | Type of item \(note\) | + + ### Read Wealthbox Contact Read content from a Wealthbox contact + + #### Input | Parameter | Type | Required | Description | @@ -106,10 +117,14 @@ Read content from a Wealthbox contact | ↳ `contactId` | string | ID of the contact | | ↳ `itemType` | string | Type of item \(contact\) | + + ### Write Wealthbox Contact Create a new Wealthbox contact + + #### Input | Parameter | Type | Required | Description | @@ -132,10 +147,14 @@ Create a new Wealthbox contact | ↳ `contactId` | string | ID of the created/updated contact | | ↳ `itemType` | string | Type of item \(contact\) | + + ### Read Wealthbox Task Read content from a Wealthbox task + + #### Input | Parameter | Type | Required | Description | @@ -155,10 +174,14 @@ Read content from a Wealthbox task | ↳ `taskId` | string | ID of the task | | ↳ `itemType` | string | Type of item \(task\) | + + ### Write Wealthbox Task Create or update a Wealthbox task + + #### Input | Parameter | Type | Required | Description | @@ -181,4 +204,6 @@ Create or update a Wealthbox task | ↳ `taskId` | string | ID of the created/updated task | | ↳ `itemType` | string | Type of item \(task\) | + + diff --git a/apps/docs/content/docs/integrations/webflow.mdx b/apps/docs/content/docs/integrations/webflow.mdx index c300b87fae0..f557bf5a8b2 100644 --- a/apps/docs/content/docs/integrations/webflow.mdx +++ b/apps/docs/content/docs/integrations/webflow.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use [Webflow](https://webflow.com/) in Sim to create, retrieve, list, update, and delete CMS collection items. Webflow event triggers can start workflows when collection items change or forms are submitted. See [Site Tokens](/integrations/webflow-service-account) for token setup. {/* MANUAL-CONTENT-END */} - Connection guides: [Site tokens](/integrations/webflow-service-account). ## OAuth scopes [#oauth-scopes] @@ -41,6 +42,8 @@ Create, get, list, update, or delete items in Webflow CMS collections. Manage yo List items from a Webflow CMS collection + + #### Input | Parameter | Type | Required | Description | @@ -69,10 +72,14 @@ List items from a Webflow CMS collection | ↳ `limit` | number | Maximum items per page | | ↳ `total` | number | Total number of matching items | + + ### Webflow Get Item Get a single item from a Webflow CMS collection + + #### Input | Parameter | Type | Required | Description | @@ -88,10 +95,14 @@ Get a single item from a Webflow CMS collection | `item` | json | The retrieved item object | | `metadata` | json | Metadata about the retrieved item | + + ### Webflow Create Item Create a new item in a Webflow CMS collection + + #### Input | Parameter | Type | Required | Description | @@ -107,10 +118,14 @@ Create a new item in a Webflow CMS collection | `item` | json | The created item object | | `metadata` | json | Metadata about the created item | + + ### Webflow Update Item Update an existing item in a Webflow CMS collection + + #### Input | Parameter | Type | Required | Description | @@ -127,10 +142,14 @@ Update an existing item in a Webflow CMS collection | `item` | json | The updated item object | | `metadata` | json | Metadata about the updated item | + + ### Webflow Delete Item Delete an item from a Webflow CMS collection + + #### Input | Parameter | Type | Required | Description | @@ -146,6 +165,8 @@ Delete an item from a Webflow CMS collection | `success` | boolean | Whether the deletion was successful | | `metadata` | json | Metadata about the deletion | + + ## Triggers @@ -156,6 +177,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger workflow when an item is updated in a Webflow CMS collection (requires Webflow credentials) + + #### Configuration | Parameter | Type | Required | Description | @@ -180,13 +203,14 @@ Trigger workflow when an item is updated in a Webflow CMS collection (requires W | ↳ `isDraft` | boolean | Whether the item is a draft | | ↳ `fieldData` | object | The updated field data of the item | - ---- + ### Collection Item Created Trigger workflow when a new item is created in a Webflow CMS collection (requires Webflow credentials) + + #### Configuration | Parameter | Type | Required | Description | @@ -211,13 +235,14 @@ Trigger workflow when a new item is created in a Webflow CMS collection (require | ↳ `isDraft` | boolean | Whether the item is a draft | | ↳ `fieldData` | object | The field data of the item | - ---- + ### Collection Item Deleted Trigger workflow when an item is deleted from a Webflow CMS collection (requires Webflow credentials) + + #### Configuration | Parameter | Type | Required | Description | @@ -236,13 +261,14 @@ Trigger workflow when an item is deleted from a Webflow CMS collection (requires | ↳ `id` | string | The ID of the deleted item | | ↳ `deletedOn` | string | Timestamp when the item was deleted | - ---- + ### Form Submission Trigger workflow when a form is submitted on a Webflow site (requires Webflow credentials) + + #### Configuration | Parameter | Type | Required | Description | @@ -267,3 +293,5 @@ Trigger workflow when a form is submitted on a Webflow site (requires Webflow cr | ↳ `fieldElementId` | string | Unique identifier for the form element \(UUID\) | | `formElementId` | string | The form element ID | + + diff --git a/apps/docs/content/docs/integrations/wikipedia.mdx b/apps/docs/content/docs/integrations/wikipedia.mdx index 0da74c78e12..82873f3f832 100644 --- a/apps/docs/content/docs/integrations/wikipedia.mdx +++ b/apps/docs/content/docs/integrations/wikipedia.mdx @@ -76,6 +76,8 @@ Get a summary and metadata for a specific Wikipedia page. Search for Wikipedia pages by title or content. + + #### Input | Parameter | Type | Required | Description | @@ -105,10 +107,14 @@ Search for Wikipedia pages by title or content. | `totalHits` | number | Total number of search results found | | `query` | string | The search query that was executed | + + ### Wikipedia Page Content Get the full HTML content of a Wikipedia page. + + #### Input | Parameter | Type | Required | Description | @@ -129,10 +135,14 @@ Get the full HTML content of a Wikipedia page. | ↳ `content_model` | string | Content model \(wikitext\) | | ↳ `content_format` | string | Content format \(text/html\) | + + ### Wikipedia Random Page Get a random Wikipedia page. + + #### Input | Parameter | Type | Required | Description | @@ -161,4 +171,6 @@ Get a random Wikipedia page. | ↳ `timestamp` | string | Timestamp | | ↳ `pageid` | number | Page ID | + + diff --git a/apps/docs/content/docs/integrations/wiza.mdx b/apps/docs/content/docs/integrations/wiza.mdx index aa7f1f1fdd1..3c8f25b16f8 100644 --- a/apps/docs/content/docs/integrations/wiza.mdx +++ b/apps/docs/content/docs/integrations/wiza.mdx @@ -202,6 +202,8 @@ Reveal a contact by LinkedIn URL, name plus company/domain, or email. Starts the Retrieve the remaining credits on your Wiza account + + #### Input | Parameter | Type | Required | Description | @@ -217,4 +219,6 @@ Retrieve the remaining credits on your Wiza account | `export_credits` | number | Remaining export credits | | `api_credits` | number | Remaining API credits | + + diff --git a/apps/docs/content/docs/integrations/zerobounce.mdx b/apps/docs/content/docs/integrations/zerobounce.mdx index d39a881782b..42326188d92 100644 --- a/apps/docs/content/docs/integrations/zerobounce.mdx +++ b/apps/docs/content/docs/integrations/zerobounce.mdx @@ -6,12 +6,13 @@ integration: color: "#FFFFFF" --- +import { ReferenceDetails } from "@/components/ui/reference-details" + {/* MANUAL-CONTENT-START:intro */} Use ZeroBounce to validate one email address or check remaining validation credits. Inspect the returned status for invalid, catch-all, spamtrap, abuse, or do-not-mail addresses before using the contact in an outreach workflow. {/* MANUAL-CONTENT-END */} - ## Use the block [#usage-instructions] Integrate ZeroBounce to validate email deliverability in real time — detect invalid, catch-all, spamtrap, abuse, and do-not-mail addresses — and check your remaining validation credits. @@ -22,6 +23,8 @@ Integrate ZeroBounce to validate email deliverability in real time — detect in Validate an email address deliverability in real time. Uses one validation credit. + + #### Input | Parameter | Type | Required | Description | @@ -40,10 +43,14 @@ Validate an email address deliverability in real time. Uses one validation credi | `freeEmail` | boolean | Whether the address is on a free email provider | | `didYouMean` | string | Suggested correction for a likely typo | + + ### ZeroBounce Get Credits Retrieve the remaining validation credits for the authenticated account. + + #### Input | Parameter | Type | Required | Description | @@ -56,4 +63,6 @@ Retrieve the remaining validation credits for the authenticated account. | --------- | ---- | ----------- | | `credits` | number | Remaining validation credits \(-1 if unavailable\) | + + diff --git a/apps/docs/content/docs/integrations/zoho_desk.mdx b/apps/docs/content/docs/integrations/zoho_desk.mdx index d4a7721bacd..260d52aaad7 100644 --- a/apps/docs/content/docs/integrations/zoho_desk.mdx +++ b/apps/docs/content/docs/integrations/zoho_desk.mdx @@ -1799,6 +1799,8 @@ A trigger starts a workflow when a supported event occurs in this service. Trigger a workflow when a Zoho Desk event occurs (ticket, comment, thread, contact, agent, task, or article changes). + + #### Configuration | Parameter | Type | Required | Description | @@ -1821,3 +1823,5 @@ Trigger a workflow when a Zoho Desk event occurs (ticket, comment, thread, conta | `payload` | json | The full resource that changed \(ticket, comment, thread, etc.\). Comment and thread events gain a derived plain-text `contentText` alongside the raw `content` + `contentType`; ticket events gain `descriptionText` alongside `description`. | | `prevState` | json | Previous state of the resource \(update events only\) | + + diff --git a/apps/docs/content/docs/integrations/zoom.mdx b/apps/docs/content/docs/integrations/zoom.mdx index 91f43ee280a..bdc7f802c83 100644 --- a/apps/docs/content/docs/integrations/zoom.mdx +++ b/apps/docs/content/docs/integrations/zoom.mdx @@ -550,6 +550,8 @@ Trigger workflow when a Zoom meeting starts Trigger workflow when a participant joins a Zoom meeting + + #### Configuration | Parameter | Type | Required | Description | @@ -579,13 +581,14 @@ Trigger workflow when a participant joins a Zoom meeting | ↳ `leave_time` | string | Time participant left \(ISO 8601, present on participant_left\) | | ↳ `duration` | number | Seconds the participant was in the meeting \(when provided\) | - ---- + ### Zoom Participant Left Trigger workflow when a participant leaves a Zoom meeting + + #### Configuration | Parameter | Type | Required | Description | @@ -615,13 +618,14 @@ Trigger workflow when a participant leaves a Zoom meeting | ↳ `leave_time` | string | Time participant left \(ISO 8601, present on participant_left\) | | ↳ `duration` | number | Seconds the participant was in the meeting \(when provided\) | - ---- + ### Zoom Recording Completed Trigger workflow when a Zoom cloud recording is completed + + #### Configuration | Parameter | Type | Required | Description | @@ -652,13 +656,14 @@ Trigger workflow when a Zoom cloud recording is completed | ↳ `share_url` | string | URL to share the recording | | ↳ `recording_files` | json | Array of recording file objects \(e.g. id, file_type, play_url, download_url\) per Zoom cloud recording payloads | - ---- + ### Zoom Webhook (All Events) Trigger workflow on any Zoom webhook event + + #### Configuration | Parameter | Type | Required | Description | @@ -673,3 +678,5 @@ Trigger workflow on any Zoom webhook event | `event_ts` | number | Unix timestamp in milliseconds when the event occurred | | `payload` | json | Complete webhook payload \(structure varies by event type\) | + + diff --git a/apps/docs/content/docs/integrations/zoominfo.mdx b/apps/docs/content/docs/integrations/zoominfo.mdx index e1028c1a025..aedf441c1ba 100644 --- a/apps/docs/content/docs/integrations/zoominfo.mdx +++ b/apps/docs/content/docs/integrations/zoominfo.mdx @@ -109,6 +109,8 @@ Search ZoomInfo for contacts (people) by name, job title, company, and other fil Enrich up to 25 companies in one request with detailed firmographics, industry, financials, and more. + + #### Input | Parameter | Type | Required | Description | @@ -124,10 +126,14 @@ Enrich up to 25 companies in one request with detailed firmographics, industry, | --------- | ---- | ----------- | | `results` | array | Enrichment results, one per input with match status and attributes | + + ### ZoomInfo Enrich Contacts Enrich up to 25 contacts in one request with verified emails, phone numbers, job details, and more. + + #### Input | Parameter | Type | Required | Description | @@ -144,10 +150,14 @@ Enrich up to 25 contacts in one request with verified emails, phone numbers, job | --------- | ---- | ----------- | | `results` | array | Enrichment results, one per input with match status and attributes | + + ### ZoomInfo Search Intent Search for companies showing intent signals on specific topics. + + #### Input | Parameter | Type | Required | Description | @@ -177,10 +187,14 @@ Search for companies showing intent signals on specific topics. | `currentPage` | number | Current page number | | `totalPages` | number | Total number of pages available | + + ### ZoomInfo Search News Search ZoomInfo news articles by category, URL, or date range. + + #### Input | Parameter | Type | Required | Description | @@ -203,4 +217,6 @@ Search ZoomInfo news articles by category, URL, or date range. | `currentPage` | number | Current page number | | `totalPages` | number | Total number of pages available | + + diff --git a/apps/docs/scripts/test-navigation-e2e.ts b/apps/docs/scripts/test-navigation-e2e.ts index b817e80c227..327a12d96b8 100644 --- a/apps/docs/scripts/test-navigation-e2e.ts +++ b/apps/docs/scripts/test-navigation-e2e.ts @@ -1435,6 +1435,92 @@ try { const interactive = await browser.newContext({ viewport: { width: 1440, height: 1000 } }) try { + await check('Docs reference: wrapped sidebar labels stay left aligned', async () => { + const page = await interactive.newPage() + try { + for (const width of [1440, 390]) { + await page.setViewportSize({ width, height: 900 }) + await open(page, '/integrations/zoominfo') + if (width < 1024) await page.getByRole('button', { name: 'Menu', exact: true }).click() + const guide = page.getByRole('button', { name: /Shared credential guides/ }) + await guide.scrollIntoViewIfNeeded() + const lines = await guide.locator('span').evaluate((element) => { + const range = document.createRange() + range.selectNodeContents(element) + return [...range.getClientRects()].map((rect) => ({ + left: rect.left, + labelLeft: element.getBoundingClientRect().left, + })) + }) + expect(lines.length).toBeGreaterThan(width >= 1024 ? 1 : 0) + for (const line of lines) expect(Math.abs(line.left - line.labelLeft)).toBeLessThan(1) + await page.screenshot({ path: join(directory, `sidebar-wrapped-label-${width}.png`) }) + if (width < 1024) await page.keyboard.press('Escape') + } + } finally { + await page.close() + } + }) + for (const path of ['/integrations/zoom', '/integrations/zoominfo']) { + await check(`Docs reference: field tables start collapsed on ${path}`, async () => { + const page = await interactive.newPage() + try { + await open(page, path) + const tables = page.locator('article table').filter({ + has: page.getByRole('columnheader', { + name: 'Parameter', + exact: true, + includeHidden: true, + }), + }) + expect(await tables.count()).toBeGreaterThan(0) + for (const table of await tables.all()) await expect(table).toBeHidden() + const disclosures = page.locator('article details') + for (const disclosure of await disclosures.all()) { + const summary = disclosure.locator(':scope > summary') + await summary.click() + await expect(disclosure.getByRole('table').first()).toBeVisible() + await summary.focus() + await page.keyboard.press('Enter') + await expect(disclosure.getByRole('table').first()).toBeHidden() + } + await page.screenshot({ + path: join(directory, `${path.split('/').at(-1)}-collapsed.png`), + }) + } finally { + await page.close() + } + }) + } + await check('Docs reference: TOC hover keeps a single active underline', async () => { + const page = await interactive.newPage() + try { + for (const theme of ['light', 'dark'] as const) { + await page.emulateMedia({ colorScheme: theme }) + await open(page, '/getting-started') + const toc = page + .getByRole('navigation', { name: 'On this page' }) + .filter({ visible: true }) + const link = toc.getByRole('link', { name: 'Create a workflow', exact: true }) + await link.click() + await expect(link).toHaveAttribute('aria-current', 'location') + await expect + .poll(() => link.evaluate((element) => getComputedStyle(element).textDecorationLine)) + .toBe('underline') + const next = toc.getByRole('link', { name: 'Next steps', exact: true }) + await next.hover() + await next.evaluate((element) => + Promise.all(element.getAnimations().map((animation) => animation.finished)) + ) + await expect + .poll(() => next.evaluate((element) => getComputedStyle(element).backgroundColor)) + .toBe('rgba(0, 0, 0, 0)') + await page.screenshot({ path: join(directory, `toc-hover-${theme}.png`) }) + } + } finally { + await page.close() + } + }) await check( 'Docs polish: nested TOC anchors track the selected section across breakpoints', async () => { diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts index a159af57d25..78664c52c64 100755 --- a/scripts/generate-docs.ts +++ b/scripts/generate-docs.ts @@ -4661,12 +4661,8 @@ async function generateMarkdownForBlock( } else { fields += 'No output fields are documented for this action.\n' } - if (tools.access.length > 6 || (fields.match(/^\|/gm)?.length ?? 0) > 24) { - hasReferenceDetails = true - toolsSection += `\n\n${fields}\n\n` - } else { - toolsSection += fields - } + hasReferenceDetails = true + toolsSection += `\n\n${fields}\n\n` } toolsSection += '\n' @@ -5329,9 +5325,7 @@ function buildTriggersSection(triggers: TriggerFullInfo[]): string { } let triggersSection = '' - for (let i = 0; i < triggers.length; i++) { - const trigger = triggers[i] - + for (const trigger of triggers) { let configSection = '' if (trigger.configFields.length > 0) { configSection = '#### Configuration\n\n' @@ -5355,17 +5349,13 @@ function buildTriggersSection(triggers: TriggerFullInfo[]): string { } const fields = configSection + outputSection - const foldFields = - fields.length > 0 && (triggers.length > 6 || (fields.match(/^\|/gm)?.length ?? 0) > 24) - const separator = !foldFields && i < triggers.length - 1 ? '\n---\n\n' : '' - triggersSection += `### ${trigger.name}\n\n` const escapedTriggerDescription = escapeMdxProse(trigger.description) triggersSection += `${escapedTriggerDescription}\n\n` - triggersSection += foldFields - ? `\n\n${fields}\n\n` - : fields - triggersSection += separator + triggersSection += + fields.length > 0 + ? `\n\n${fields}\n\n` + : fields } return `## Triggers From c9345cea811cd20c7f4baa27e9eb520526e6216e Mon Sep 17 00:00:00 2001 From: Waleed Latif Date: Thu, 5 Nov 2026 22:24:36 -0800 Subject: [PATCH 2/2] fix(docs): cover ToC hover color and underline invariants --- apps/docs/scripts/test-navigation-e2e.ts | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/apps/docs/scripts/test-navigation-e2e.ts b/apps/docs/scripts/test-navigation-e2e.ts index 327a12d96b8..81b193b4060 100644 --- a/apps/docs/scripts/test-navigation-e2e.ts +++ b/apps/docs/scripts/test-navigation-e2e.ts @@ -1508,6 +1508,7 @@ try { .poll(() => link.evaluate((element) => getComputedStyle(element).textDecorationLine)) .toBe('underline') const next = toc.getByRole('link', { name: 'Next steps', exact: true }) + const color = await next.evaluate((element) => getComputedStyle(element).color) await next.hover() await next.evaluate((element) => Promise.all(element.getAnimations().map((animation) => animation.finished)) @@ -1515,6 +1516,21 @@ try { await expect .poll(() => next.evaluate((element) => getComputedStyle(element).backgroundColor)) .toBe('rgba(0, 0, 0, 0)') + await expect(next).toHaveCSS('color', color) + await expect(next).toHaveCSS('text-decoration-line', 'none') + await expect + .poll(() => + toc + .getByRole('link') + .filter({ visible: true }) + .evaluateAll( + (links) => + links.filter((element) => + getComputedStyle(element).textDecorationLine.includes('underline') + ).length + ) + ) + .toBe(1) await page.screenshot({ path: join(directory, `toc-hover-${theme}.png`) }) } } finally {