diff --git a/apps/docs/components/ui/icon-mapping.ts b/apps/docs/components/ui/icon-mapping.ts index af90c3f47e6..8cb22d94449 100644 --- a/apps/docs/components/ui/icon-mapping.ts +++ b/apps/docs/components/ui/icon-mapping.ts @@ -332,23 +332,31 @@ type IconComponent = ComponentType> export const blockTypeToIconMap: Record = { a2a: A2AIcon, affinity: AffinityIcon, + affinity_v2: AffinityIcon, agent: AgentIcon, agentmail: AgentMailIcon, + agentmail_v2: AgentMailIcon, agentphone: AgentPhoneIcon, + agentphone_v2: AgentPhoneIcon, agiloft: AgiloftIcon, ahrefs: AhrefsIcon, + ahrefs_v2: AhrefsIcon, airtable: AirtableIcon, algolia: AlgoliaIcon, amplitude: AmplitudeIcon, api: ApiIcon, api_trigger: ApiIcon, apify: ApifyIcon, + apify_v2: ApifyIcon, apollo: ApolloIcon, + apollo_v2: ApolloIcon, appconfig: AppConfigIcon, + appconfig_v2: AppConfigIcon, arxiv: ArxivIcon, asana: AsanaIcon, ashby: AshbyIcon, athena: AthenaIcon, + athena_v2: AthenaIcon, attio: AttioIcon, azure_data_explorer: AzureDataExplorerIcon, azure_devops: AzureIcon, @@ -357,25 +365,36 @@ export const blockTypeToIconMap: Record = { box_v2: BoxCompanyIcon, brandfetch: BrandfetchIcon, brex: BrexIcon, + brex_v2: BrexIcon, brightdata: BrightDataIcon, + brightdata_v2: BrightDataIcon, browser_use: BrowserUseIcon, + browser_use_v2: BrowserUseIcon, buffer: BufferIcon, + buffer_v2: BufferIcon, calcom: CalComIcon, calendly: CalendlyIcon, cbinsights: CbInsightsIcon, chat_trigger: Task, checkr: CheckrIcon, circleback: CirclebackIcon, + circleback_v2: CirclebackIcon, clay: ClayIcon, clerk: ClerkIcon, + clerk_v2: ClerkIcon, clickhouse: ClickHouseIcon, clickup: ClickUpIcon, cloudflare: CloudflareIcon, + cloudflare_v2: CloudflareIcon, cloudformation: CloudFormationIcon, + cloudformation_v2: CloudFormationIcon, cloudtrail: CloudTrailIcon, + cloudtrail_v2: CloudTrailIcon, cloudwatch: CloudWatchIcon, + cloudwatch_v2: CloudWatchIcon, coda: CodaIcon, codepipeline: CodePipelineIcon, + codepipeline_v2: CodePipelineIcon, condition: ConditionalIcon, confluence: ConfluenceIcon, confluence_v2: ConfluenceIcon, @@ -385,16 +404,21 @@ export const blockTypeToIconMap: Record = { credential_group: GridOffset, crowdstrike: CrowdStrikeIcon, crunchbase: CrunchbaseIcon, + crunchbase_v2: CrunchbaseIcon, cursor: CursorIcon, cursor_v2: CursorIcon, + cursor_v3: CursorIcon, dagster: DagsterIcon, databricks: DatabricksIcon, + databricks_v2: DatabricksIcon, datadog: DatadogIcon, datagma: DatagmaIcon, daytona: DaytonaIcon, + daytona_v2: DaytonaIcon, deployments: Rocket, devin: DevinIcon, discord: DiscordIcon, + discord_v2: DiscordIcon, docusign: DocuSignIcon, downdetector: DowndetectorIcon, dropbox: DropboxIcon, @@ -403,21 +427,27 @@ export const blockTypeToIconMap: Record = { dspy: DsPyIcon, dub: DubIcon, dub_v2: DubIcon, + dub_v3: DubIcon, duckduckgo: DuckDuckGoIcon, dynamodb: DynamoDBIcon, + dynamodb_v2: DynamoDBIcon, dynatrace: DynatraceIcon, ec2: EC2Icon, + ec2_v2: EC2Icon, elasticsearch: ElasticsearchIcon, elevenlabs: ElevenLabsIcon, + elevenlabs_v2: ElevenLabsIcon, emailbison: EmailBisonIcon, embeddings: EmbeddingsIcon, enrich: EnrichSoIcon, + enrich_v2: EnrichSoIcon, enrichment: EnrichmentIcon, enrow: EnrowIcon, evaluator: ChartBarIcon, exa: ExaAIIcon, extend: ExtendIcon, extend_v2: ExtendIcon, + extend_v3: ExtendIcon, fathom: FathomIcon, file: DocumentIcon, file_v2: DocumentIcon, @@ -428,11 +458,14 @@ export const blockTypeToIconMap: Record = { firecrawl: FirecrawlIcon, fireflies: FirefliesIcon, fireflies_v2: FirefliesIcon, + fireflies_v3: FirefliesIcon, fivetran: FivetranIcon, flint: FlintIcon, + flint_v2: FlintIcon, flow: FlowIcon, function: CodeIcon, gamma: GammaIcon, + gamma_v2: GammaIcon, gauge: GaugeIcon, generic: WebhookIcon, generic_webhook: Webhook, @@ -478,24 +511,31 @@ export const blockTypeToIconMap: Record = { harmonic: HarmonicIcon, helpscout: HelpScoutIcon, hex: HexIcon, + hex_v2: HexIcon, higgsfield: HiggsfieldIcon, hubspot: HubspotIcon, huggingface: HuggingFaceIcon, + huggingface_v2: HuggingFaceIcon, human_in_the_loop: HumanInTheLoopIcon, human_in_the_loop_v2: HumanInTheLoopIcon, hunter: HunterIOIcon, iam: IAMIcon, + iam_v2: IAMIcon, icypeas: IcypeasIcon, identity_center: IdentityCenterIcon, + identity_center_v2: IdentityCenterIcon, image_generator: ImageIcon, image_generator_v2: ImageIcon, imap: MailServerIcon, incidentio: IncidentioIcon, + incidentio_v2: IncidentioIcon, infisical: InfisicalIcon, input_trigger: FormInput, instantly: InstantlyIcon, + instantly_v2: InstantlyIcon, intercom: IntercomIcon, intercom_v2: IntercomIcon, + intercom_v3: IntercomIcon, intune: IntuneIcon, jama: JamaIcon, jina: JinaAIIcon, @@ -510,9 +550,12 @@ export const blockTypeToIconMap: Record = { ketch: KetchIcon, knowledge: PackageSearchIcon, lambda: LambdaIcon, + lambda_v2: LambdaIcon, langsmith: LangsmithIcon, + langsmith_v2: LangsmithIcon, latex: LatexIcon, launchdarkly: LaunchDarklyIcon, + launchdarkly_v2: LaunchDarklyIcon, leadmagic: LeadMagicIcon, lemlist: LemlistIcon, linear: LinearIcon, @@ -520,19 +563,24 @@ export const blockTypeToIconMap: Record = { linkedin: LinkedInIcon, linkup: LinkupIcon, linq: LinqIcon, + linq_v2: LinqIcon, logfire: LogfireIcon, logrocket: LogRocketIcon, logs: Library, logs_v2: Library, loops: LoopsIcon, + loops_v2: LoopsIcon, luma: LumaIcon, + luma_v2: LumaIcon, mailchimp: MailchimpIcon, + mailchimp_v2: MailchimpIcon, mailgun: MailgunIcon, managed_agent: ClaudeIcon, manageengine_sdp: ManageEngineIcon, manual_trigger: Play, mcp: McpIcon, mem0: Mem0Icon, + mem0_v2: Mem0Icon, memory: BrainIcon, microsoft_ad: AzureIcon, microsoft_dataverse: MicrosoftDataverseIcon, @@ -571,12 +619,14 @@ export const blockTypeToIconMap: Record = { oracle_fusion_financials: OracleIcon, oracledb: OracleIcon, otter: OtterIcon, + otter_v2: OtterIcon, outlook: OutlookIcon, pagerduty: PagerDutyIcon, parallel_ai: ParallelIcon, peopledatalabs: PeopleDataLabsIcon, perplexity: PerplexityIcon, persona: PersonaIcon, + persona_v2: PersonaIcon, pi: PiIcon, pinecone: PineconeIcon, pipedrive: PipedriveIcon, @@ -588,33 +638,43 @@ export const blockTypeToIconMap: Record = { posthog: PosthogIcon, powerbi: PowerBIIcon, profound: ProfoundIcon, + profound_v2: ProfoundIcon, prospeo: ProspeoIcon, pulse: PulseIcon, pulse_v2: PulseIcon, + pulse_v3: PulseIcon, qdrant: QdrantIcon, quartr: QuartrIcon, + quartr_v2: QuartrIcon, quickbooks: QuickBooksIcon, quiver: QuiverIcon, quiver_v2: QuiverIcon, + quiver_v3: QuiverIcon, rabbitmq: RabbitmqIcon, railway: RailwayIcon, ramp: RampIcon, rb2b: RB2BIcon, + rb2b_v2: RB2BIcon, rds: RDSIcon, + rds_v2: RDSIcon, reddit: RedditIcon, redis: RedisIcon, reducto: ReductoIcon, reducto_v2: ReductoIcon, + reducto_v3: ReductoIcon, resend: ResendIcon, response: ResponseIcon, revenuecat: RevenueCatIcon, rippling: RipplingIcon, + rippling_v2: RipplingIcon, rocketlane: RocketlaneIcon, + rocketlane_v2: RocketlaneIcon, rootly: RootlyIcon, router: ConnectIcon, router_v2: ConnectIcon, rss: RssIcon, s3: S3Icon, + s3_v2: S3Icon, sailpoint: SailPointIcon, salesforce: SalesforceIcon, sap_concur: SapConcurIcon, @@ -622,14 +682,17 @@ export const blockTypeToIconMap: Record = { schedule: Clock, search: SearchIcon, secrets_manager: SecretsManagerIcon, + secrets_manager_v2: SecretsManagerIcon, semrush: SemrushIcon, sendblue: SendblueIcon, sendgrid: SendgridIcon, + sendgrid_v2: SendgridIcon, sentry: SentryIcon, serper: SerperIcon, servicenow: ServiceNowIcon, servicenow_v2: ServiceNowIcon, ses: SESIcon, + ses_v2: SESIcon, sftp: SftpIcon, sftp_v2: SftpIcon, sharepoint: MicrosoftSharepointIcon, @@ -637,36 +700,47 @@ export const blockTypeToIconMap: Record = { shopify: ShopifyIcon, sim_workspace_event: SimTriggerIcon, similarweb: SimilarwebIcon, + similarweb_v2: SimilarwebIcon, sixtyfour: SixtyfourIcon, + sixtyfour_v2: SixtyfourIcon, slack: SlackIcon, slack_app: SlackIcon, slack_v2: SlackIcon, smartlead: SmartleadIcon, + smartlead_v2: SmartleadIcon, smtp: SmtpIcon, snowflake: SnowflakeIcon, splunk: SplunkIcon, sportmonks: SportmonksIcon, + sportmonks_v2: SportmonksIcon, sqs: SQSIcon, + sqs_v2: SQSIcon, square: SquareIcon, + square_v2: SquareIcon, ssh: SshIcon, ssh_v2: SshIcon, ssm: SSMIcon, + ssm_v2: SSMIcon, stagehand: StagehandIcon, start_trigger: StartIcon, starter: StartIcon, stripe: StripeIcon, sts: STSIcon, + sts_v2: STSIcon, stt: STTIcon, stt_v2: STTIcon, supabase: SupabaseIcon, table: Table, table_v2: Table, tailscale: TailscaleIcon, + tailscale_v2: TailscaleIcon, tavily: TavilyIcon, + tavily_v2: TavilyIcon, telegram: TelegramIcon, temporal: TemporalIcon, textract: TextractIcon, textract_v2: TextractIcon, + textract_v3: TextractIcon, thinking: BrainIcon, thrive: ThriveIcon, tiktok: TikTokIcon, @@ -675,6 +749,7 @@ export const blockTypeToIconMap: Record = { translate: TranslateIcon, trello: TrelloIcon, trigger_dev: TriggerDevIcon, + trigger_dev_v2: TriggerDevIcon, tts: TTSIcon, twilio: TwilioIcon, twilio_sms: TwilioIcon, @@ -682,6 +757,7 @@ export const blockTypeToIconMap: Record = { typeform: TypeformIcon, upstash: UpstashIcon, uptimerobot: UptimeRobotIcon, + uptimerobot_v2: UptimeRobotIcon, vanta: VantaIcon, variables: VariableIcon, vercel: VercelIcon, @@ -704,9 +780,12 @@ export const blockTypeToIconMap: Record = { workflow_input: WorkflowIcon, x: xIcon, youcom: YouComIcon, + youcom_v2: YouComIcon, youtube: YouTubeIcon, + youtube_v2: YouTubeIcon, zendesk: ZendeskIcon, zep: ZepIcon, + zep_v2: ZepIcon, zerobounce: ZeroBounceIcon, zoho_desk: ZohoDeskIcon, zoom: ZoomIcon, diff --git a/apps/docs/content/docs/cli/reference.mdx b/apps/docs/content/docs/cli/reference.mdx index ab5fbae41b5..75c80cfc054 100644 --- a/apps/docs/content/docs/cli/reference.mdx +++ b/apps/docs/content/docs/cli/reference.mdx @@ -5103,7 +5103,7 @@ sim selectors get [options] | Option | Required | Description | | --- | --- | --- | -| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | +| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `cloudwatch.savedLogGroups`, `cloudwatch.savedLogStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. Defaults to {}. (JSON, or @path / @- to read a file or stdin). | | `--id ` | Yes | Provider option ID to resolve with the same selector and declared context. | @@ -5125,7 +5125,7 @@ sim selectors list [options] | Option | Required | Description | | --- | --- | --- | -| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | +| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `cloudwatch.savedLogGroups`, `cloudwatch.savedLogStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. Defaults to {}. (JSON, or @path / @- to read a file or stdin). | | `--search ` | No | Provider option search text. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | diff --git a/apps/docs/content/docs/cli/selectors.mdx b/apps/docs/content/docs/cli/selectors.mdx index f444991a7ed..368e237b9d9 100644 --- a/apps/docs/content/docs/cli/selectors.mdx +++ b/apps/docs/content/docs/cli/selectors.mdx @@ -25,7 +25,7 @@ sim selectors list [options] | Option | Required | Description | | --- | --- | --- | -| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | +| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `cloudwatch.savedLogGroups`, `cloudwatch.savedLogStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. Defaults to {}. (JSON, or @path / @- to read a file or stdin). | | `--search ` | No | Provider option search text. | | `--cursor ` | No | Continue from nextCursor returned by a previous result. | @@ -49,7 +49,7 @@ sim selectors get [options] | Option | Required | Description | | --- | --- | --- | -| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | +| `--selector-key ` | Yes | Registered selector key from an import or sync preview, such as `gmail.labels`. Accepted values: `airtable.bases`, `airtable.tables`, `asana.workspaces`, `attio.lists`, `attio.objects`, `bigquery.datasets`, `bigquery.tables`, `bitbucket.workspaces`, `bitbucket.repositories`, `calcom.eventTypes`, `calcom.schedules`, `clickup.workspaces`, `clickup.spaces`, `clickup.folders`, `clickup.lists`, `coda.docs`, `coda.pages`, `coda.tables`, `coda.columns`, `coda.rows`, `coda.formulas`, `coda.controls`, `coda.folders`, `coda.permissions`, `confluence.spaces`, `confluence.spacesById`, `confluence.pages`, `google.tasks.lists`, `gauge.organizations`, `gauge.categories`, `gauge.topics`, `gauge.prompts`, `gauge.tags`, `gauge.answers`, `fivetran.groups`, `fivetran.connections`, `gmail.labels`, `google.calendar`, `google.drive`, `google.sheets`, `harmonic.savedSearches`, `jama.projects`, `jama.itemTypes`, `flow.projects`, `flow.categories`, `flow.branches`, `helpscout.mailboxes`, `helpscout.assignees`, `hubspot.lists`, `hubspot.owners`, `hubspot.pipelines`, `hubspot.pipelineStages`, `hubspot.properties`, `jsm.requestTypes`, `jsm.serviceDesks`, `microsoft.planner.plans`, `notion.databases`, `notion.pages`, `netsuite.recordTypes`, `netsuite.asyncTasks`, `pipedrive.pipelines`, `sharepoint.lists`, `trello.boards`, `zoho_desk.organizations`, `zoho_desk.departments`, `zoho_desk.agents`, `zoom.meetings`, `slack.channels`, `snowflake.databases`, `snowflake.schemas`, `snowflake.tables`, `snowflake.warehouses`, `snowflake.roles`, `snowflake.fileFormats`, `snowflake.procedures`, `slack.users`, `outlook.folders`, `outlook.calendars`, `microsoft.teams`, `microsoft.chats`, `microsoft.channels`, `microsoft.planner`, `onedrive.files`, `onedrive.folders`, `sharepoint.sites`, `microsoft.excel`, `microsoft.excel.drives`, `microsoft.excel.sheets`, `microsoft.word`, `wealthbox.contacts`, `jira.issues`, `jira.projects`, `jira.projectKeys`, `linear.projects`, `linear.teams`, `monday.boards`, `monday.groups`, `webflow.sites`, `webflow.collections`, `webflow.items`, `planetscale.databases`, `powerbi.workspaces`, `powerbi.datasets`, `powerbi.reports`, `planetscale.branches`, `planetscale.backups`, `planetscale.deployRequests`, `cloudwatch.logGroups`, `cloudwatch.logStreams`, `cloudwatch.savedLogGroups`, `cloudwatch.savedLogStreams`, `imap.mailboxes`, `mcp.tools`, `managedAgent.agents`, `managedAgent.environments`, `managedAgent.vaults`, `managedAgent.memoryStores`, `knowledge.documents`, `sim.workflows`, `table.columns`, `table.outputColumns`, `workspace.secretNames`, `workspace.sandboxes`, `providers.ollamaEmbeddingModels`, `providers.openrouterEmbeddingModels`. | | `--context ` | No | Only the dependencies declared by the selector, such as oauthCredential and channelId. Missing OAuth connections require human authorization. Defaults to {}. (JSON, or @path / @- to read a file or stdin). | | `--id ` | Yes | Provider option ID to resolve with the same selector and declared context. | diff --git a/apps/docs/content/docs/integrations/affinity.mdx b/apps/docs/content/docs/integrations/affinity.mdx index c79019c664e..b5046eae52f 100644 --- a/apps/docs/content/docs/integrations/affinity.mdx +++ b/apps/docs/content/docs/integrations/affinity.mdx @@ -2,7 +2,7 @@ title: Affinity description: Read and write companies, people, lists, notes, and relationships in Affinity integration: - type: "affinity" + type: "affinity_v2" color: "#1B1C1E" --- @@ -40,7 +40,6 @@ Write up to 100 non-list field values on one company or person in a single reque | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity to write the fields on: companies or persons | | `entityId` | string | Yes | ID of that company or person | | `updates` | json | Yes | Up to 100 field updates as \[\{"id":"<fieldId>","value":\{"type":"…","data":…\}\}\], using the same value shapes as a single field update | @@ -63,7 +62,6 @@ Write up to 100 field values on one list row in a single request. Requires the " | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `listEntryId` | string | Yes | The list entry ID | | `updates` | json | Yes | Up to 100 field updates as \[\{"id":"<fieldId>","value":\{"type":"…","data":…\}\}\], using the same value shapes as a single field update | @@ -86,7 +84,6 @@ Create a list. Its type fixes which entities it can hold, and the API key holder | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `name` | string | Yes | Name of the new list | | `type` | string | Yes | Entity kind the list holds: company, opportunity, or person | | `isPublic` | boolean | No | Whether everyone in the organization can see the list | @@ -115,7 +112,6 @@ Add a selectable option to a dropdown field on a list. A ranked or status option | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `fieldId` | string | Yes | The dropdown field ID on that list | | `type` | string | Yes | Kind of option to create, matching the field. dropdown takes only a label; ranked-dropdown also requires rank and color; status-dropdown additionally requires a status category. Sending a field the kind does not accept is rejected | @@ -149,7 +145,6 @@ Fold a duplicate company or person into the record you are keeping. The merge ru | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | What to merge: companies or persons | | `primaryId` | string | Yes | ID of the record to keep | | `duplicateId` | string | Yes | ID of the duplicate record to fold in | @@ -172,7 +167,6 @@ Write a note — attached to companies, persons, and opportunities, anchored to | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `type` | string | Yes | Note shape: entities to attach it to records, interaction to anchor it to a meeting, call, or chat message, or user-reply to reply to a note | | `html` | string | Yes | The note body as HTML | | `companyIds` | json | No | Companies to attach the note to, e.g. \[1, 2\]. Not used on a reply | @@ -220,7 +214,6 @@ Create a reminder on one company, person, or opportunity. A recurring reminder r | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `type` | string | Yes | one-time to fire once, or recurring to reset on a signal | | `entityType` | string | Yes | What the reminder is about: company, person, or opportunity | | `entityId` | string | Yes | ID of that company, person, or opportunity | @@ -262,7 +255,6 @@ Permanently delete a dropdown option on a list field. Every list entry currently | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `fieldId` | string | Yes | The dropdown field ID on that list | | `dropdownOptionId` | string | Yes | The dropdown option ID to delete | @@ -286,7 +278,6 @@ Delete a note you created. Deleting a root note also deletes its replies; deleti | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `noteId` | string | Yes | The note ID to delete | #### Output @@ -308,7 +299,6 @@ Look up one company by ID. Field data is returned only for the Field IDs or Fiel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `companyId` | string | Yes | The company ID | | `fieldIds` | json | No | Field IDs to return values for, e.g. \["affinity-data-location"\]. Mutually exclusive with Field Types | | `fieldTypes` | json | No | Field categories to return values for: enriched, global, or relationship-intelligence. Mutually exclusive with Field IDs | @@ -341,7 +331,6 @@ Verify an Affinity API key and return the tenant, the user behind the key, and t | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | #### Output @@ -373,7 +362,6 @@ Read one non-list field value from a company or person. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity to read the field from: companies or persons | | `entityId` | string | Yes | ID of that company or person | | `fieldId` | string | Yes | The field ID to read | @@ -400,7 +388,6 @@ Read one list — its name, type, owner, and privacy setting. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | #### Output @@ -427,7 +414,6 @@ Read one row of a list with its entity. Field data is returned only for the Fiel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `listEntryId` | string | Yes | The list entry ID | | `fieldIds` | json | No | Field IDs to return values for, e.g. \["affinity-data-location"\]. Mutually exclusive with Field Types | @@ -456,7 +442,6 @@ Read one field value on a list row. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `listEntryId` | string | Yes | The list entry ID | | `fieldId` | string | Yes | The field ID to read | @@ -483,7 +468,6 @@ Read one dropdown option on a list field. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `fieldId` | string | Yes | The dropdown field ID on that list | | `dropdownOptionId` | string | Yes | The dropdown option ID | @@ -512,7 +496,6 @@ Read the status of one company or person merge, including why it failed if it di | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which merge to read: companies or persons | | `mergeId` | string | Yes | The merge ID | @@ -543,7 +526,6 @@ Read one merge task and how its merges are progressing. Poll this after starting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which merge task to read: companies or persons | | `taskId` | string | Yes | The merge task ID | @@ -567,7 +549,6 @@ Read one note with its body, author, mentions, and attached records. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `noteId` | string | Yes | The note ID | | `includes` | json | No | Extra properties to return, e.g. \["repliesCount","personsPreview","companiesPreview","opportunitiesPreview"\]. Those four fields are omitted unless requested here | @@ -607,7 +588,6 @@ Read one opportunity and the list it belongs to. Its field data lives on the lis | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `opportunityId` | string | Yes | The opportunity ID | #### Output @@ -633,7 +613,6 @@ Look up one person by ID. Field data is returned only for the Field IDs or Field | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `personId` | string | Yes | The person ID | | `fieldIds` | json | No | Field IDs to return values for, e.g. \["affinity-data-location"\]. Mutually exclusive with Field Types | | `fieldTypes` | json | No | Field categories to return values for: enriched, global, or relationship-intelligence. Mutually exclusive with Field IDs | @@ -667,7 +646,6 @@ Read one saved view — its name, kind, and creation date. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `viewId` | string | Yes | The saved view ID | @@ -692,7 +670,6 @@ Read one transcript with its first 100 fragments. Page the fragments endpoint fo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `transcriptId` | string | Yes | The transcript ID | #### Output @@ -717,7 +694,6 @@ Read one internal user. A user and their person record share the same numeric ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `userId` | string | Yes | The user ID, which is also their person ID | #### Output @@ -745,7 +721,6 @@ Page through logged calls and their participants. Only calls the API key holder | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -781,7 +756,6 @@ Page through logged chat messages and their participants. Only messages the API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -820,7 +794,6 @@ Page through companies. Companies come back without field data unless Field IDs | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `ids` | json | No | Restrict the page to these company IDs, e.g. \[1, 2, 3\] | | `fieldIds` | json | No | Field IDs to return values for, e.g. \["affinity-data-location"\]. Mutually exclusive with Field Types | | `fieldTypes` | json | No | Field categories to return values for: enriched, global, or relationship-intelligence. Mutually exclusive with Field IDs | @@ -859,7 +832,6 @@ Find warm paths into a company through shared work history: who in your Affinity | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | Yes | Required scope. The only supported filter is target.currentCompany.id, e.g. "target.currentCompany.id=123" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of targets to return per page, 1-50. Defaults to 20 | @@ -889,7 +861,6 @@ Page through email metadata — subject, participants, and timestamps. Affinity | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -925,7 +896,6 @@ Page through a company's or person's non-list field values. List fields are not | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity to read field values from: companies or persons | | `entityId` | string | Yes | ID of that company or person | | `ids` | json | No | Restrict to these field IDs. Mutually exclusive with Field Types | @@ -959,7 +929,6 @@ Page through a company's or person's rows across every list, each carrying that | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity to look up the rows of: companies or persons | | `entityId` | string | Yes | ID of that company or person | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -997,7 +966,6 @@ List every list a company or person appears on that the caller can view. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity to look up the lists of: companies or persons | | `entityId` | string | Yes | ID of that company or person | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1030,7 +998,6 @@ List the notes relevant to one company, person, or opportunity — directly atta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity the notes hang off: companies, persons, or opportunities | | `entityId` | string | Yes | ID of that company, person, or opportunity | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | @@ -1079,7 +1046,6 @@ List who knows a company or person, scored 0.0 to 1.0 by how much the two actual | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity to look up relationships for: companies or persons | | `entityId` | string | Yes | ID of that company or person | | `filter` | string | No | Affinity Filtering Language expression. This endpoint filters on interactionScore only, e.g. "interactionScore>=0.5" | @@ -1124,7 +1090,6 @@ List the selectable options on a dropdown or ranked-dropdown company or person f | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which field family the field belongs to: companies or persons | | `fieldId` | string | Yes | The dropdown or ranked-dropdown field ID | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1158,7 +1123,6 @@ List the non-list company or person fields, with the value type, filter operator | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which fields to describe: companies or persons | | `includes` | json | No | Extra properties to return: \["filterability","sortability"\]. Both are omitted unless requested here | | `filter` | string | No | Affinity Filtering Language expression. This endpoint filters on name only, e.g. "name=~Status" | @@ -1194,7 +1158,6 @@ Page through field value changes across the whole workspace. Built for delta syn | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | No | Affinity Filtering Language expression over field.id, listEntry.id, changer.id, changedAt, or actionType. Resume a sync with e.g. "changedAt>2026-06-01T12:00:00Z" | | `orderBy` | json | No | Sort order: \["changedAt"\] for oldest first \(the default\), \["-changedAt"\] for newest first | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1230,7 +1193,6 @@ Find warm paths into a company through investment history: which investors in yo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | Yes | Required scope. The only supported filter is target.currentCompany.id, e.g. "target.currentCompany.id=123" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of targets to return per page, 1-50. Defaults to 20 | @@ -1260,7 +1222,6 @@ Page through the rows of a list. Rows come back without field data unless Field | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `fieldIds` | json | No | Field IDs to return values for, e.g. \["affinity-data-location"\]. Mutually exclusive with Field Types | | `fieldTypes` | json | No | Field categories to return values for: enriched, global, list, or relationship-intelligence. Mutually exclusive with Field IDs | @@ -1294,7 +1255,6 @@ Page through the history of one list row — who changed which field, when, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `listEntryId` | string | Yes | The list entry ID | | `filter` | string | No | Affinity Filtering Language expression over field.id, changer.id, changedAt, or actionType, e.g. "field.id=field-1234" | @@ -1331,7 +1291,6 @@ Page through every field value on one list row, including the list-specific colu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `listEntryId` | string | Yes | The list entry ID | | `ids` | json | No | Restrict to these field IDs. Mutually exclusive with Field Types | @@ -1365,7 +1324,6 @@ List the selectable options on a dropdown, ranked-dropdown, or status-dropdown f | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `fieldId` | string | Yes | The dropdown field ID on that list | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1399,7 +1357,6 @@ List the fields available on one list, including its list-specific columns. Use | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `includes` | json | No | Extra properties to return: \["filterability","sortability"\]. Both are omitted unless requested here | | `filter` | string | No | Affinity Filtering Language expression. This endpoint filters on name only, e.g. "name=~Stage" | @@ -1435,7 +1392,6 @@ Page through the lists in the organization that the caller can view. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `term` | string | No | Case-insensitive substring match on the list name | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1468,7 +1424,6 @@ Page through past and upcoming meetings with their organizer and attendees. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1505,7 +1460,6 @@ Page through merge tasks, each summarizing how many of its merges are in progres | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which merge tasks to list: companies or persons | | `filter` | string | No | Affinity Filtering Language expression. This endpoint filters on status only, e.g. "status=in-progress" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1535,7 +1489,6 @@ Page through the company or person merges the organization has run, with the sta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which merges to list: companies or persons | | `filter` | string | No | Affinity Filtering Language expression over status or taskId, e.g. "status=failed" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1572,7 +1525,6 @@ List the companies directly attached to one note. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `noteId` | string | Yes | The note ID | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1603,7 +1555,6 @@ List the opportunities directly attached to one note. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `noteId` | string | Yes | The note ID | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1637,7 +1588,6 @@ List the persons directly attached to one note. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `noteId` | string | Yes | The note ID | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1670,7 +1620,6 @@ Page through the replies on one note, including AI Notetaker replies. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `noteId` | string | Yes | The note ID whose replies to read | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1718,7 +1667,6 @@ Page through every note the caller can see. Replies are excluded. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `includes` | json | No | Extra properties to return, e.g. \["repliesCount","personsPreview","companiesPreview","opportunitiesPreview"\]. Those four fields are omitted unless requested here | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1766,7 +1714,6 @@ Page through opportunities. Field data lives on the list entry, not here — rea | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `ids` | json | No | Restrict the page to these opportunity IDs, e.g. \[1, 2, 3\] | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1798,7 +1745,6 @@ Page through persons. Persons come back without field data unless Field IDs or F | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `ids` | json | No | Restrict the page to these person IDs, e.g. \[1, 2, 3\] | | `fieldIds` | json | No | Field IDs to return values for, e.g. \["affinity-data-location"\]. Mutually exclusive with Field Types | | `fieldTypes` | json | No | Field categories to return values for: enriched, global, or relationship-intelligence. Mutually exclusive with Field IDs | @@ -1838,7 +1784,6 @@ Page through the reminders the caller can see. Filter by status to surface what | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1881,7 +1826,6 @@ Page through the rows of a saved view. The view's own filters and columns decide | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `viewId` | string | Yes | The saved view ID | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -1914,7 +1858,6 @@ List the saved views on a list that the caller can view. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1944,7 +1887,6 @@ Page through everything said in a meeting, segment by segment with the speaker. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `transcriptId` | string | Yes | The transcript ID | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -1976,7 +1918,6 @@ Page through meeting transcript metadata. Read one transcript to get what was ac | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filter` | string | No | Affinity Filtering Language expression, e.g. "createdAt>=2026-01-01" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | | `limit` | number | No | Number of items to return per page, 1-100. Defaults to 100 | @@ -2004,7 +1945,6 @@ Page through the internal users in the organization. Email addresses and roles a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `term` | string | No | Case-insensitive match across first name, last name, and primary email | | `filter` | string | No | Affinity Filtering Language expression over id or status, e.g. "status=active" | | `cursor` | string | No | Cursor from a previous page, returned as nextCursor or prevCursor | @@ -2039,7 +1979,6 @@ Search companies by filters, sorts, and a free-text term. Requires the "Export A | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filters` | json | No | Filter group as \{operator: "and"\|"or", filters: \[...\]\}, at most 50 leaves. Each leaf is \{valueType, fieldId, operator, value\}, and a leaf may itself be a nested group | | `searchTerm` | string | No | Free-text term matched against the searchable fields. At least 3 characters | | `searchFieldIds` | json | No | Field IDs the search term is matched against. Defaults to the searchable fields | @@ -2083,7 +2022,6 @@ Search files by keyword, ordered by relevance. Narrow to specific files or to on | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `prompt` | string | Yes | What to search for. Between 3 and 500 characters | | `ids` | json | No | Restrict the search to these file IDs. Cannot be combined with Company ID | | `companyId` | string | No | Restrict the search to one company's files. Cannot be combined with file IDs | @@ -2111,7 +2049,6 @@ Search the rows of one list by filters, sorts, and a free-text term. Requires th | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID to search | | `filters` | json | No | Filter group as \{operator: "and"\|"or", filters: \[...\]\}, at most 50 leaves. Each leaf is \{valueType, fieldId, operator, value\}, and a leaf may itself be a nested group | | `searchTerm` | string | No | Free-text term matched against the searchable fields. At least 3 characters | @@ -2151,7 +2088,6 @@ Search notes by keyword, ordered by relevance. Narrow to specific notes or to on | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `prompt` | string | Yes | What to search for. Between 3 and 500 characters | | `ids` | json | No | Restrict the search to these note IDs. Cannot be combined with Company ID | | `companyId` | string | No | Restrict the search to one company's notes. Cannot be combined with note IDs | @@ -2178,7 +2114,6 @@ Search persons by filters, sorts, and a free-text term. Requires the "Export All | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `filters` | json | No | Filter group as \{operator: "and"\|"or", filters: \[...\]\}, at most 50 leaves. Each leaf is \{valueType, fieldId, operator, value\}, and a leaf may itself be a nested group | | `searchTerm` | string | No | Free-text term matched against the searchable fields. At least 3 characters | | `searchFieldIds` | json | No | Field IDs the search term is matched against. Defaults to the searchable fields | @@ -2223,7 +2158,6 @@ Find companies from a description in plain language — industry, technology, st | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `prompt` | string | Yes | What to look for, in plain language, e.g. "climate tech companies in our pipeline". Up to 500 characters | | `listIds` | json | No | Restrict the search to companies on these lists, e.g. \[1, 2\] | | `limit` | number | No | Maximum number of companies to return, 1-100. Defaults to 100 | @@ -2255,7 +2189,6 @@ Write one non-list field value on a company or person. The value type must match | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `entityType` | string | Yes | Which entity to write the field on: companies or persons | | `entityId` | string | Yes | ID of that company or person | | `fieldId` | string | Yes | The field ID to write | @@ -2280,7 +2213,6 @@ Write one field value on a list row. Requires the "Export data from Lists" permi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `listEntryId` | string | Yes | The list entry ID | | `fieldId` | string | Yes | The field ID to write | @@ -2305,7 +2237,6 @@ Change a dropdown option on a list field. Every field is optional — supply onl | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `listId` | string | Yes | The list ID | | `fieldId` | string | Yes | The dropdown field ID on that list | | `dropdownOptionId` | string | Yes | The dropdown option ID to update | @@ -2334,7 +2265,6 @@ Rewrite a note's body or replace which records it is attached to. Each list of I | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Affinity API key, sent as a bearer token | | `noteId` | string | Yes | The note ID to update | | `html` | string | No | Replacement note body as HTML | | `companyIds` | json | No | Replacement set of attached companies, e.g. \[1, 2\]. Send \[\] to detach every company; omit to leave them unchanged | diff --git a/apps/docs/content/docs/integrations/agentmail.mdx b/apps/docs/content/docs/integrations/agentmail.mdx index b979bf7a1e6..9f06a9cb608 100644 --- a/apps/docs/content/docs/integrations/agentmail.mdx +++ b/apps/docs/content/docs/integrations/agentmail.mdx @@ -2,7 +2,7 @@ title: AgentMail description: Manage email inboxes, threads, and messages with AgentMail integration: - type: "agentmail" + type: "agentmail_v2" color: "#000000" --- @@ -15,7 +15,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" ## Use the block [#usage-instructions] -Create and manage email inboxes, send and receive messages, reply to threads, manage drafts, and organize threads with labels. Requires an API key. +Create and manage email inboxes, send and receive messages, reply to threads, manage drafts, and organize threads with labels. ## Actions @@ -29,7 +29,6 @@ Create a new email draft in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to create the draft in | | `to` | string | No | Recipient email addresses \(comma-separated\) | | `subject` | string | No | Draft subject line | @@ -72,7 +71,6 @@ Create a new email inbox with AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `username` | string | No | Username for the inbox email address | | `domain` | string | No | Domain for the inbox email address | | `displayName` | string | No | Display name for the inbox | @@ -99,7 +97,6 @@ Delete an email draft in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the draft | | `draftId` | string | Yes | ID of the draft to delete | @@ -121,7 +118,6 @@ Delete an email inbox in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to delete | #### Output @@ -142,7 +138,6 @@ Delete an email thread in AgentMail (moves to trash, or permanently deletes if a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the thread | | `threadId` | string | Yes | ID of the thread to delete | | `permanent` | boolean | No | Force permanent deletion instead of moving to trash | @@ -165,7 +160,6 @@ Forward an email message to new recipients in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the message | | `messageId` | string | Yes | ID of the message to forward | | `to` | string | Yes | Recipient email addresses \(comma-separated\) | @@ -194,7 +188,6 @@ Get details of a specific email draft in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox the draft belongs to | | `draftId` | string | Yes | ID of the draft to retrieve | @@ -230,7 +223,6 @@ Get details of a specific email inbox in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to retrieve | #### Output @@ -255,7 +247,6 @@ Get details of a specific email message in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the message | | `messageId` | string | Yes | ID of the message to retrieve | @@ -288,7 +279,6 @@ Get details of a specific email thread including messages in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the thread | | `threadId` | string | Yes | ID of the thread to retrieve | @@ -330,7 +320,6 @@ List email drafts in an inbox in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to list drafts from | | `limit` | number | No | Maximum number of drafts to return | | `pageToken` | string | No | Pagination token for next page of results | @@ -366,7 +355,6 @@ List all email inboxes in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `limit` | number | No | Maximum number of inboxes to return | | `pageToken` | string | No | Pagination token for next page of results | @@ -395,7 +383,6 @@ List messages in an inbox in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to list messages from | | `limit` | number | No | Maximum number of messages to return | | `pageToken` | string | No | Pagination token for next page of results | @@ -427,7 +414,6 @@ List email threads in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to list threads from | | `limit` | number | No | Maximum number of threads to return | | `pageToken` | string | No | Pagination token for next page of results | @@ -463,7 +449,6 @@ Reply to an existing email message in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to reply from | | `messageId` | string | Yes | ID of the message to reply to | | `text` | string | No | Plain text reply body | @@ -492,7 +477,6 @@ Send an existing email draft in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the draft | | `draftId` | string | Yes | ID of the draft to send | @@ -515,7 +499,6 @@ Send an email message from an AgentMail inbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to send from | | `to` | string | Yes | Recipient email address \(comma-separated for multiple\) | | `subject` | string | Yes | Email subject line | @@ -545,7 +528,6 @@ Update an existing email draft in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the draft | | `draftId` | string | Yes | ID of the draft to update | | `to` | string | No | Recipient email addresses \(comma-separated\) | @@ -588,7 +570,6 @@ Update the display name of an email inbox in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox to update | | `displayName` | string | Yes | New display name for the inbox | @@ -614,7 +595,6 @@ Add or remove labels on an email message in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the message | | `messageId` | string | Yes | ID of the message to update | | `addLabels` | string | No | Comma-separated labels to add to the message | @@ -639,7 +619,6 @@ Add or remove labels on an email thread in AgentMail | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentMail API key | | `inboxId` | string | Yes | ID of the inbox containing the thread | | `threadId` | string | Yes | ID of the thread to update | | `addLabels` | string | No | Comma-separated labels to add to the thread | diff --git a/apps/docs/content/docs/integrations/agentphone.mdx b/apps/docs/content/docs/integrations/agentphone.mdx index 66747ea70b9..5b15f00c917 100644 --- a/apps/docs/content/docs/integrations/agentphone.mdx +++ b/apps/docs/content/docs/integrations/agentphone.mdx @@ -2,7 +2,7 @@ title: AgentPhone description: Provision numbers, send SMS and iMessage, and place voice calls with AgentPhone integration: - type: "agentphone" + type: "agentphone_v2" color: "linear-gradient(135deg, #1a1a1a 0%, #0a2a14 100%)" --- @@ -17,7 +17,7 @@ Retrieve call transcripts and conversation history for downstream processing, an ## Use the block [#usage-instructions] -Provision SMS- and voice-enabled numbers, send messages and tapback reactions, place outbound calls, manage conversations and contacts, and inspect usage with an AgentPhone API key. +Provision SMS- and voice-enabled numbers, send messages and tapback reactions, place outbound calls, manage conversations and contacts, and inspect usage. ## Actions @@ -31,7 +31,6 @@ Initiate an outbound voice call from an AgentPhone agent | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `agentId` | string | Yes | Agent that will handle the call | | `toNumber` | string | Yes | Phone number to call in E.164 format \(e.g. +14155551234\) | | `fromNumberId` | string | No | Phone number ID to use as caller ID. Must belong to the agent. If omitted, the agent's first assigned number is used. | @@ -64,7 +63,6 @@ Create a new contact in AgentPhone | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `phoneNumber` | string | Yes | Phone number in E.164 format \(e.g. +14155551234\) | | `name` | string | Yes | Contact's full name | | `email` | string | No | Contact's email address | @@ -94,7 +92,6 @@ Provision a new SMS- and voice-enabled phone number | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `country` | string | No | Two-letter country code \(e.g. US, CA\). Defaults to US. | | `areaCode` | string | No | Preferred area code \(US/CA only, e.g. "415"\). Best-effort — may be ignored if unavailable. | | `agentId` | string | No | Optionally attach the number to an agent immediately | @@ -123,7 +120,6 @@ Delete a contact by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `contactId` | string | Yes | Contact ID | #### Output @@ -145,7 +141,6 @@ Fetch a call and its full transcript | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `callId` | string | Yes | ID of the call to retrieve | #### Output @@ -185,7 +180,6 @@ Get the full ordered transcript for a call | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `callId` | string | Yes | ID of the call to retrieve the transcript for | #### Output @@ -210,7 +204,6 @@ Fetch a single contact by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `contactId` | string | Yes | Contact ID | #### Output @@ -237,7 +230,6 @@ Get a conversation along with its recent messages | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `conversationId` | string | Yes | Conversation ID | | `messageLimit` | number | No | Number of recent messages to include \(default 50, max 100\) | @@ -277,7 +269,6 @@ Get paginated messages for a conversation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `conversationId` | string | Yes | Conversation ID | | `limit` | number | No | Number of messages to return \(default 50, max 200\) | | `before` | string | No | Return messages received before this ISO 8601 timestamp | @@ -311,7 +302,6 @@ Fetch messages received on a specific phone number | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `numberId` | string | Yes | ID of the phone number | | `limit` | number | No | Number of messages to return \(default 50, max 200\) | | `before` | string | No | Return messages received before this ISO 8601 timestamp | @@ -343,7 +333,6 @@ Retrieve current usage statistics for the AgentPhone account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | #### Output @@ -367,7 +356,6 @@ Get a daily breakdown of usage (messages, calls, webhooks) for the last N days | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `days` | number | No | Number of days to return \(1-365, default 30\) | #### Output @@ -393,7 +381,6 @@ Get monthly usage aggregation (messages, calls, webhooks) for the last N months | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `months` | number | No | Number of months to return \(1-24, default 6\) | #### Output @@ -419,7 +406,6 @@ List voice calls for this AgentPhone account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `limit` | number | No | Number of results to return \(default 20, max 100\) | | `offset` | number | No | Number of results to skip \(min 0\) | | `status` | string | No | Filter by status \(completed, in-progress, failed\) | @@ -461,7 +447,6 @@ List contacts for this AgentPhone account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `search` | string | No | Filter by name or phone number \(case-insensitive contains\) | | `limit` | number | No | Number of results to return \(default 50, max 200\) | | `offset` | number | No | Number of results to skip \(min 0\) | @@ -493,7 +478,6 @@ List conversations (message threads) for this AgentPhone account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `limit` | number | No | Number of results to return \(default 20, max 100\) | | `offset` | number | No | Number of results to skip \(min 0\) | @@ -527,7 +511,6 @@ List all phone numbers provisioned for this AgentPhone account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `limit` | number | No | Number of results to return \(default 20, max 100\) | | `offset` | number | No | Number of results to skip \(min 0\) | @@ -558,7 +541,6 @@ Send an iMessage tapback reaction to a message (iMessage only) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `messageId` | string | Yes | ID of the message to react to | | `reaction` | string | Yes | Reaction type: love, like, dislike, laugh, emphasize, or question | @@ -583,7 +565,6 @@ Release (delete) a phone number. This action is irreversible. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `numberId` | string | Yes | ID of the phone number to release | #### Output @@ -605,7 +586,6 @@ Send an outbound SMS or iMessage from an AgentPhone agent | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `agentId` | string | Yes | Agent sending the message | | `toNumber` | string | Yes | Recipient phone number in E.164 format \(e.g. +14155551234\) | | `body` | string | Yes | Message text to send | @@ -634,7 +614,6 @@ Update a contact's fields | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `contactId` | string | Yes | Contact ID | | `phoneNumber` | string | No | New phone number in E.164 format | | `name` | string | No | New contact name | @@ -665,7 +644,6 @@ Update conversation metadata (stored state). Pass null to clear existing metadat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | AgentPhone API key | | `conversationId` | string | Yes | Conversation ID | | `metadata` | json | No | Custom key-value metadata to store on the conversation. Pass null to clear existing metadata. | diff --git a/apps/docs/content/docs/integrations/ahrefs.mdx b/apps/docs/content/docs/integrations/ahrefs.mdx index 3e4abf864e3..b023699a7b2 100644 --- a/apps/docs/content/docs/integrations/ahrefs.mdx +++ b/apps/docs/content/docs/integrations/ahrefs.mdx @@ -2,7 +2,7 @@ title: Ahrefs description: SEO analysis with Ahrefs integration: - type: "ahrefs" + type: "ahrefs_v2" color: "#FFFFFF" --- @@ -15,7 +15,7 @@ Use [Ahrefs](https://ahrefs.com/) in Sim to retrieve domain and backlink metrics ## Use the block [#usage-instructions] -Analyze domain ratings, backlinks, organic keywords, top pages, and more. Requires an Ahrefs API key with access to the selected endpoints; API v3 is available on Lite and higher plans. +Analyze domain ratings, backlinks, organic keywords, top pages, and more. API v3 is available on Lite and higher plans. ## Actions @@ -31,7 +31,6 @@ Get the Domain Rating (DR) and Ahrefs Rank for a target domain. Domain Rating sh | --------- | ---- | -------- | ----------- | | `target` | string | Yes | The target domain to analyze \(e.g., example.com\) | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -56,7 +55,6 @@ Get a one-call organic and paid search overview for a target domain or URL: orga | `country` | string | No | Country code for traffic data. Example: "us", "gb", "de" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date to report metrics on, in YYYY-MM-DD format \(defaults to today\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -88,7 +86,6 @@ Get a list of backlinks pointing to a target domain or URL. Returns details abou | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `history` | string | No | Historical scope: "live" \(currently live backlinks\), "all_time" \(default, includes lost backlinks\), or "since:YYYY-MM-DD" \(backlinks found since a date\). | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -118,7 +115,6 @@ Get backlink and referring domain totals for a target domain or URL, both curren | `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date to report metrics on, in YYYY-MM-DD format \(defaults to today\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -146,7 +142,6 @@ Get a list of domains that link to a target domain or URL. Returns unique referr | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `history` | string | No | Historical scope: "live" \(currently live\), "all_time" \(default, includes lost domains\), or "since:YYYY-MM-DD" \(domains found since a date\). | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -175,7 +170,6 @@ Get a list of broken backlinks pointing to a target domain or URL. Useful for id | `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -205,7 +199,6 @@ Get organic keywords that a target domain or URL ranks for in Google search resu | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date to report metrics on, in YYYY-MM-DD format \(defaults to today\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -236,7 +229,6 @@ Get domains that compete with a target domain or URL for the same organic keywor | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date to report metrics on, in YYYY-MM-DD format \(defaults to today\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -267,7 +259,6 @@ Get the top pages of a target domain sorted by organic traffic. Returns page URL | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date to report metrics on, in YYYY-MM-DD format \(defaults to today\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -294,7 +285,6 @@ Get detailed metrics for a keyword including search volume, keyword difficulty, | --------- | ---- | -------- | ----------- | | `keyword` | string | Yes | The keyword to analyze | | `country` | string | No | Country code for keyword data. Example: "us", "gb", "de" \(default: "us"\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -334,7 +324,6 @@ Get a target domain's pages that receive paid search traffic, sorted by estimate | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\) | | `date` | string | No | Date to report metrics on, in YYYY-MM-DD format \(defaults to today\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -364,7 +353,6 @@ Get the anchor text distribution for a target domain or URL's backlinks, showing | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\) | | `history` | string | No | Historical scope: "live" \(currently live\), "all_time" \(default, includes lost backlinks\), or "since:YYYY-MM-DD" \(backlinks found since a date\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -395,7 +383,6 @@ Get keyword ideas related to a seed keyword: terms the same top-ranking pages al | `terms` | string | No | Type of related keywords to return: "also_rank_for", "also_talk_about", or "all" \(default: "all"\) | | `viewFor` | string | No | Whether to derive related terms from the top 10 or top 100 ranking pages \(default: "top_10"\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -427,7 +414,6 @@ Get the historical Domain Rating (DR) trend for a target domain or URL over a da | `dateFrom` | string | Yes | Start date of the historical period, in YYYY-MM-DD format | | `dateTo` | string | No | End date of the historical period, in YYYY-MM-DD format \(defaults to today\) | | `historyGrouping` | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" \(default: "monthly"\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -456,7 +442,6 @@ Get the historical organic and paid traffic trend for a target domain or URL ove | `historyGrouping` | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" \(default: "monthly"\) | | `country` | string | No | Country code for traffic data. Example: "us", "gb", "de" \(default: "us"\) | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -486,7 +471,6 @@ Get the historical referring domains trend for a target domain or URL over a dat | `dateTo` | string | No | End date of the historical period, in YYYY-MM-DD format \(defaults to today\) | | `historyGrouping` | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" \(default: "monthly"\) | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -514,7 +498,6 @@ Get the historical organic keyword ranking distribution for a target domain or U | `historyGrouping` | string | No | Time interval for grouping data points: "daily", "weekly", or "monthly" \(default: "monthly"\) | | `country` | string | No | Country code for search results. Example: "us", "gb", "de" \(default: "us"\) | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains, default\), exact \(exact URL match\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -545,7 +528,6 @@ Get bulk SEO metrics (Domain Rating, backlinks, referring domains, organic traff | `protocol` | string | No | Protocol applied to every target: "both" \(default\), "http", or "https" | | `country` | string | No | Country code for traffic data. Example: "us", "gb", "de" \(default: "us"\) | | `volumeMode` | string | No | Search volume calculation: "monthly" or "average" \(default: "monthly"\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -580,7 +562,6 @@ Get crawled pages from an Ahrefs Site Audit project with health and SEO metrics: | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | | `offset` | number | No | Number of results to skip, for pagination | | `issueId` | string | No | Only return pages affected by this issue ID | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -614,7 +595,6 @@ Get ranking overview metrics for the keywords tracked in an Ahrefs Rank Tracker | `dateCompared` | string | No | Comparison date in YYYY-MM-DD format, to compute position/traffic deltas | | `volumeMode` | string | No | Search volume calculation: "monthly" or "average" \(default: "monthly"\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -650,7 +630,6 @@ Get the full SERP (search engine results page) for a keyword tracked in an Ahref | `date` | string | No | Timestamp to return the last available SERP Overview at, in YYYY-MM-DDThh:mm:ss format | | `locationId` | number | No | Location ID of the tracked keyword, if tracked at a specific location | | `languageCode` | string | No | Language code of the tracked keyword | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -689,7 +668,6 @@ Get competitor rankings for the keywords tracked in an Ahrefs Rank Tracker proje | `dateCompared` | string | No | Comparison date in YYYY-MM-DD format, to compute position/traffic deltas | | `volumeMode` | string | No | Search volume calculation: "monthly" or "average" \(default: "monthly"\) | | `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 1000\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -723,7 +701,6 @@ Get aggregate competitor stats for an Ahrefs Rank Tracker project: each competit | `date` | string | Yes | Date to report metrics for, in YYYY-MM-DD format | | `device` | string | Yes | Rankings device type: "desktop" or "mobile" | | `volumeMode` | string | No | Search volume calculation: "monthly" or "average" \(default: "monthly"\) | -| `apiKey` | string | Yes | Ahrefs API Key | #### Output diff --git a/apps/docs/content/docs/integrations/apify.mdx b/apps/docs/content/docs/integrations/apify.mdx index c0e6a7929d3..816e02ad40c 100644 --- a/apps/docs/content/docs/integrations/apify.mdx +++ b/apps/docs/content/docs/integrations/apify.mdx @@ -2,7 +2,7 @@ title: Apify description: Run Apify actors and retrieve results integration: - type: "apify" + type: "apify_v2" color: "#FFFFFF" --- @@ -29,7 +29,6 @@ Run an APIFY actor synchronously and get results (max 5 minutes) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | | `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" | | `input` | string | No | Actor input as JSON string. Example: \{ "startUrls": \[ \{ "url": "https://example.com" \} \], "maxPages": 10 \} | | `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB | @@ -57,7 +56,6 @@ Start an APIFY Actor run and poll it within the same workflow step until complet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | | `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" | | `input` | string | No | Actor input as JSON string. Example: \{ "startUrls": \[ \{ "url": "https://example.com" \} \], "maxPages": 10 \} | | `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts. Example: 30 | @@ -88,7 +86,6 @@ Run a saved APIFY actor task synchronously and get dataset items (max 5 minutes) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | | `taskId` | string | Yes | Task ID or username/task-name. Examples: "janedoe/my-task", "moJRLRc85AitArpNN" | | `input` | string | No | JSON string that overrides the task's saved input. Example: \{ "startUrls": \[ \{ "url": "https://example.com" \} \] \} | | `itemLimit` | number | No | Max dataset items to return \(1-250000\). Example: 500 | @@ -116,7 +113,6 @@ Retrieve items stored in an APIFY dataset | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | | `datasetId` | string | Yes | Dataset ID to read items from. Example: "9RnD3Pql2vGZkc5H5" | | `itemLimit` | number | No | Max items to return \(1-250000\). Default: all items. Example: 500 | | `offset` | number | No | Number of items to skip at the start. Default: 0 | @@ -143,7 +139,6 @@ Get the status and details of an APIFY actor run | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | | `runId` | string | Yes | Actor run ID to fetch. Example: "HG7ML7M8z78YcAPEB" | #### Output diff --git a/apps/docs/content/docs/integrations/apollo.mdx b/apps/docs/content/docs/integrations/apollo.mdx index 92d7307f0d7..d932a6c37bf 100644 --- a/apps/docs/content/docs/integrations/apollo.mdx +++ b/apps/docs/content/docs/integrations/apollo.mdx @@ -2,7 +2,7 @@ title: Apollo description: Search, enrich, and manage contacts with Apollo.io integration: - type: "apollo" + type: "apollo_v2" color: "#EBF212" --- @@ -29,7 +29,6 @@ Search Apollo's database for people using demographic filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `person_titles` | array | No | Job titles to search for \(e.g., \["CEO", "VP of Sales"\]\) | | `include_similar_titles` | boolean | No | Whether to return people with job titles similar to person_titles | | `person_locations` | array | No | Locations to search in \(e.g., \["San Francisco, CA", "New York, NY"\]\) | @@ -65,7 +64,6 @@ Enrich data for a single person using Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `first_name` | string | No | First name of the person | | `last_name` | string | No | Last name of the person | | `name` | string | No | Full name of the person \(alternative to first_name/last_name\) | @@ -98,7 +96,6 @@ Enrich data for up to 10 people at once using Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `people` | array | Yes | Array of people to enrich \(max 10\) | | `reveal_personal_emails` | boolean | No | Reveal personal email addresses \(uses credits\) | | `reveal_phone_number` | boolean | No | Reveal phone numbers \(uses credits, requires webhook_url\) | @@ -126,7 +123,6 @@ Search Apollo's database for companies using filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `organization_locations` | array | No | Company HQ locations \(cities, US states, or countries\) | | `organization_not_locations` | array | No | Exclude companies whose HQ is in these locations | | `organization_num_employees_ranges` | array | No | Employee count ranges as "min,max" strings \(e.g., \["1,10", "250,500", "10000,20000"\]\) | @@ -158,7 +154,6 @@ Enrich data for a single organization using Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `domain` | string | Yes | Company domain \(e.g., "apollo.io", "acme.com"\) | #### Output @@ -180,7 +175,6 @@ Enrich data for up to 10 organizations at once using Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `domains` | array | Yes | Array of company domains to enrich \(max 10, no www. or @, e.g., \["apollo.io", "stripe.com"\]\) | #### Output @@ -205,7 +199,6 @@ Create a new contact in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `first_name` | string | Yes | First name of the contact | | `last_name` | string | Yes | Last name of the contact | | `email` | string | No | Email address of the contact | @@ -244,7 +237,6 @@ Update an existing contact in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `contact_id` | string | Yes | ID of the contact to update \(e.g., "con_abc123"\) | | `first_name` | string | No | First name of the contact | | `last_name` | string | No | Last name of the contact | @@ -283,7 +275,6 @@ Search your team's contacts in Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `q_keywords` | string | No | Keywords to search for | | `contact_stage_ids` | array | No | Filter by contact stage IDs | | `contact_label_ids` | array | No | Filter by Apollo label IDs \(lists\) | @@ -311,7 +302,6 @@ Create up to 100 contacts at once in your Apollo database. Supports deduplicatio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `contacts` | array | Yes | Array of contacts to create \(max 100\). Each contact may include first_name, last_name, email, title, organization_name, account_id, owner_id, contact_stage_id, linkedin_url, phone \(single string\) or phone_numbers \(array of \{raw_number, position\}\), contact_emails, typed_custom_fields, and CRM IDs \(salesforce_contact_id, hubspot_id, team_id\) for cross-system matching | | `append_label_names` | array | No | Label names to add to all contacts in this request \(e.g., \["Hot Lead"\]\) | | `run_dedupe` | boolean | No | Enable deduplication to prevent creating duplicate contacts. When true, existing contacts are returned without modification | @@ -338,7 +328,6 @@ Update up to 100 existing contacts at once in your Apollo database. Each contact | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `contact_ids` | array | No | Array of contact IDs to update. Must be paired with an object-form contact_attributes specifying the fields to apply uniformly to all listed contacts. | | `contact_attributes` | json | No | Required. Either an array of per-contact updates \(each with id\) — used standalone — or a single object of attributes to apply to all contact_ids. Supported fields: owner_id, email, organization_name, title, first_name, last_name, account_id, present_raw_address, linkedin_url, typed_custom_fields | | `async` | boolean | No | Force asynchronous processing. Automatically enabled for >100 contacts | @@ -364,7 +353,6 @@ Create a new account (company) in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `name` | string | Yes | Company name \(e.g., "Acme Corporation"\) | | `domain` | string | No | Company domain without www. prefix \(e.g., "acme.com"\) | | `phone` | string | No | Primary phone number for the account | @@ -392,7 +380,6 @@ Update an existing account in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `account_id` | string | Yes | ID of the account to update \(e.g., "acc_abc123"\) | | `name` | string | No | Company name \(e.g., "Acme Corporation"\) | | `domain` | string | No | Company domain \(e.g., "acme.com"\) | @@ -421,7 +408,6 @@ Search your team's accounts in Apollo. Display limit: 50,000 records (100 record | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `q_organization_name` | string | No | Filter accounts by organization name \(partial-match search\) | | `account_stage_ids` | array | No | Filter by account stage IDs | | `account_label_ids` | array | No | Filter by account label IDs | @@ -449,7 +435,6 @@ Create up to 100 accounts at once in your Apollo database. Set run_dedupe=true t | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `accounts` | array | Yes | Array of accounts to create \(max 100\). Each account should include a name, and may optionally include domain, phone, phone_status_cd, raw_address, owner_id, linkedin_url, facebook_url, twitter_url, salesforce_id, and hubspot_id. | | `append_label_names` | array | No | Array of label names to add to ALL accounts in this request | | `run_dedupe` | boolean | No | When true, performs aggressive deduplication by domain, organization_id, and name \(defaults to false\) | @@ -478,7 +463,6 @@ Update up to 1000 existing accounts at once in your Apollo database (higher limi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `account_ids` | array | No | Array of account IDs to update with the same values \(max 1000\). Use with name/owner_id for uniform updates. Use either this OR account_attributes. | | `name` | string | No | When using account_ids, apply this name to all accounts | | `owner_id` | string | No | When using account_ids, apply this owner to all accounts | @@ -508,7 +492,6 @@ Create a new deal for an account in your Apollo database (master key required) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `name` | string | Yes | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) | | `account_id` | string | No | ID of the account this opportunity belongs to \(e.g., "acc_abc123"\) | | `amount` | string | No | Monetary value as a plain number string with no commas or currency symbols | @@ -536,7 +519,6 @@ Search and list all deals/opportunities in your team's Apollo account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `sort_by_field` | string | No | Sort field: "amount", "is_closed", or "is_won" | | `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | @@ -562,7 +544,6 @@ Retrieve complete details of a specific deal/opportunity by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `opportunity_id` | string | Yes | ID of the opportunity to retrieve \(e.g., "opp_abc123"\) | #### Output @@ -584,7 +565,6 @@ Update an existing deal/opportunity in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key | | `opportunity_id` | string | Yes | ID of the opportunity to update \(e.g., "opp_abc123"\) | | `name` | string | No | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) | | `amount` | string | No | Monetary value as a plain number string with no commas or currency symbols | @@ -612,7 +592,6 @@ Search for sequences/campaigns in your team's Apollo account (master key require | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `q_name` | string | No | Search sequences by name \(e.g., "Outbound Q1", "Follow-up"\) | | `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | @@ -638,7 +617,6 @@ Add contacts to an Apollo sequence | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `sequence_id` | string | Yes | ID of the sequence to add contacts to \(e.g., "seq_abc123"\) | | `contact_ids` | array | No | Array of contact IDs to add to the sequence \(e.g., \["con_abc123", "con_def456"\]\). Either contact_ids or label_names must be provided. | | `label_names` | array | No | Array of label names to identify contacts to add to the sequence. Either contact_ids or label_names must be provided. | @@ -681,7 +659,6 @@ Create one or more tasks in Apollo (one task per contact_id, master key required | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `user_id` | string | Yes | ID of the Apollo user the task is assigned to | | `contact_ids` | array | Yes | Array of contact IDs. One task is created per contact. | | `priority` | string | No | Task priority: "high", "medium", or "low" \(defaults to "medium"\) | @@ -709,7 +686,6 @@ Search for tasks in Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `sort_by_field` | string | No | Sort field: "task_due_at" or "task_priority" | | `open_factor_names` | array | No | Filter by status. Common values: \["task_types"\] for open tasks, \["task_completed_at"\] for completed tasks. | | `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | @@ -734,7 +710,6 @@ Get list of team's linked email accounts in Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Apollo API key \(master key required\) | #### Output diff --git a/apps/docs/content/docs/integrations/appconfig.mdx b/apps/docs/content/docs/integrations/appconfig.mdx index d139e93f943..a74de4b4201 100644 --- a/apps/docs/content/docs/integrations/appconfig.mdx +++ b/apps/docs/content/docs/integrations/appconfig.mdx @@ -2,7 +2,7 @@ title: AWS AppConfig description: Manage and retrieve configuration with AWS AppConfig integration: - type: "appconfig" + type: "appconfig_v2" color: "linear-gradient(45deg, #B0084D 0%, #FF4F8B 100%)" --- @@ -12,12 +12,12 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} Use [AWS AppConfig](https://docs.aws.amazon.com/appconfig/) to manage applications, environments, configuration profiles, and deployments. Read deployed configuration at runtime or create hosted configuration versions for a rollout. -Authentication uses an AWS access key ID and secret access key. The associated IAM principal needs the relevant `appconfig:*` permissions (for example `appconfig:GetLatestConfiguration` and `appconfig:StartConfigurationSession` for retrieval, and `appconfig:StartDeployment` for rollouts). +It signs in with a saved [AWS credential](/integrations/aws-credentials). The associated IAM principal needs the relevant `appconfig:*` permissions (for example `appconfig:GetLatestConfiguration` and `appconfig:StartConfigurationSession` for retrieval, and `appconfig:StartDeployment` for rollouts). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Manage applications, environments, and configuration profiles, create and read hosted configuration versions, run and inspect deployments, and retrieve the latest deployed configuration at runtime. Requires AWS access key and secret access key. +Manage applications, environments, and configuration profiles, create and read hosted configuration versions, run and inspect deployments, and retrieve the latest deployed configuration at runtime. ## Actions @@ -32,8 +32,6 @@ Retrieve the latest deployed configuration for an AppConfig application, environ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID or name to retrieve configuration for | | `environmentId` | string | Yes | The environment ID or name to retrieve configuration for | | `configurationProfileId` | string | Yes | The configuration profile ID or name to retrieve | @@ -59,8 +57,6 @@ List applications in AWS AppConfig | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum number of applications to return \(1-50\) | | `nextToken` | string | No | Pagination token from a previous response | @@ -88,8 +84,6 @@ Create an application in AWS AppConfig | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Name of the application to create | | `description` | string | No | Description of the application | @@ -115,8 +109,6 @@ Get details about a single AWS AppConfig application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID to retrieve | #### Output @@ -140,8 +132,6 @@ Update the name or description of an AWS AppConfig application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID to update | | `name` | string | No | New name for the application | | `description` | string | No | New description for the application | @@ -168,8 +158,6 @@ Delete an AWS AppConfig application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID to delete | #### Output @@ -192,8 +180,6 @@ List environments for an AWS AppConfig application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the environments | | `maxResults` | number | No | Maximum number of environments to return \(1-50\) | | `nextToken` | string | No | Pagination token from a previous response | @@ -224,8 +210,6 @@ Create an environment for an AWS AppConfig application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID to create the environment in | | `name` | string | Yes | Name of the environment to create | | `description` | string | No | Description of the environment | @@ -253,8 +237,6 @@ Get details about a single AWS AppConfig environment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the environment | | `environmentId` | string | Yes | The environment ID to retrieve | @@ -284,8 +266,6 @@ Update the name or description of an AWS AppConfig environment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the environment | | `environmentId` | string | Yes | The environment ID to update | | `name` | string | No | New name for the environment | @@ -314,8 +294,6 @@ Delete an AWS AppConfig environment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the environment | | `environmentId` | string | Yes | The environment ID to delete | @@ -340,8 +318,6 @@ List configuration profiles for an AWS AppConfig application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profiles | | `maxResults` | number | No | Maximum number of configuration profiles to return \(1-50\) | | `nextToken` | string | No | Pagination token from a previous response | @@ -373,8 +349,6 @@ Create a configuration profile in an AWS AppConfig application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID to create the configuration profile in | | `name` | string | Yes | Name of the configuration profile | | `locationUri` | string | Yes | Where the configuration is stored. Use "hosted" for AppConfig-hosted configurations, or an SSM/S3 URI | @@ -406,8 +380,6 @@ Get details about a single AWS AppConfig configuration profile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profile | | `configurationProfileId` | string | Yes | The configuration profile ID to retrieve | @@ -438,8 +410,6 @@ Update the name, description, or retrieval role of an AppConfig configuration pr | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profile | | `configurationProfileId` | string | Yes | The configuration profile ID to update | | `name` | string | No | New name for the configuration profile | @@ -470,8 +440,6 @@ Delete an AWS AppConfig configuration profile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profile | | `configurationProfileId` | string | Yes | The configuration profile ID to delete | @@ -496,8 +464,6 @@ Create a new hosted configuration version for an AppConfig configuration profile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profile | | `configurationProfileId` | string | Yes | The configuration profile ID to add the version to | | `content` | string | Yes | The configuration content \(e.g., a JSON or YAML document\) | @@ -530,8 +496,6 @@ Retrieve a specific hosted configuration version from an AppConfig profile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profile | | `configurationProfileId` | string | Yes | The configuration profile ID to read the version from | | `versionNumber` | number | Yes | The version number to retrieve | @@ -561,8 +525,6 @@ List hosted configuration versions for an AWS AppConfig configuration profile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profile | | `configurationProfileId` | string | Yes | The configuration profile ID to list versions for | | `maxResults` | number | No | Maximum number of versions to return \(1-50\) | @@ -595,8 +557,6 @@ Delete a specific hosted configuration version from an AppConfig profile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID that owns the configuration profile | | `configurationProfileId` | string | Yes | The configuration profile ID that owns the version | | `versionNumber` | number | Yes | The version number to delete | @@ -623,8 +583,6 @@ List deployment strategies available in AWS AppConfig | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum number of deployment strategies to return \(1-50\) | | `nextToken` | string | No | Pagination token from a previous response | @@ -657,8 +615,6 @@ Start deploying a configuration version to an AWS AppConfig environment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID to deploy in | | `environmentId` | string | Yes | The environment ID to deploy to | | `deploymentStrategyId` | string | Yes | The deployment strategy ID to use | @@ -688,8 +644,6 @@ Get details about a specific AWS AppConfig deployment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID of the deployment | | `environmentId` | string | Yes | The environment ID of the deployment | | `deploymentNumber` | number | Yes | The sequence number of the deployment | @@ -724,8 +678,6 @@ List deployments for an AWS AppConfig environment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID of the deployments | | `environmentId` | string | Yes | The environment ID of the deployments | | `maxResults` | number | No | Maximum number of deployments to return \(1-50\) | @@ -760,8 +712,6 @@ Stop an in-progress AWS AppConfig deployment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `applicationId` | string | Yes | The application ID of the deployment | | `environmentId` | string | Yes | The environment ID of the deployment | | `deploymentNumber` | number | Yes | The sequence number of the deployment to stop | diff --git a/apps/docs/content/docs/integrations/athena.mdx b/apps/docs/content/docs/integrations/athena.mdx index 90bacc9c569..23663e485cd 100644 --- a/apps/docs/content/docs/integrations/athena.mdx +++ b/apps/docs/content/docs/integrations/athena.mdx @@ -2,7 +2,7 @@ title: Athena description: Run SQL queries on data in Amazon S3 using AWS Athena integration: - type: "athena" + type: "athena_v2" color: "linear-gradient(45deg, #4D27A8 0%, #A166FF 100%)" --- @@ -10,12 +10,12 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -[Amazon Athena](https://aws.amazon.com/athena/) queries data in Amazon S3 with SQL. Start a query, check its execution status, then retrieve the results; cancel a query when needed. Run parameterized queries with execution parameters and prepared statements, reuse recent results, and read runtime statistics after a query completes. The integration also manages named queries, browses data catalogs, databases, and table schemas, and inspects workgroup configuration. Connect with an AWS access key and secret access key. +[Amazon Athena](https://aws.amazon.com/athena/) queries data in Amazon S3 with SQL. Start a query, check its execution status, then retrieve the results; cancel a query when needed. Run parameterized queries with execution parameters and prepared statements, reuse recent results, and read runtime statistics after a query completes. The integration also manages named queries, browses data catalogs, databases, and table schemas, and inspects workgroup configuration. Connect with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Execute SQL queries against data in S3, check query status and runtime statistics, retrieve results, manage named queries and prepared statements, and inspect data catalogs, databases, tables, and workgroups. Requires AWS access key and secret access key. +Execute SQL queries against data in S3, check query status and runtime statistics, retrieve results, manage named queries and prepared statements, and inspect data catalogs, databases, tables, and workgroups. ## Actions @@ -30,8 +30,6 @@ Start an SQL query execution in AWS Athena | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryString` | string | Yes | SQL query string to execute | | `database` | string | No | Database name within the catalog | | `catalog` | string | No | Data catalog name \(default: AwsDataCatalog\) | @@ -60,8 +58,6 @@ Get the status and details of an Athena query execution | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryExecutionId` | string | Yes | Query execution ID to check | #### Output @@ -98,8 +94,6 @@ Retrieve the results of a completed Athena query execution | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryExecutionId` | string | Yes | Query execution ID to get results for | | `maxResults` | number | No | Maximum number of rows to return \(1-999\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -126,8 +120,6 @@ Stop a running Athena query execution | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryExecutionId` | string | Yes | Query execution ID to stop | #### Output @@ -149,8 +141,6 @@ List recent Athena query execution IDs | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `workGroup` | string | No | Workgroup to list executions for \(default: primary\) | | `maxResults` | number | No | Maximum number of results \(0-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -175,8 +165,6 @@ Get the status and details of up to 50 Athena query executions in one call | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryExecutionIds` | string | Yes | Comma-separated query execution IDs to check \(up to 50\) | #### Output @@ -218,8 +206,6 @@ Create a saved/named query in AWS Athena | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Name for the saved query | | `database` | string | Yes | Database the query runs against | | `queryString` | string | Yes | SQL query string to save | @@ -245,8 +231,6 @@ Get details of a saved/named query in AWS Athena | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `namedQueryId` | string | Yes | Named query ID to retrieve | #### Output @@ -273,8 +257,6 @@ List saved/named query IDs in AWS Athena | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `workGroup` | string | No | Workgroup to list named queries for | | `maxResults` | number | No | Maximum number of results \(0-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -299,8 +281,6 @@ Delete a saved/named query in AWS Athena | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `namedQueryId` | string | Yes | Named query ID to delete | #### Output @@ -322,8 +302,6 @@ List the databases available in an Athena data catalog | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `catalogName` | string | Yes | Data catalog name to list databases from \(e.g., AwsDataCatalog\) | | `workGroup` | string | No | Workgroup for which the metadata is being fetched \(required for IAM Identity Center enabled catalogs\) | | `maxResults` | number | No | Maximum number of results \(1-50\) | @@ -352,8 +330,6 @@ List tables and their column/partition metadata for an Athena database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `catalogName` | string | Yes | Data catalog name \(e.g., AwsDataCatalog\) | | `databaseName` | string | Yes | Database name to list tables from | | `expression` | string | No | Regex filter that pattern-matches table names | @@ -394,8 +370,6 @@ Get runtime statistics (timeline, row counts, and output stage) for a completed | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryExecutionId` | string | Yes | Query execution ID to get runtime statistics for | #### Output @@ -438,8 +412,6 @@ Get the details of up to 50 Athena named queries by ID in a single call | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `namedQueryIds` | string | Yes | Comma-separated named query IDs \(up to 50\) | #### Output @@ -471,8 +443,6 @@ Update the name, description, or SQL of an existing Athena named query (database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `namedQueryId` | string | Yes | Named query ID to update | | `name` | string | Yes | New name for the query \(1-128 characters\) | | `queryString` | string | Yes | New SQL query text | @@ -497,8 +467,6 @@ Create a parameterized prepared statement in an Athena workgroup for use with EX | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `statementName` | string | Yes | Prepared statement name \(letters, digits, _ @ : ; must start with a letter or underscore\) | | `workGroup` | string | Yes | Workgroup the prepared statement belongs to | | `queryStatement` | string | Yes | SQL statement with ? placeholders for parameters | @@ -523,8 +491,6 @@ Get the SQL and metadata of a prepared statement in an Athena workgroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `statementName` | string | Yes | Prepared statement name \(letters, digits, _ @ : ; must start with a letter or underscore\) | | `workGroup` | string | Yes | Workgroup the prepared statement belongs to | @@ -551,8 +517,6 @@ Get the details of up to 256 prepared statements in an Athena workgroup by name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `preparedStatementNames` | string | Yes | Comma-separated prepared statement names \(up to 256\) | | `workGroup` | string | Yes | Workgroup the prepared statement belongs to | @@ -584,8 +548,6 @@ Replace the SQL and description of an existing prepared statement in an Athena w | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `statementName` | string | Yes | Prepared statement name \(letters, digits, _ @ : ; must start with a letter or underscore\) | | `workGroup` | string | Yes | Workgroup the prepared statement belongs to | | `queryStatement` | string | Yes | New SQL statement with ? placeholders for parameters | @@ -610,8 +572,6 @@ List the prepared statements saved in an Athena workgroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `workGroup` | string | Yes | Workgroup to list prepared statements for | | `maxResults` | number | No | Maximum number of results \(1-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -638,8 +598,6 @@ Delete a prepared statement from an Athena workgroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `statementName` | string | Yes | Prepared statement name \(letters, digits, _ @ : ; must start with a letter or underscore\) | | `workGroup` | string | Yes | Workgroup the prepared statement belongs to | @@ -662,8 +620,6 @@ List the data catalogs (data sources) registered in the AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `workGroup` | string | No | Workgroup name \(required for IAM Identity Center requests\) | | `maxResults` | number | No | Maximum number of results \(2-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -693,8 +649,6 @@ Get the type, status, and connection parameters of an Athena data catalog | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Data catalog name \(e.g., AwsDataCatalog\) | | `workGroup` | string | No | Workgroup name \(required for IAM Identity Center requests\) | @@ -723,8 +677,6 @@ Get a single database (name, description, and parameters) from an Athena data ca | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `catalogName` | string | Yes | Data catalog name \(e.g., AwsDataCatalog\) | | `databaseName` | string | Yes | Database name | | `workGroup` | string | No | Workgroup name \(required for IAM Identity Center enabled catalogs\) | @@ -750,8 +702,6 @@ Get the columns, partition keys, and properties of a single table in an Athena d | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `catalogName` | string | Yes | Data catalog name \(e.g., AwsDataCatalog\) | | `databaseName` | string | Yes | Database name | | `tableName` | string | Yes | Table name | @@ -788,8 +738,6 @@ List the Athena workgroups available in the AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum number of results \(1-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -821,8 +769,6 @@ Get the configuration of an Athena workgroup, including its result location, enc | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `workGroup` | string | Yes | Workgroup name | #### Output diff --git a/apps/docs/content/docs/integrations/aws-credentials.mdx b/apps/docs/content/docs/integrations/aws-credentials.mdx new file mode 100644 index 00000000000..7643a969ef5 --- /dev/null +++ b/apps/docs/content/docs/integrations/aws-credentials.mdx @@ -0,0 +1,65 @@ +--- +title: AWS credentials +description: Save an AWS identity once and use it across every AWS block, with access keys, an assumed IAM role, or a keyless role that trusts Sim through OpenID Connect +--- + +import { Callout } from '@/components/ui/callout' +import { Step, Steps } from '@/components/ui/steps' + +An AWS credential holds one AWS identity for the whole workspace. Every AWS block (S3, DynamoDB, Lambda, SQS, Athena, CloudWatch, and the rest) signs in with a saved credential, so keys live in one place instead of in each block. + + +Blocks added before saved credentials, which take access keys typed into the block, are marked legacy and keep working exactly as they are. Upgrade one by replacing it with the current block and selecting a credential. + + +## Choose how Sim signs in + +| Option | What Sim stores | When to use it | +| --- | --- | --- | +| **IAM role (keyless, via Sim OIDC)** | Nothing secret: only the role ARN | Recommended. No long-lived keys to rotate or leak. | +| **Access keys that assume an IAM role** | An access key pair, used only to assume the role | Your AWS account doesn't allow OIDC providers, or you need an external ID. | +| **Access keys** | An access key pair | The same behavior as keys typed into a block, shared across blocks. | + +Every option resolves on Sim's servers at run time. The saved keys and the sessions Sim gets from them stay out of block outputs, logs, and anything a model sees, with two exceptions AWS requires: an S3 presigned URL made with a temporary session contains that session's token, and actions that issue credentials (STS **Assume Role** and **Get Session Token**, IAM **Create Access Key**) return what they issue. Anyone who can use the credential can run those actions to the extent its IAM permissions allow, so grant it only what your workflows need. Each assumed-role session is named `sim-`, so runs are traceable in CloudTrail. + + +STS **Get Session Token** works only with an **Access keys** credential: AWS refuses it for role sessions. An STS **Assume Role** call made with a role credential is role chaining, which AWS caps at one hour regardless of the requested duration. + + +## Set up a keyless IAM role [#keyless-role] + + + + In Sim, open **Integrations**, add an **AWS credential**, and choose **IAM role (keyless, via Sim OIDC)**. Keep the dialog open; it shows the values for the next steps. + + + In the AWS IAM console, open **Identity providers → Add provider**, choose **OpenID Connect**, and enter the **Identity provider URL** and **Audience** from the dialog. You only do this once per AWS account. + + + Create a role (or edit an existing one) and set its trust policy to the **Role trust policy** shown in the dialog. It trusts only this credential's **Subject**, so no other Sim credential, workspace, or customer can assume the role. + + + Attach the permissions your workflows need to the role, then paste its ARN into the dialog and save. Sim verifies the connection by assuming the role before saving it, and refuses a role that would also trust a different subject. + + + + +The subject is unique to the credential. Reconnecting a keyless credential keeps its subject by default, so the role's trust policy keeps working; choose **Issue a new subject** only if you also update the trust policy. + + +## Use access keys + +Create an IAM user (or use an existing one) with an access key, choose **Access keys** or **Access keys that assume an IAM role**, and enter the key pair. For an assumed role, add the role ARN and, if the role's trust policy requires one, the external ID. For AWS GovCloud or China keys, set the **STS region** (for example `us-gov-west-1`). Sim checks the keys with `sts:GetCallerIdentity` before saving. + +To rotate a key, create the new key in AWS, reconnect the credential with it, confirm a run succeeds, then deactivate and delete the old key. Every block using the credential switches at once. + +## Self-hosted deployments + +Keyless roles need two things on a self-hosted deployment: + +- `WORKLOAD_IDENTITY_SIGNING_KEY`: a PKCS#8 PEM RSA private key that signs Sim's tokens. +- An issuer AWS can reach over the public internet. It defaults to `/oidc/workload`; set `WORKLOAD_IDENTITY_ISSUER` to pin it. Trust policies reference this URL, so never change it once roles trust it. + +To rotate the signing key, move the old key to `WORKLOAD_IDENTITY_PREVIOUS_KEY` and set a new `WORKLOAD_IDENTITY_SIGNING_KEY`. Both keys stay published until you remove the old one. + +Without a signing key, the keyless option is unavailable and access keys work as usual. diff --git a/apps/docs/content/docs/integrations/brex.mdx b/apps/docs/content/docs/integrations/brex.mdx index 85d02c8dc38..db1e97f70a1 100644 --- a/apps/docs/content/docs/integrations/brex.mdx +++ b/apps/docs/content/docs/integrations/brex.mdx @@ -2,7 +2,7 @@ title: Brex description: Manage expenses, receipts, transactions, and team data in Brex integration: - type: "brex" + type: "brex_v2" color: "#171717" --- @@ -37,7 +37,6 @@ List expenses in the Brex account with optional filters for user, status, paymen | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `userIds` | string | No | Comma-separated user IDs to filter expenses by owner | | `statuses` | string | No | Comma-separated expense statuses to filter by: DRAFT, SUBMITTED, APPROVED, OUT_OF_POLICY, VOID, CANCELED, SPLIT, SETTLED | | `paymentStatuses` | string | No | Comma-separated payment statuses to filter by: NOT_STARTED, PROCESSING, CANCELED, DECLINED, CLEARED, REFUNDING, REFUNDED, CASH_ADVANCE, CREDITED, AWAITING_PAYMENT, SCHEDULED | @@ -103,7 +102,6 @@ Get a single Brex expense by its ID, including merchant, user, and receipt detai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `expenseId` | string | Yes | ID of the expense to fetch | #### Output @@ -170,7 +168,6 @@ Update the memo of a Brex card expense | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `expenseId` | string | Yes | ID of the card expense to update | | `memo` | string | Yes | New memo for the expense | @@ -206,7 +203,6 @@ Upload a receipt file and attach it to a specific Brex card expense | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `expenseId` | string | Yes | ID of the card expense to attach the receipt to | | `file` | file | Yes | Receipt file to upload \(max 50 MB\) | | `receiptName` | string | No | Receipt file name including extension \(defaults to the uploaded file name\) | @@ -231,7 +227,6 @@ Upload a receipt file and let Brex automatically match it with existing expenses | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `file` | file | Yes | Receipt file to upload \(max 50 MB\) | | `receiptName` | string | No | Receipt file name including extension \(defaults to the uploaded file name\) | @@ -255,7 +250,6 @@ List settled card transactions for all Brex card accounts | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `userIds` | string | No | Comma-separated user IDs to filter transactions by cardholder | | `postedAtStart` | string | No | Only include transactions posted at or after this ISO 8601 timestamp | | `cursor` | string | No | Pagination cursor from a previous response | @@ -294,7 +288,6 @@ List transactions for a Brex cash account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `accountId` | string | Yes | ID of the cash account to list transactions for | | `postedAtStart` | string | No | Only include transactions posted at or after this ISO 8601 timestamp | | `cursor` | string | No | Pagination cursor from a previous response | @@ -328,7 +321,6 @@ List all Brex card accounts with balances and limits | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | #### Output @@ -360,7 +352,6 @@ List all Brex cash accounts with balances and account details | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of accounts to return \(default 100, max 1000\) | @@ -395,7 +386,6 @@ Get a Brex cash account by ID, or the primary cash account when no ID is provide | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `accountId` | string | No | ID of the cash account \(defaults to the primary cash account\) | #### Output @@ -427,7 +417,6 @@ List finalized statements for the primary Brex card account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of statements to return \(default 100, max 1000\) | @@ -458,7 +447,6 @@ List finalized statements for a Brex cash account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `accountId` | string | Yes | ID of the cash account to list statements for | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of statements to return \(default 100, max 1000\) | @@ -490,7 +478,6 @@ List users in the Brex account, optionally filtered by email | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `email` | string | No | Filter users by exact email address | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of users to return \(default 100, max 1000\) | @@ -523,7 +510,6 @@ Get a Brex user by their ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `userId` | string | Yes | ID of the user to fetch | #### Output @@ -552,7 +538,6 @@ Get the Brex user associated with the API token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | #### Output @@ -580,7 +565,6 @@ List departments in the Brex account, optionally filtered by name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `name` | string | No | Filter departments by name | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of departments to return \(default 100, max 1000\) | @@ -607,7 +591,6 @@ List locations in the Brex account, optionally filtered by name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `name` | string | No | Filter locations by name | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of locations to return \(default 100, max 1000\) | @@ -634,7 +617,6 @@ List job titles in the Brex account, optionally filtered by name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `name` | string | No | Filter titles by name | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of titles to return \(default 100, max 1000\) | @@ -660,7 +642,6 @@ List cards in the Brex account, optionally filtered by card owner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `userId` | string | No | Filter cards by the ID of the card owner | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of cards to return \(default 100, max 1000\) | @@ -695,7 +676,6 @@ Get the Brex company associated with the API token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | #### Output @@ -718,7 +698,6 @@ List budgets in the Brex account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of budgets to return \(default 100, max 1000\) | @@ -755,7 +734,6 @@ Get a Brex budget by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `budgetId` | string | Yes | ID of the budget to fetch | #### Output @@ -789,7 +767,6 @@ Create a new budget in the Brex account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `name` | string | Yes | Name for the budget | | `description` | string | Yes | Description of what the budget is used for | | `parentBudgetId` | string | Yes | ID of the parent budget | @@ -831,7 +808,6 @@ Archive a Brex budget, making any spend limits beneath it unusable for future ex | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `budgetId` | string | Yes | ID of the budget to archive | #### Output @@ -853,7 +829,6 @@ List spend limits in the Brex account, optionally filtered by member user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `memberUserIds` | string | No | Comma-separated user IDs to filter spend limits by member | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of spend limits to return \(default 100, max 1000\) | @@ -901,7 +876,6 @@ Get a Brex spend limit by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `spendLimitId` | string | Yes | ID of the spend limit to fetch | #### Output @@ -945,7 +919,6 @@ Create a new spend limit (hard-authorization card program) in the Brex account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `name` | string | Yes | Name for the spend limit | | `periodRecurrenceType` | string | Yes | Period type of the spend limit \(PER_WEEK, PER_MONTH, PER_QUARTER, PER_YEAR, ONE_TIME\) | | `spendType` | string | Yes | Whether the spend limit can only be spent from cards it provisions \(BUDGET_PROVISIONED_CARDS_ONLY, NON_BUDGET_PROVISIONED_CARDS_ALLOWED\) | @@ -1009,7 +982,6 @@ List vendors in the Brex account, optionally filtered by name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `name` | string | No | Filter vendors by name | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of vendors to return \(default 100, max 1000\) | @@ -1038,7 +1010,6 @@ Get a Brex vendor by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `vendorId` | string | Yes | ID of the vendor to fetch | #### Output @@ -1063,7 +1034,6 @@ Create a new vendor in the Brex account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `companyName` | string | Yes | Name for the vendor \(must be unique\) | | `email` | string | No | Email address for the vendor | | `phone` | string | No | Phone number for the vendor | @@ -1090,7 +1060,6 @@ Update an existing vendor in the Brex account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `vendorId` | string | Yes | ID of the vendor to update | | `companyName` | string | No | New name for the vendor | | `email` | string | No | New email address for the vendor | @@ -1118,7 +1087,6 @@ List money transfers in the Brex account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `cursor` | string | No | Pagination cursor from a previous response | | `limit` | string | No | Number of transfers to return \(default 100, max 1000\) | @@ -1158,7 +1126,6 @@ Get a Brex money transfer by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `transferId` | string | Yes | ID of the transfer to fetch | #### Output @@ -1195,7 +1162,6 @@ Create a money transfer from a Brex cash account to a vendor | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Brex user token \(generated from Developer Settings in the Brex dashboard\) | | `cashAccountId` | string | Yes | ID of the Brex cash account to send the transfer from \(found via the /accounts endpoint\) | | `vendorPaymentInstrumentId` | string | Yes | ID of the vendor's payment instrument to send the transfer to \(from the vendor's payment_accounts\) | | `amount` | number | Yes | Amount to transfer, in the smallest unit of the currency \(e.g., cents for USD\) | diff --git a/apps/docs/content/docs/integrations/brightdata.mdx b/apps/docs/content/docs/integrations/brightdata.mdx index 8c5d3804195..a371651af8e 100644 --- a/apps/docs/content/docs/integrations/brightdata.mdx +++ b/apps/docs/content/docs/integrations/brightdata.mdx @@ -2,7 +2,7 @@ title: Bright Data description: Scrape websites, search engines, and extract structured data integration: - type: "brightdata" + type: "brightdata_v2" color: "#FFFFFF" --- @@ -29,7 +29,6 @@ Fetch page content with Bright Data Web Unlocker, including its supported anti-b | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `zone` | string | Yes | Web Unlocker zone name from your Bright Data dashboard \(e.g., "web_unlocker1"\) | | `url` | string | Yes | The URL to scrape \(e.g., "https://example.com/page") | | `format` | string | No | Response format: "raw" for HTML or "json" for parsed content. Defaults to "raw" | @@ -56,7 +55,6 @@ Search Google, Bing, DuckDuckGo, or Yandex and get structured search results usi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `zone` | string | Yes | SERP API zone name from your Bright Data dashboard \(e.g., "serp_api1"\) | | `query` | string | Yes | The search query \(e.g., "best project management tools"\) | | `searchEngine` | string | No | Search engine to use: "google", "bing", "duckduckgo", or "yandex". Defaults to "google" | @@ -88,7 +86,6 @@ AI-powered web discovery that finds and ranks results by intent. Returns up to 2 | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `query` | string | Yes | The search query \(e.g., "competitor pricing changes enterprise plan"\) | | `numResults` | number | No | Number of results to return \(1-20\). Defaults to 10 | | `mode` | string | No | Search depth and ranking mode: "standard" \(balanced\), "deep" \(exhaustive, broader search\), "fast" \(optimized for speed\), or "zeroRanking" \(raw volume without AI filtering\). Defaults to "standard" | @@ -123,7 +120,6 @@ Scrape URLs synchronously using a Bright Data pre-built scraper and get structur | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `datasetId` | string | Yes | Dataset scraper ID from your Bright Data dashboard \(e.g., "gd_l1viktl72bvl7bjuj0"\) | | `urls` | string | Yes | JSON array of URL objects to scrape, up to 20 \(e.g., \[ \{ "url": "https://example.com/product" \} \]\) | | `format` | string | No | Output format: "json", "ndjson", or "csv". Defaults to "json" | @@ -149,7 +145,6 @@ Trigger a Bright Data pre-built scraper to extract structured data from URLs. Su | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `datasetId` | string | Yes | Dataset scraper ID from your Bright Data dashboard \(e.g., "gd_l1viktl72bvl7bjuj0"\) | | `urls` | string | Yes | JSON array of URL objects to scrape \(e.g., \[ \{ "url": "https://example.com/product" \} \]\) | | `format` | string | No | Output format: "json" or "csv". Defaults to "json" | @@ -174,7 +169,6 @@ Check the progress of an async Bright Data scraping job. Returns status: startin | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `snapshotId` | string | Yes | The snapshot ID returned when the collection was triggered \(e.g., "s_m4x7enmven8djfqak"\) | #### Output @@ -197,7 +191,6 @@ Download the results of a completed Bright Data scraping job using its snapshot | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `snapshotId` | string | Yes | The snapshot ID returned when the collection was triggered \(e.g., "s_m4x7enmven8djfqak"\) | | `format` | string | No | Output format: "json", "ndjson", "jsonl", or "csv". Defaults to "json" | | `compress` | boolean | No | Whether to compress the results | @@ -222,7 +215,6 @@ Cancel an active Bright Data scraping job using its snapshot ID. Terminates data | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Bright Data API token | | `snapshotId` | string | Yes | The snapshot ID of the collection to cancel \(e.g., "s_m4x7enmven8djfqak"\) | #### Output diff --git a/apps/docs/content/docs/integrations/browser_use.mdx b/apps/docs/content/docs/integrations/browser_use.mdx index 6e76c7f1459..8e5a7bfc10f 100644 --- a/apps/docs/content/docs/integrations/browser_use.mdx +++ b/apps/docs/content/docs/integrations/browser_use.mdx @@ -2,7 +2,7 @@ title: Browser Use description: Run browser automation tasks integration: - type: "browser_use" + type: "browser_use_v2" color: "#181C1E" --- @@ -42,7 +42,6 @@ Runs a browser automation task using BrowserUse | `highlightElements` | boolean | No | Highlight interactive elements on the page \(default true\) | | `metadata` | json | No | Custom key-value metadata \(up to 10 pairs\) for tracking | | `model` | string | No | LLM model identifier \(e.g. browser-use-2.0\) | -| `apiKey` | string | Yes | API key for BrowserUse API | | `profile_id` | string | No | Browser profile ID for persistent sessions \(cookies, login state\) | #### Output diff --git a/apps/docs/content/docs/integrations/buffer.mdx b/apps/docs/content/docs/integrations/buffer.mdx index 573604c8971..95e00e956ac 100644 --- a/apps/docs/content/docs/integrations/buffer.mdx +++ b/apps/docs/content/docs/integrations/buffer.mdx @@ -2,7 +2,7 @@ title: Buffer description: Schedule and publish social media posts across connected channels integration: - type: "buffer" + type: "buffer_v2" color: "#FFFFFF" --- @@ -14,7 +14,7 @@ Use [Buffer](https://buffer.com/) to draft, queue, schedule, publish, edit, and ## Authentication -Create an API key under Buffer **Settings → API** and enter it in **API Key**. Sim sends it as a Bearer token to Buffer's GraphQL API. The key can reach the organizations and channels available to its account, subject to its permissions. +Create an API key under Buffer **Settings → API** and add it as a Buffer credential. Sim sends it as a Bearer token to Buffer's GraphQL API. The key can reach the organizations and channels available to its account, subject to its permissions. Enable the permissions your workflow needs: `account:read`, `posts:read`, `posts:write`, `ideas:read`, `ideas:write`, and `insights:read`. The block includes 13 operations; preview operations are excluded. @@ -47,7 +47,6 @@ Create a post in Buffer for a channel — add it to the queue, share it immediat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `channelId` | string | Yes | Channel to create the post for \(find it with the Get Channels operation\) | | `text` | string | No | Text content of the post \(required unless media is attached\) | | `mode` | string | Yes | How to share the post: addToQueue, shareNext, shareNow, or customScheduled \(requires dueAt\) | @@ -379,7 +378,6 @@ Edit an existing Buffer post — update its text, schedule, or media. Attaching | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `postId` | string | Yes | ID of the post to edit | | `text` | string | No | New text content of the post | | `mode` | string | No | Change the share mode to addToQueue, shareNext, shareNow, or customScheduled \(requires dueAt\). Omit to keep the current schedule | @@ -711,7 +709,6 @@ List posts in a Buffer organization, optionally filtered by channel and status ( | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `organizationId` | string | Yes | Buffer organization ID \(find it with the Get Account operation\) | | `channelIds` | string | No | Comma-separated channel IDs to filter by | | `status` | string | No | Comma-separated statuses to filter by: draft, needs_approval, scheduled, sending, sent, error | @@ -1338,7 +1335,6 @@ Get a single Buffer post by ID, including its status, schedule, and media | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `postId` | string | Yes | ID of the post to fetch | #### Output @@ -1654,7 +1650,6 @@ Delete a Buffer post by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `postId` | string | Yes | ID of the post to delete | #### Output @@ -1676,7 +1671,6 @@ List the social media channels connected to a Buffer organization, including the | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `organizationId` | string | Yes | Buffer organization ID \(find it with the Get Account operation\) | | `filter` | json | No | Filter channels by locked status or product. Schema | @@ -1762,7 +1756,6 @@ Get one connected channel, including its posting schedule, limits and network se | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key with account:read permission | | `channelId` | string | Yes | Buffer channel ID | #### Output @@ -1847,7 +1840,6 @@ Aggregate published post metrics across an organization or selected channels ove | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key with insights:read permission | | `organizationId` | string | Yes | Buffer organization ID | | `startDateTime` | string | Yes | Start of aggregation window as an ISO 8601 timestamp | | `endDateTime` | string | Yes | End of aggregation window as an ISO 8601 timestamp | @@ -1879,7 +1871,6 @@ Check sent and scheduled post counts against each channel’s daily limit for a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key with posts:read permission | | `channelIds` | json | Yes | Channel ID array or comma-separated IDs; all channels must belong to the same organization | | `date` | string | No | ISO 8601 timestamp for the date to check; omit for today | @@ -1906,7 +1897,6 @@ Save a content idea to a Buffer organization for later drafting and scheduling | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `organizationId` | string | Yes | Buffer organization ID \(find it with the Get Account operation\) | | `text` | string | No | Text content of the idea | | `title` | string | No | Optional title for the idea | @@ -1965,7 +1955,6 @@ List content ideas saved in a Buffer organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `organizationId` | string | Yes | Buffer organization ID \(find it with the Get Account operation\) | | `limit` | number | No | Maximum number of ideas to return \(default 20\) | | `after` | string | No | Pagination cursor from a previous page \(pageInfo.endCursor\) | @@ -2060,7 +2049,6 @@ List idea groups (board columns) in a Buffer organization, including the group I | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `organizationId` | string | Yes | Buffer organization ID \(find it with the Get Account operation\) | #### Output @@ -2084,7 +2072,6 @@ Get the authenticated Buffer account, including its organizations and their IDs | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Buffer API key | | `organizationFilter` | json | No | Filter account organizations by organization ID. Schema | #### Output diff --git a/apps/docs/content/docs/integrations/circleback.mdx b/apps/docs/content/docs/integrations/circleback.mdx index 8a1362227f2..ddc9656c0a3 100644 --- a/apps/docs/content/docs/integrations/circleback.mdx +++ b/apps/docs/content/docs/integrations/circleback.mdx @@ -2,7 +2,7 @@ title: Circleback description: Read Circleback meetings, notes, transcripts, and action items integration: - type: "circleback" + type: "circleback_v2" color: "linear-gradient(180deg, #E0F7FA 0%, #FFFFFF 100%)" --- @@ -33,7 +33,6 @@ Lists meetings from Circleback with optional ownership, status, tag, and attende | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `ownership` | string | No | Which meetings to return: All, Mine, or Shared. Defaults to Mine | | `statuses` | string | No | Comma-separated meeting statuses to filter by | | `tagIds` | string | No | Comma-separated tag IDs to filter by | @@ -91,7 +90,6 @@ Gets a Circleback meeting by ID, including notes, attendees, action items, insig | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `meetingId` | string | Yes | The unique identifier of the meeting | #### Output @@ -142,7 +140,6 @@ Searches Circleback meetings by name and content, with optional filters for spec | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `searchTerm` | string | No | The text to search for across meeting names and content | | `meetingIds` | string | No | Comma-separated meeting IDs to restrict the search to | | `tagIds` | string | No | Comma-separated tag IDs to restrict the search to | @@ -200,7 +197,6 @@ Gets the full transcript for a Circleback meeting. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `meetingId` | string | Yes | The unique identifier of the meeting | #### Output @@ -224,7 +220,6 @@ Updates the name, notes, or private notes of a Circleback meeting. The API retur | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `meetingId` | string | Yes | The unique identifier of the meeting | | `name` | string | No | The new name of the meeting | | `notes` | string | No | The new meeting notes in Markdown | @@ -252,7 +247,6 @@ Deletes a Circleback meeting. Only the owner of the meeting can delete it. Retur | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `meetingId` | string | Yes | The unique identifier of the meeting | #### Output @@ -303,7 +297,6 @@ Lists action items across the authenticated user meetings, filtered by assignee, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `assigneeType` | string | No | The assignee scope to filter by: Me, NotMe, Profile, MyWorkspace, OutsideMyWorkspace, Unassigned, or Anyone. Defaults to Me | | `assigneeProfileId` | string | No | Profile ID of the assignee to filter by | | `assigneeTeamId` | string | No | Team ID of the assignee to filter by | @@ -344,7 +337,6 @@ Updates the title, description, status, or assignee of a Circleback action item. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `actionItemId` | string | Yes | The unique identifier of the action item | | `title` | string | No | The new title of the action item | | `description` | string | No | The new detailed description of the action item | @@ -380,7 +372,6 @@ Deletes a Circleback action item. Returns the deleted action item. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `actionItemId` | string | Yes | The unique identifier of the action item | #### Output @@ -412,7 +403,6 @@ Lists upcoming calendar events from the authenticated user connected calendars, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `startTimeLookbackHours` | string | No | How many hours in the past to include calendar meetings from | | `startTimeLookaheadHours` | string | No | How many hours in the future to include calendar meetings from | | `sortDirection` | string | No | The direction calendar meetings are sorted in by start time: ascending or descending. Defaults to ascending | @@ -462,7 +452,6 @@ Lists the companies whose people attend the authenticated user meetings, with op | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `tagIds` | string | No | Comma-separated tag IDs. Filters companies to those with meetings so tagged | | `cursor` | string | No | Pagination cursor from a previous response | @@ -490,7 +479,6 @@ Gets a company by its domain from Circleback, including its people and external | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `domain` | string | Yes | The website domain of the company to fetch, such as example.com | #### Output @@ -525,7 +513,6 @@ Lists the people who attend the authenticated user meetings, ordered by most rec | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `domains` | string | No | Comma-separated company domains to filter people by | | `tagIds` | string | No | Comma-separated tag IDs. Filters people to attendees of meetings so tagged | | `limit` | string | No | The maximum number of people to return | @@ -558,7 +545,6 @@ Gets a person by their profile ID from Circleback, including their profile detai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `profileId` | string | Yes | The unique identifier of the person profile | #### Output @@ -589,7 +575,6 @@ Lists every tag available to the authenticated Circleback user. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | #### Output @@ -612,7 +597,6 @@ Creates a new tag in Circleback. If a tag with the same name already exists, a c | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `tagName` | string | Yes | The display name of the tag | | `tagDescription` | string | No | A description of the tag | @@ -636,7 +620,6 @@ Updates the name or description of a Circleback tag. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `tagId` | string | Yes | The unique identifier of the tag | | `tagName` | string | No | The new display name of the tag | | `tagDescription` | string | No | The new description of the tag | @@ -661,7 +644,6 @@ Permanently deletes a Circleback tag and removes it from every meeting it was ap | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `tagId` | string | Yes | The unique identifier of the tag | #### Output @@ -684,7 +666,6 @@ Applies an existing Circleback tag to one or more meetings and returns the updat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `tagId` | string | Yes | The unique identifier of the tag to apply | | `meetingIds` | string | No | Comma-separated IDs of the meetings to tag | @@ -737,7 +718,6 @@ Removes a Circleback tag from one or more meetings and returns the updated meeti | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Circleback API key | | `tagId` | string | Yes | The unique identifier of the tag to remove | | `meetingIds` | string | No | Comma-separated IDs of the meetings to remove the tag from | diff --git a/apps/docs/content/docs/integrations/clerk.mdx b/apps/docs/content/docs/integrations/clerk.mdx index 3334f6d625b..ccf78446121 100644 --- a/apps/docs/content/docs/integrations/clerk.mdx +++ b/apps/docs/content/docs/integrations/clerk.mdx @@ -2,7 +2,7 @@ title: Clerk description: Manage users, organizations, and sessions in Clerk integration: - type: "clerk" + type: "clerk_v2" color: "#131316" --- @@ -31,7 +31,6 @@ List all users in your Clerk application with optional filtering and pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `limit` | number | No | Number of results per page \(e.g., 10, 50, 100; range: 1-500, default: 10\) | | `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) | | `orderBy` | string | No | Sort field with optional +/- prefix for direction \(default: -created_at\) | @@ -86,7 +85,6 @@ Retrieve a single user by their ID from Clerk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user to retrieve \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -140,7 +138,6 @@ Create a new user in your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `emailAddress` | string | No | Email addresses for the user \(comma-separated for multiple\) | | `phoneNumber` | string | No | Phone numbers for the user \(comma-separated for multiple\) | | `username` | string | No | Username for the user \(must be unique\) | @@ -191,7 +188,6 @@ Update an existing user in your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user to update \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `firstName` | string | No | First name of the user | | `lastName` | string | No | Last name of the user | @@ -244,7 +240,6 @@ Delete a user from your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user to delete \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -268,7 +263,6 @@ Ban a user, preventing them from signing in | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user to ban \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -297,7 +291,6 @@ Remove a ban from a user, allowing them to sign in again | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user to unban \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -326,7 +319,6 @@ Lock a user account, blocking sign-in attempts | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user to lock \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -355,7 +347,6 @@ Unlock a previously locked user account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user to unlock \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -384,7 +375,6 @@ Retrieve a user's OAuth access token for a connected external provider (e.g. Goo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | The ID of the user \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `provider` | string | Yes | OAuth provider slug, e.g. google, github, microsoft, discord \(without the oauth_ prefix\) | @@ -414,7 +404,6 @@ List all organizations in your Clerk application with optional filtering | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `limit` | number | No | Number of results per page \(e.g., 10, 50, 100; range: 1-500, default: 10\) | | `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) | | `includeMembersCount` | boolean | No | Include member count for each organization | @@ -454,7 +443,6 @@ Retrieve a single organization by ID or slug from Clerk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID or slug of the organization to retrieve \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC or my-org-slug\) | #### Output @@ -488,7 +476,6 @@ Create a new organization in your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `name` | string | Yes | Name of the organization | | `createdBy` | string | Yes | User ID of the creator who will become admin \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `slug` | string | No | Slug identifier for the organization | @@ -527,7 +514,6 @@ Update an existing organization in your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization to update \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `name` | string | No | Name of the organization | | `slug` | string | No | Slug identifier for the organization | @@ -565,7 +551,6 @@ Delete an organization from your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization to delete \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -589,7 +574,6 @@ List members of a Clerk organization with optional filtering and pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `limit` | number | No | Number of results per page \(e.g., 10, 50, 100; range: 1-500, default: 10\) | | `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) | @@ -631,7 +615,6 @@ Add a user as a member of a Clerk organization with a given role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `userId` | string | Yes | ID of the user to add as a member | | `role` | string | Yes | Role to assign, e.g. org:admin or org:member | @@ -669,7 +652,6 @@ Change a member's role within a Clerk organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `userId` | string | Yes | ID of the member whose role is being changed | | `role` | string | Yes | New role to assign, e.g. org:admin or org:member | @@ -707,7 +689,6 @@ Remove a member from a Clerk organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `userId` | string | Yes | ID of the member to remove | @@ -744,7 +725,6 @@ Invite a user by email to join a Clerk organization with a given role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `emailAddress` | string | Yes | Email address of the user to invite | | `role` | string | Yes | Role to assign on acceptance, e.g. org:admin or org:member | @@ -788,7 +768,6 @@ List pending and past invitations for a Clerk organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `organizationId` | string | Yes | The ID of the organization \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `status` | string | No | Filter by status: pending, accepted, revoked, or expired | | `emailAddress` | string | No | Filter by invited email address | @@ -831,7 +810,6 @@ List sessions for a user or client in your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | No | User ID to list sessions for \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC; required if clientId not provided\) | | `clientId` | string | No | Client ID to list sessions for \(required if userId not provided\) | | `status` | string | No | Filter by session status \(abandoned, active, ended, expired, pending, removed, replaced, revoked\) | @@ -868,7 +846,6 @@ Retrieve a single session by ID from Clerk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `sessionId` | string | Yes | The ID of the session to retrieve \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -899,7 +876,6 @@ Revoke a session to immediately invalidate it | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `sessionId` | string | Yes | The ID of the session to revoke \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -930,7 +906,6 @@ List email/phone/web3-wallet identifiers on your Clerk instance allowlist | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `limit` | number | No | Number of results per page \(e.g., 10, 50, 100; range: 1-500, default: 10\) | | `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) | @@ -960,7 +935,6 @@ Add an email, phone number, or web3 wallet to your Clerk instance allowlist | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `identifier` | string | Yes | Email address, phone number, or web3 wallet to allow \(wildcards like *@example.com supported for email\) | | `notify` | boolean | No | Whether to notify the identifier owner by email \(default false\) | @@ -988,7 +962,6 @@ Remove an identifier from your Clerk instance allowlist | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `identifierId` | string | Yes | ID of the allowlist identifier to delete | #### Output @@ -1012,7 +985,6 @@ List email/phone/web3-wallet identifiers on your Clerk instance blocklist | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | #### Output @@ -1039,7 +1011,6 @@ Add an email, phone number, or web3 wallet to your Clerk instance blocklist to p | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `identifier` | string | Yes | Email address, phone number, or web3 wallet to block | #### Output @@ -1065,7 +1036,6 @@ Remove an identifier from your Clerk instance blocklist | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `identifierId` | string | Yes | ID of the blocklist identifier to delete | #### Output @@ -1089,7 +1059,6 @@ List custom JWT templates configured on your Clerk instance | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | #### Output @@ -1120,7 +1089,6 @@ Retrieve a single custom JWT template by ID from Clerk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `templateId` | string | Yes | ID of the JWT template to retrieve | #### Output @@ -1150,7 +1118,6 @@ Create an actor token to impersonate a user (God Mode / act-as-user), e.g. for s | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `userId` | string | Yes | ID of the user to impersonate | | `actor` | json | Yes | Actor JSON object identifying who is impersonating, must include a "sub" field, e.g. \{"sub": "user_support_agent_id"\} | | `expiresInSeconds` | number | No | Seconds until the token expires \(default 3600\) | @@ -1182,7 +1149,6 @@ Revoke an actor token before it is used or expires | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `actorTokenId` | string | Yes | ID of the actor token to revoke | #### Output diff --git a/apps/docs/content/docs/integrations/cloudflare.mdx b/apps/docs/content/docs/integrations/cloudflare.mdx index 8c5cbd865ee..1e854a397ad 100644 --- a/apps/docs/content/docs/integrations/cloudflare.mdx +++ b/apps/docs/content/docs/integrations/cloudflare.mdx @@ -2,7 +2,7 @@ title: Cloudflare description: Manage DNS, WAF, Zero Trust access, and edge infrastructure integration: - type: "cloudflare" + type: "cloudflare_v2" color: "#F5F6FA" --- @@ -77,7 +77,6 @@ Creates a Cloudflare Access (Zero Trust) application that puts an identity check | `policies` | string | No | JSON array of policies to attach. Entries may be reusable policy IDs or inline policy objects, e.g. \["<POLICY_ID>"\] | | `saasApp` | string | No | JSON SaaS configuration, required for the saas type and rejected on every other type. SAML, e.g. \{ "auth_type": "saml", "consumer_service_url": "https://example.com/acs", "sp_entity_id": "https://example.com" \}; OIDC, e.g. \{ "auth_type": "oidc", "client_id": "...", "redirect_uris": \[ "https://example.com/callback" \] \} | | `targetCriteria` | string | No | JSON array of infrastructure target criteria, required for the infrastructure and rdp types and rejected on every other type, e.g. \[\{"port":22,"protocol":"SSH","target_attributes":\{"hostname":\["production"\]\}\}\] | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -476,7 +475,6 @@ Creates a new Access group. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | -| `apiKey` | string | Yes | Cloudflare API token | | `exclude` | json | No | JSON array. Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules. Fields: group, any_valid_service_token, auth_context, auth_method, azureAD, certificate, common_name, geo, device_posture, email_domain, email_list, email, everyone, external_evaluation, github-organization, gsuite, login_method, ip_list, ip, okta, saml, oidc, service_token, linked_app_token, user_risk_score, cloudflare_account_member. | | `include` | json | Yes | JSON array. Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules. Fields: group, any_valid_service_token, auth_context, auth_method, azureAD, certificate, common_name, geo, device_posture, email_domain, email_list, email, everyone, external_evaluation, github-organization, gsuite, login_method, ip_list, ip, okta, saml, oidc, service_token, linked_app_token, user_risk_score, cloudflare_account_member. | | `is_default` | boolean | No | Whether this is the default group | @@ -772,7 +770,6 @@ Creates a Cloudflare Access (Zero Trust) policy on an application, deciding who | `isolationRequired` | boolean | No | Whether the session must run in a remote isolated browser | | `purposeJustificationRequired` | boolean | No | Whether users must state a reason for access | | `purposeJustificationPrompt` | string | No | Prompt shown when a justification is required | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -1013,7 +1010,6 @@ Creates a Cloudflare Access (Zero Trust) service token so a machine can authenti | `accountId` | string | Yes | The Cloudflare account ID. Service tokens are account-scoped | | `name` | string | Yes | Name of the service token | | `duration` | string | No | How long the token stays valid before it expires, e.g. 8760h. Defaults to Cloudflare's standard lifetime | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -1055,7 +1051,6 @@ Creates a new DNS record for a zone. | `priority` | number | No | Record priority. Cloudflare accepts this top-level field for MX and URI records only; use the data object for structured records such as SRV \(priority, weight, port, target\) | | `comment` | string | No | Comment for the DNS record | | `tags` | string | No | Comma-separated tags for the DNS record | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -1143,7 +1138,6 @@ Creates an R2 object storage bucket in an account. The location hint and jurisdi | `locationHint` | string | No | Region hint for where the bucket should live: apac, eeur, enam, weur, wnam, or oc. Cannot be changed after creation | | `storageClass` | string | No | Default storage class for objects: Standard or InfrequentAccess | | `jurisdiction` | string | No | Data-residency jurisdiction to create the bucket in: default, eu, or fedramp. Cannot be changed after creation | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -1188,7 +1182,6 @@ Creates a rate limiting rule in the http_ratelimit phase entry point ruleset of | `requestsToOrigin` | boolean | No | When true, only requests that reach the origin are counted | | `description` | string | No | Human-readable description of the rule | | `enabled` | boolean | No | Whether the rule is enabled | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -1453,7 +1446,6 @@ Creates a zone ruleset for a phase, optionally seeded with its first rules. Use | `kind` | string | No | Ruleset kind: zone or custom. Use zone to create a phase entry point ruleset and custom for a ruleset an execute rule deploys. Defaults to zone. "root" is the account-level phase entry point and "managed" is Cloudflare-owned, so neither can be created on this zone-scoped endpoint | | `description` | string | No | Description of the ruleset | | `rules` | json | No | JSON array of rules to seed the ruleset with, in evaluation order. Each rule takes action, expression, and optionally description, enabled, action_parameters, and ratelimit | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -1725,7 +1717,6 @@ Adds a rule to a zone ruleset. Use "Get Phase Entry Point Ruleset" first to find | `ref` | string | No | Reference tag that stays stable across rule updates | | `actionParameters` | string | No | JSON object of action-specific parameters. For an "execute" rule this carries the managed ruleset id and any overrides, e.g. \{"id":"<MANAGED_RULESET_ID>","overrides":\{"action":"log"\}\} | | `position` | string | No | JSON object placing the rule within the ruleset. Exactly one of \{"before":"<RULE_ID>"\}, \{"after":"<RULE_ID>"\}, or \{"index":<1-based position>\} | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -1984,7 +1975,6 @@ Creates a remotely or locally managed Cloudflare Tunnel in an account. After cre | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | -| `apiKey` | string | Yes | Cloudflare API token | | `config_src` | string | No | Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard. Allowed values: local, cloudflare. | | `name` | string | Yes | A user-friendly name for a tunnel. | | `tunnel_secret` | string | No | Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string. | @@ -2028,7 +2018,6 @@ Creates a route that maps a URL pattern to a Worker. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | -| `apiKey` | string | Yes | Cloudflare API token | | `pattern` | string | Yes | Pattern to match incoming requests against. \[Learn more\]\(https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior). | | `script` | string | No | Name of the script to run if the route matches. | @@ -2055,7 +2044,6 @@ Adds a new zone (domain) to the Cloudflare account. | `name` | string | Yes | The domain name to add \(e.g., "example.com"\) | | `accountId` | string | Yes | The Cloudflare account ID | | `type` | string | No | Zone type: "full" \(Cloudflare manages DNS\), "partial" \(CNAME setup\), "secondary" \(secondary DNS\), or "internal" \(internal DNS zone\) | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2124,7 +2112,6 @@ Permanently deletes a Cloudflare Access (Zero Trust) application and every polic | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | The Cloudflare account ID. Access applications are account-scoped | | `appId` | string | Yes | The Access application ID to delete permanently | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2146,7 +2133,6 @@ Deletes an Access group. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `groupId` | string | Yes | Group id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -2169,7 +2155,6 @@ Permanently deletes a Cloudflare Access (Zero Trust) policy from an application. | `accountId` | string | Yes | The Cloudflare account ID. Access applications are account-scoped | | `appId` | string | Yes | The Access application ID that owns the policy | | `policyId` | string | Yes | The Access policy ID to delete permanently | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2191,7 +2176,6 @@ Deletes a DNS record from a zone. | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID containing the DNS record | | `recordId` | string | Yes | The DNS record ID to delete | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2214,7 +2198,6 @@ Permanently deletes an R2 object storage bucket. Cloudflare only deletes an empt | `accountId` | string | Yes | The Cloudflare account ID. R2 buckets are account-scoped | | `bucketName` | string | Yes | The name of the bucket to delete permanently | | `jurisdiction` | string | No | Data-residency jurisdiction the bucket lives in: default, eu, or fedramp | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2236,7 +2219,6 @@ Delete the CORS policy for a bucket. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `bucketName` | string | Yes | Bucket name | -| `apiKey` | string | Yes | Cloudflare API token | | `jurisdiction` | string | No | Jurisdiction where objects in this bucket are guaranteed to be stored. | #### Output @@ -2259,7 +2241,6 @@ Deletes all versions of an existing zone ruleset. | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | | `rulesetId` | string | Yes | Ruleset id | -| `apiKey` | string | Yes | Cloudflare API token | | `dry_run` | boolean | No | Validates the request without persisting changes when set to `true`. Responses that normally return 200 return `result: null`; endpoints that normally return 204 continue to return 204. | #### Output @@ -2284,7 +2265,6 @@ Permanently deletes a rule from a zone ruleset. This takes effect immediately on | `zoneId` | string | Yes | The zone ID that owns the ruleset | | `rulesetId` | string | Yes | The ruleset ID containing the rule | | `ruleId` | string | Yes | The rule ID to delete permanently | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2544,7 +2524,6 @@ Permanently deletes a Cloudflare Tunnel from an account. The tunnel must have no | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `tunnelId` | string | Yes | Tunnel id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -2586,7 +2565,6 @@ Deletes a Worker route. | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | | `routeId` | string | Yes | Route id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -2608,7 +2586,6 @@ Delete your worker. This call has no response body on a successful delete. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `scriptName` | string | Yes | Script name | -| `apiKey` | string | Yes | Cloudflare API token | | `force` | boolean | No | If true, delete the Worker even when other Workers still reference it. Service bindings in those Workers may be left broken. Durable Object namespaces implemented by the deleted Worker are deleted even if other Workers reference them. | #### Output @@ -2630,7 +2607,6 @@ Deletes a zone (domain) from the Cloudflare account. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID to delete | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2658,7 +2634,6 @@ Gets DNS analytics report for a zone including query counts and trends. | `filters` | string | No | Filters to apply to the data \(e.g., "queryType==A"\) | | `sort` | string | No | Sort order for the result set. Fields must be included in metrics or dimensions \(e.g., "+queryCount" or "-responseTimeAvg"\) | | `limit` | number | No | Maximum number of results to return | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -2702,7 +2677,6 @@ Reads a single Cloudflare Access (Zero Trust) application, including its attache | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | The Cloudflare account ID. Access applications are account-scoped | | `appId` | string | Yes | The Access application ID \(or audience tag\) to read | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -3102,7 +3076,6 @@ Fetches a single Access group. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `groupId` | string | Yes | Group id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -3380,7 +3353,6 @@ Fetches a single Access policy configured for an application. Returns both exclu | `accountId` | string | Yes | Account id | | `appId` | string | Yes | App id | | `policyId` | string | Yes | Policy id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -3617,7 +3589,6 @@ Fetches a single service token. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `serviceTokenId` | string | Yes | Service token id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -3650,7 +3621,6 @@ Retrieves details for a specific DNS record in the zone. | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | | `recordId` | string | Yes | Dns record id | -| `apiKey` | string | Yes | Cloudflare API token | | `include_shadow_metadata` | boolean | No | Whether to include shadow metadata in the `meta` field of each record in the response. See \[Shadowed records\]\(https://developers.cloudflare.com/dns/manage-dns-records/reference/shadowed-records). | #### Output @@ -3737,7 +3707,6 @@ Reads the metadata of a single R2 object storage bucket. Requires an API token w | `accountId` | string | Yes | The Cloudflare account ID. R2 buckets are account-scoped | | `bucketName` | string | Yes | The name of the bucket to read | | `jurisdiction` | string | No | Data-residency jurisdiction the bucket lives in: default, eu, or fedramp | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -3763,7 +3732,6 @@ Get the CORS policy for a bucket. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `bucketName` | string | Yes | Bucket name | -| `apiKey` | string | Yes | Cloudflare API token | | `jurisdiction` | string | No | Jurisdiction where objects in this bucket are guaranteed to be stored. | #### Output @@ -3793,7 +3761,6 @@ Get object lifecycle rules for a bucket. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `bucketName` | string | Yes | Bucket name | -| `apiKey` | string | Yes | Cloudflare API token | | `jurisdiction` | string | No | Jurisdiction where objects in this bucket are guaranteed to be stored. | #### Output @@ -3835,7 +3802,6 @@ Reads a single zone ruleset including every rule it contains, in evaluation orde | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID that owns the ruleset | | `rulesetId` | string | Yes | The ruleset ID to read | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -4095,7 +4061,6 @@ Reads the entry point ruleset for a phase on a zone, including all of its rules. | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID to read the phase entry point for | | `phase` | string | Yes | The ruleset phase, e.g. http_request_firewall_custom, http_request_firewall_managed, http_ratelimit, http_request_transform, http_request_dynamic_redirect | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -4355,7 +4320,6 @@ Reads a single Cloudflare Tunnel (cloudflared), including its health status and | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | The Cloudflare account ID. Tunnels are account-scoped | | `tunnelId` | string | Yes | The tunnel ID to read | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -4397,7 +4361,6 @@ Reads the configuration of a remotely-managed Cloudflare Tunnel — its ingress | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | The Cloudflare account ID. Tunnels are account-scoped | | `tunnelId` | string | Yes | The tunnel ID to read the configuration for | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -4468,7 +4431,6 @@ Gets the connector token used to run a remotely managed Cloudflare Tunnel with c | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Cloudflare account ID | | `tunnelId` | string | Yes | Cloudflare Tunnel ID | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -4490,7 +4452,6 @@ Returns information about a Worker route, including URL pattern and Worker. | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | | `routeId` | string | Yes | Route id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -4514,7 +4475,6 @@ Reads the deployment settings of a single Workers script — bindings, compatibi | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | The Cloudflare account ID. Workers scripts are account-scoped | | `scriptName` | string | Yes | The name of the Workers script to read settings for | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -4685,7 +4645,6 @@ Gets details for a specific zone (domain) by its ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID to retrieve details for | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -4754,7 +4713,6 @@ Reads zone settings such as SSL mode, minimum TLS version, security level, and c | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID to get settings for | | `settingIds` | string | No | Comma-separated setting IDs to read, e.g. "ssl,min_tls_version,security_level". Leave blank to read the default set \(ssl, always_use_https, min_tls_version, tls_1_3, security_level, cache_level, browser_cache_ttl, development_mode, rocket_loader, email_obfuscation, hotlink_protection, ip_geolocation, http2, http3, websockets\). At most 40 settings per call. | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -4791,7 +4749,6 @@ Lists the Cloudflare Access (Zero Trust) applications protecting an account. Req | `exact` | boolean | No | Whether the name and domain filters must match exactly | | `page` | number | No | Page number for pagination | | `per_page` | number | No | Number of applications per page | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -5206,7 +5163,6 @@ Lists the reusable Cloudflare Access (Zero Trust) groups in an account. Groups b | `search` | string | No | Free-text search across groups | | `page` | number | No | Page number for pagination | | `per_page` | number | No | Number of groups per page | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -5497,7 +5453,6 @@ Lists the identity providers configured for Cloudflare Access (Zero Trust) in an | `page` | number | No | Page number of results. | | `per_page` | number | No | Number of results per page. | | `accountId` | string | Yes | The Cloudflare account ID. Identity providers are account-scoped | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -5591,7 +5546,6 @@ Lists the Cloudflare Access (Zero Trust) policies attached to an application, in | `appId` | string | Yes | The Access application ID whose policies should be listed | | `page` | number | No | Page number for pagination | | `per_page` | number | No | Number of policies per page | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -5843,7 +5797,6 @@ Lists the Cloudflare Access (Zero Trust) service tokens in an account, which let | `search` | string | No | Free-text search across service tokens | | `page` | number | No | Page number for pagination | | `per_page` | number | No | Number of service tokens per page | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -5891,7 +5844,6 @@ Lists SSL/TLS certificate packs for a zone. | `page` | number | No | Page number of paginated results \(default: 1\) | | `per_page` | number | No | Number of certificate packs per page \(default: 20, min: 5, max: 50\) | | `deploy` | string | No | Filter by deployment environment: "staging" or "production" | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -5998,7 +5950,6 @@ Lists DNS records for a specific zone. | `tag` | string | No | Filter by tag name, or an exact name:value pair \(e.g., team:DNS\) | | `tag_match` | string | No | Tag filter match logic: any or all. Only affects results when combined with multiple tag filter conditions; has no effect with the single exact-match Tag Filter above. | | `commentFilter` | string | No | Filter records by comment content \(substring match\) | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6094,7 +6045,6 @@ Lists the WAF managed rulesets deployed on a zone together with the overrides ap | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID to read managed ruleset deployments and overrides for | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6130,7 +6080,6 @@ Lists the R2 object storage buckets in an account. Requires an API token with Ac | `direction` | string | No | Sort direction by bucket name: asc or desc | | `per_page` | number | No | Number of buckets per page | | `jurisdiction` | string | No | Data-residency jurisdiction to list within: default, eu, or fedramp | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6168,7 +6117,6 @@ Lists the rate limiting rules on a zone by reading the http_ratelimit phase entr | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID to list rate limiting rules for | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6429,7 +6377,6 @@ Lists every ruleset defined on a zone across all phases (WAF custom rules, manag | `zoneId` | string | Yes | The zone ID to list rulesets for | | `per_page` | number | No | Number of rulesets to return per page | | `cursor` | string | No | Cursor for the next page, taken from the cursor output of a previous call. This endpoint paginates by cursor, not by page number | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6480,7 +6427,6 @@ Lists the Cloudflare Tunnels (cloudflared) in an account, with their health stat | `was_inactive_at` | string | No | Return tunnels that were inactive at this RFC 3339 timestamp | | `page` | number | No | Page number for pagination | | `per_page` | number | No | Number of tunnels per page | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6533,7 +6479,6 @@ Lists the Workers routes on a zone, showing which URL patterns are handled by wh | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | The zone ID to list Workers routes for. Routes are zone-scoped, not account-scoped | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6569,7 +6514,6 @@ Lists the Workers scripts deployed in an account. Requires an API token with Acc | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | The Cloudflare account ID. Workers scripts are account-scoped | | `tags` | string | No | Filter scripts by tag. Cloudflare expects a comma-separated list of tag:allowed pairs where allowed is yes or no, e.g. team:core:yes,deprecated:no | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6671,7 +6615,6 @@ Lists one page of zones (domains) in the Cloudflare account. | `order` | string | No | Sort field \(name, status, account.id, account.name, plan.id\) | | `direction` | string | No | Sort direction \(asc, desc\) | | `match` | string | No | Match logic for filters \(any, all\). Default: all | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6756,7 +6699,6 @@ Purges cached content for a zone. Can purge everything or specific files/tags/ho | `tags` | string | No | Comma-separated list of cache tags to purge | | `hosts` | string | No | Comma-separated list of hostnames to purge | | `prefixes` | string | No | Comma-separated list of URL prefixes to purge | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6778,7 +6720,6 @@ Refreshes the expiration of a service token. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `serviceTokenId` | string | Yes | Service token id | -| `apiKey` | string | Yes | Cloudflare API token | #### Output @@ -6811,7 +6752,6 @@ Permanently deletes a Cloudflare Access (Zero Trust) service token, revoking it. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | The Cloudflare account ID. Service tokens are account-scoped | | `serviceTokenId` | string | Yes | The service token ID to revoke permanently | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -6844,7 +6784,6 @@ Generates a new Client Secret. The previous secret expires immediately unless pr | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `serviceTokenId` | string | Yes | Service token id | -| `apiKey` | string | Yes | Cloudflare API token | | `previous_client_secret_expires_at` | string | No | The expiration of the previous `client_secret`. If not provided, it defaults to the current timestamp in order to immediately expire the previous secret. If the service token was reported as leaked, this must not be in the future; the leaked secret is discarded immediately. | #### Output @@ -6917,7 +6856,6 @@ Updates a Cloudflare Access (Zero Trust) application. Cloudflare does not docume | `saasApp` | string | No | JSON SaaS configuration, required for the saas type and rejected on every other type. SAML, e.g. \{ "auth_type": "saml", "consumer_service_url": "https://example.com/acs", "sp_entity_id": "https://example.com" \}; OIDC, e.g. \{ "auth_type": "oidc", "client_id": "...", "redirect_uris": \[ "https://example.com/callback" \] \} | | `targetCriteria` | string | No | JSON array of infrastructure target criteria, required for the infrastructure and rdp types and rejected on every other type, e.g. \[\{"port":22,"protocol":"SSH","target_attributes":\{"hostname":\["production"\]\}\}\] | | `policies` | string | No | JSON array of policies to attach. Entries may be reusable policy IDs or inline policy objects | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -7317,7 +7255,6 @@ Updates a configured Access group. Replaces the configuration; resend all values | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `groupId` | string | Yes | Group id | -| `apiKey` | string | Yes | Cloudflare API token | | `exclude` | json | No | JSON array. Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules. Fields: group, any_valid_service_token, auth_context, auth_method, azureAD, certificate, common_name, geo, device_posture, email_domain, email_list, email, everyone, external_evaluation, github-organization, gsuite, login_method, ip_list, ip, okta, saml, oidc, service_token, linked_app_token, user_risk_score, cloudflare_account_member. | | `include` | json | Yes | JSON array. Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules. Fields: group, any_valid_service_token, auth_context, auth_method, azureAD, certificate, common_name, geo, device_posture, email_domain, email_list, email, everyone, external_evaluation, github-organization, gsuite, login_method, ip_list, ip, okta, saml, oidc, service_token, linked_app_token, user_risk_score, cloudflare_account_member. | | `is_default` | boolean | No | Whether this is the default group | @@ -7614,7 +7551,6 @@ Updates a Cloudflare Access (Zero Trust) policy on an application. Cloudflare do | `isolationRequired` | boolean | No | Whether the session must run in a remote isolated browser | | `purposeJustificationRequired` | boolean | No | Whether users must state a reason for access | | `purposeJustificationPrompt` | string | No | Prompt shown when a justification is required | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -7851,7 +7787,6 @@ Updates a configured service token. Replaces the configuration; resend all value | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `serviceTokenId` | string | Yes | Service token id | -| `apiKey` | string | Yes | Cloudflare API token | | `client_secret_version` | number | No | A version number identifying the current `client_secret` associated with the service token. Incrementing it triggers a rotation; the previous secret will still be accepted until the time indicated by `previous_client_secret_expires_at`. If the service token was reported as leaked, `previous_client_secret_expires_at` is not required, may not be in the future, and the previous secret is discarded immediately. | | `duration` | string | No | The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`, or the special value `forever` for non-expiring tokens. Valid time units are: ns, us \(or µs\), ms, s, m, h. The default is 1 year in hours \(8760h\). | | `enabled` | boolean | No | Whether the service token is enabled. A disabled service token cannot be used to authenticate; both its current and previous `client_secret` stop being accepted, but the token itself is preserved and can be re-enabled. A service token reported as leaked is disabled automatically and cannot be re-enabled until its secret is rotated; attempting to do so returns a 409. Defaults to enabled when omitted on create. | @@ -7902,7 +7837,6 @@ Updates an existing DNS record for a zone. | `priority` | number | No | Record priority. Cloudflare accepts this top-level field for MX and URI records only; use the data object for structured records such as SRV \(priority, weight, port, target\) | | `comment` | string | No | Comment for the DNS record | | `tags` | string | No | Comma-separated tags for the DNS record | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -7987,7 +7921,6 @@ Replaces the Cross-Origin Resource Sharing (CORS) rules for an R2 bucket. Rules | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `bucketName` | string | Yes | Bucket name | -| `apiKey` | string | Yes | Cloudflare API token | | `rules` | json | No | JSON array. rules Fields: allowed, exposeHeaders, id, maxAgeSeconds. | | `jurisdiction` | string | No | Jurisdiction where objects in this bucket are guaranteed to be stored. | @@ -8011,7 +7944,6 @@ Replaces the object lifecycle rules for an R2 bucket. Rules match object-key pre | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `bucketName` | string | Yes | Bucket name | -| `apiKey` | string | Yes | Cloudflare API token | | `rules` | string | Yes | Complete JSON array of lifecycle rules. Read the current rules first and include every rule to retain. Use \[\] only to remove all lifecycle rules. Fields: abortMultipartUploadsTransition, conditions, deleteObjectsTransition, enabled, id, storageClassTransitions. | | `jurisdiction` | string | No | Jurisdiction where objects in this bucket are guaranteed to be stored. | @@ -8054,7 +7986,6 @@ Updates a rate limiting rule in the http_ratelimit phase entry point ruleset of | `ref` | string | No | Reference tag that stays stable across rule updates. Because the update replaces the rule, omitting it resets the tag to the rule ID and breaks anything matching on the old value | | `actionParameters` | string | No | JSON object of action-specific parameters for the mitigation action, e.g. \{"response":\{"status_code":429,"content":"\{\"error\":\"rate limited\"\}","content_type":"application/json"\}\} for a custom block response. Because the update replaces the rule, omitting it resets action_parameters to \{\} and the rule falls back to Cloudflare's default block page | | `logging` | string | No | JSON logging configuration to preserve, e.g. \{"enabled":true\}. Omitting it on a rule that had logging configured resets it to the default | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -8314,7 +8245,6 @@ Updates the description and rules of a zone ruleset, creating a new version. Rea | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | | `rulesetId` | string | Yes | Ruleset id | -| `apiKey` | string | Yes | Cloudflare API token | | `description` | string | No | An informative description of the ruleset. | | `rules` | json | No | JSON array replacing the complete rule list. Read "Get Ruleset" first and include every rule to retain; omitted rules are removed, and \[\] removes all rules. Fields: action, action_parameters, categories, description, enabled, exposed_credential_check, expression, id, last_updated, logging, ratelimit, ref, version. | | `dry_run` | boolean | No | Validates the request without persisting changes when set to `true`. Responses that normally return 200 return `result: null`; endpoints that normally return 204 continue to return 204. | @@ -8589,7 +8519,6 @@ Updates a rule in a zone ruleset. Cloudflare replaces the rule definition rather | `actionParameters` | string | No | JSON object of action-specific parameters, e.g. \{"id":"<MANAGED_RULESET_ID>","overrides":\{"rules":\[\{"id":"<RULE_ID>","action":"log","enabled":true,"score_threshold":40\}\]\}\}. Required on an execute rule and must be sent on every update: the endpoint replaces the rule, so omitting it resets action_parameters to \{\} — which unbinds the managed ruleset the rule deploys and every override under it | | `ratelimit` | string | No | JSON rate limiting configuration to preserve on a rule in the http_ratelimit phase, e.g. \{"characteristics":\["cf.colo.id","ip.src"\],"period":60,"requests_per_period":100\}. Because the update replaces the rule, omitting this on a rate limiting rule stops it rate limiting | | `logging` | string | No | JSON logging configuration to preserve, e.g. \{"enabled":true\}. Omitting it on a rule that had logging configured resets it to the default | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output @@ -8849,7 +8778,6 @@ Updates the name or secret of an existing Cloudflare Tunnel. | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `tunnelId` | string | Yes | Tunnel id | -| `apiKey` | string | Yes | Cloudflare API token | | `name` | string | No | A user-friendly name for a tunnel. | | `tunnel_secret` | string | No | Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string. | @@ -8893,7 +8821,6 @@ Replaces the configuration for a remotely managed Cloudflare Tunnel, including i | --------- | ---- | -------- | ----------- | | `accountId` | string | Yes | Account id | | `tunnelId` | string | Yes | Tunnel id | -| `apiKey` | string | Yes | Cloudflare API token | | `config` | json | No | JSON object. The tunnel configuration and ingress rules. Fields: ingress, originRequest, warp-routing. | #### Output @@ -8965,7 +8892,6 @@ Replaces the URL pattern or Worker associated with a Worker route. Replaces the | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | | `routeId` | string | Yes | Route id | -| `apiKey` | string | Yes | Cloudflare API token | | `pattern` | string | Yes | Pattern to match incoming requests against. \[Learn more\]\(https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior). | | `script` | string | No | Name of the script to run if the route matches. | @@ -8990,7 +8916,6 @@ Edits a zone. Only one zone property can be changed at a time. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `zoneId` | string | Yes | Zone id | -| `apiKey` | string | Yes | Cloudflare API token | | `paused` | boolean | No | Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits. | | `plan` | json | No | JSON object. \(Deprecated\) Please use the `/zones/\{zone_id\}/subscription` API to update a zone's plan. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans. Fields: id. | | `type` | string | No | A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone. Allowed values: full, partial, secondary, internal. | @@ -9065,7 +8990,6 @@ Updates a specific zone setting such as SSL mode, security level, cache level, o | `zoneId` | string | Yes | The zone ID to update settings for | | `settingId` | string | Yes | Setting to update \(e.g., "ssl", "security_level", "cache_level", "always_use_https", "browser_cache_ttl", "http3", "min_tls_version", "ciphers"\) | | `value` | string | No | Required except for ssl_recommender. New value as a string, or a JSON string for complex values \(e.g., "full" for SSL, "medium" for security_level, "aggressive" for cache_level, \["ECDHE-RSA-AES128-GCM-SHA256"\] for ciphers\) | -| `apiKey` | string | Yes | Cloudflare API Token | #### Output diff --git a/apps/docs/content/docs/integrations/cloudformation.mdx b/apps/docs/content/docs/integrations/cloudformation.mdx index c540935d5bb..87814805465 100644 --- a/apps/docs/content/docs/integrations/cloudformation.mdx +++ b/apps/docs/content/docs/integrations/cloudformation.mdx @@ -2,7 +2,7 @@ title: CloudFormation description: Manage and inspect AWS CloudFormation stacks, resources, and drift integration: - type: "cloudformation" + type: "cloudformation_v2" color: "linear-gradient(45deg, #B0084D 0%, #FF4F8B 100%)" --- @@ -10,12 +10,12 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS CloudFormation](https://aws.amazon.com/cloudformation/) to manage template-defined resource stacks. Create or update stacks, preview changes with change sets, inspect resources and events, and check drift or template validity from a workflow. +Use [AWS CloudFormation](https://aws.amazon.com/cloudformation/) to manage template-defined resource stacks. Create or update stacks, preview changes with change sets, inspect resources and events, and check drift or template validity from a workflow. Connect with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Create, update, and delete stacks, preview changes with change sets, describe stacks, list resources, detect drift, view stack events, and retrieve or validate templates. Requires AWS access key and secret access key. +Create, update, and delete stacks, preview changes with change sets, describe stacks, list resources, detect drift, view stack events, and retrieve or validate templates. ## Actions @@ -30,8 +30,6 @@ List and describe CloudFormation stacks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | No | Stack name or ID to describe \(omit to list all stacks\) | #### Output @@ -53,8 +51,6 @@ Create a new CloudFormation stack from a template | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Name for the new stack \(must be unique in the Region\) | | `templateBody` | string | Yes | The CloudFormation template body \(JSON or YAML\) | | `parameters` | json | No | Template input parameters \(e.g., \[\{"parameterKey": "InstanceType", "parameterValue": "t3.micro"\}\]\) | @@ -82,8 +78,6 @@ Update an existing CloudFormation stack with a new or previous template | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Name or ID of the stack to update | | `templateBody` | string | No | The new CloudFormation template body \(JSON or YAML\). Required unless usePreviousTemplate is true | | `usePreviousTemplate` | boolean | No | Reuse the template currently associated with the stack instead of providing templateBody | @@ -110,8 +104,6 @@ Delete a CloudFormation stack and its resources | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Name or ID of the stack to delete | | `retainResources` | string | No | Comma-separated logical resource IDs to retain instead of deleting \(only applies to stacks in DELETE_FAILED state\) | @@ -134,8 +126,6 @@ Cancel an in-progress stack update and roll back to the last known stable state | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Name or ID of the stack whose update should be cancelled | #### Output @@ -157,8 +147,6 @@ Preview the changes a stack create or update would make before applying them | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Name of the stack to create or update \(new name for CREATE type, existing name for UPDATE\) | | `changeSetName` | string | Yes | Name for the new change set | | `templateBody` | string | No | The CloudFormation template body \(JSON or YAML\). Required unless usePreviousTemplate is true | @@ -188,8 +176,6 @@ View the resource changes a change set would make and its execution status | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `changeSetName` | string | Yes | Name or ARN of the change set to describe | | `stackName` | string | No | Name or ID of the stack the change set belongs to \(required if changeSetName is not an ARN\) | @@ -222,8 +208,6 @@ Apply a previously created and reviewed change set to its stack | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `changeSetName` | string | Yes | Name or ARN of the change set to execute | | `stackName` | string | No | Name or ID of the stack the change set belongs to \(required if changeSetName is not an ARN\) | @@ -246,8 +230,6 @@ List all resources in a CloudFormation stack | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Stack name or ID | #### Output @@ -269,8 +251,6 @@ Initiate drift detection on a CloudFormation stack | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Stack name or ID to detect drift on | #### Output @@ -292,8 +272,6 @@ Check the status of a stack drift detection operation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackDriftDetectionId` | string | Yes | The drift detection ID returned by Detect Stack Drift | #### Output @@ -321,8 +299,6 @@ Get the event history for a CloudFormation stack | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Stack name or ID | | `limit` | number | No | Maximum number of events to return \(default: 50\) | @@ -345,8 +321,6 @@ Retrieve the template body for a CloudFormation stack | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `stackName` | string | Yes | Stack name or ID | | `templateStage` | string | No | Which template version to retrieve: Processed \(default, with transforms applied\) or Original \(as submitted\) | @@ -370,8 +344,6 @@ Get a summary of a template or deployed stack: resource types, required capabili | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `templateBody` | string | No | The CloudFormation template body \(JSON or YAML\). Required if stackName is not provided | | `stackName` | string | No | Name or ID of a deployed stack to summarize instead of a template body | @@ -400,8 +372,6 @@ Validate a CloudFormation template for syntax and structural correctness | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `templateBody` | string | Yes | The CloudFormation template body \(JSON or YAML\) | #### Output diff --git a/apps/docs/content/docs/integrations/cloudtrail.mdx b/apps/docs/content/docs/integrations/cloudtrail.mdx index fde1ff1aea4..3cdabcb5a1a 100644 --- a/apps/docs/content/docs/integrations/cloudtrail.mdx +++ b/apps/docs/content/docs/integrations/cloudtrail.mdx @@ -2,7 +2,7 @@ title: CloudTrail description: Audit who did what in AWS with CloudTrail event history and Lake queries integration: - type: "cloudtrail" + type: "cloudtrail_v2" color: "linear-gradient(45deg, #B0084D 0%, #FF4F8B 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -[AWS CloudTrail](https://aws.amazon.com/cloudtrail/) records API activity in AWS accounts. Use it to look up events, inspect trail configuration and logging status, or run CloudTrail Lake queries. +[AWS CloudTrail](https://aws.amazon.com/cloudtrail/) records API activity in AWS accounts. Use it to look up events, inspect trail configuration and logging status, or run CloudTrail Lake queries. Connect with a saved [AWS credential](/integrations/aws-credentials). Captured event types depend on configuration. Trails and event data stores log management events by default; data events, network activity events, and Insights events are captured only where you configure selectors for them. Read a trail's selectors before you treat its history as complete. @@ -60,7 +60,7 @@ CloudTrail Lake closed to new customers on May 31, 2026. Existing customers can ## Use the block [#usage-instructions] -Integrate AWS CloudTrail into workflows. Look up the last 90 days of management and Insights events by user, event name, resource, or access key; inspect trail configuration, logging status, and event selectors; and run SQL queries against CloudTrail Lake event data stores. This block never changes trail or event data store configuration, and never starts or stops logging. Starting and cancelling a Lake query are the only actions that are not reads, and AWS bills Lake queries on the data they scan. Requires AWS access key and secret access key. +Integrate AWS CloudTrail into workflows. Look up the last 90 days of management and Insights events by user, event name, resource, or access key; inspect trail configuration, logging status, and event selectors; and run SQL queries against CloudTrail Lake event data stores. This block never changes trail or event data store configuration, and never starts or stops logging. Starting and cancelling a Lake query are the only actions that are not reads, and AWS bills Lake queries on the data they scan. ## Actions @@ -75,8 +75,6 @@ Look up AWS CloudTrail management or Insights events from the last 90 days in a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `attributeKey` | string | No | Lookup attribute to filter on: AccessKeyId, EventId, EventName, EventSource, ReadOnly, ResourceName, ResourceType, or Username. Must be paired with attributeValue | | `attributeValue` | string | No | Value the lookup attribute must equal. Must be paired with attributeKey | | `startTime` | string | No | Only return events at or after this ISO 8601 timestamp | @@ -115,8 +113,6 @@ Retrieve the full configuration of one or more CloudTrail trails in the current | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `trailNameList` | string | No | Comma-separated trail names or ARNs. Leave empty to describe every trail in the Region. Trails in another Region must be given as ARNs | | `includeShadowTrails` | boolean | No | Include shadow trails \(replications of trails created in another Region, and organization trails in member accounts\). Defaults to true | @@ -155,8 +151,6 @@ Retrieve the settings of a single CloudTrail trail by name or ARN | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Trail name, or the trail ARN for a trail in another Region | #### Output @@ -193,8 +187,6 @@ Check whether a CloudTrail trail is logging and surface its most recent delivery | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Trail name, or the trail ARN. An organization trail read from a member account must be given as an ARN | #### Output @@ -226,8 +218,6 @@ List the ARN, name, and home Region of every CloudTrail trail visible to the acc | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `nextToken` | string | No | Pagination token from a previous list request | #### Output @@ -253,8 +243,6 @@ Read which management, data, and network activity events a CloudTrail trail is c | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `trailName` | string | Yes | Trail name or trail ARN | #### Output @@ -284,8 +272,6 @@ Read which CloudTrail Insights types are enabled on a trail or event data store | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `trailName` | string | No | Trail name or trail ARN. Cannot be combined with eventDataStore | | `eventDataStore` | string | No | Event data store ARN, or the ID suffix of that ARN. Cannot be combined with trailName | @@ -313,8 +299,6 @@ Start a CloudTrail Lake SQL query over an event data store | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryStatement` | string | No | SQL query to run, up to 10,000 characters. The event data store ID is named in the FROM clause. Supply this or queryAlias, not both | | `queryAlias` | string | No | Alias of a query template used by CloudTrail Lake dashboards. Supply this or queryStatement, not both | | `queryParameters` | string | No | Comma-separated parameter values for the query alias, up to 10 values | @@ -341,8 +325,6 @@ Check the status, run time, and scan statistics of a CloudTrail Lake query | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryId` | string | No | ID of the query returned by Start Query. Supply this or queryAlias, not both | | `queryAlias` | string | No | Query template alias; returns the last run for that alias. Supply this or queryId, not both | | `refreshId` | string | No | Dashboard refresh ID, used together with queryAlias | @@ -379,8 +361,6 @@ Fetch a page of result rows from a finished CloudTrail Lake query | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryId` | string | Yes | ID of the query returned by Start Query | | `maxQueryResults` | number | No | Maximum rows to return on a single page, 1 to 1000 | | `nextToken` | string | No | Pagination token from a previous results request | @@ -411,8 +391,6 @@ Cancel a running CloudTrail Lake query | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `queryId` | string | Yes | ID of the query returned by Start Query | | `eventDataStoreOwnerAccountId` | string | No | Account ID of the event data store owner, for a shared event data store | @@ -437,8 +415,6 @@ List the CloudTrail Lake event data stores in the account for the current Region | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum event data stores to return on a single page, 1 to 1000 | | `nextToken` | string | No | Pagination token from a previous list request | @@ -472,8 +448,6 @@ Retrieve the configuration of a single CloudTrail Lake event data store | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `eventDataStore` | string | Yes | Event data store ARN, or the ID suffix of that ARN | #### Output @@ -513,8 +487,6 @@ List the tags on CloudTrail trails, event data stores, dashboards, or channels | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `resourceIdList` | string | Yes | Comma-separated CloudTrail resource ARNs, up to 20 | | `nextToken` | string | No | Reserved for future use by AWS | diff --git a/apps/docs/content/docs/integrations/cloudwatch.mdx b/apps/docs/content/docs/integrations/cloudwatch.mdx index 380c6e46ef2..96f9907f869 100644 --- a/apps/docs/content/docs/integrations/cloudwatch.mdx +++ b/apps/docs/content/docs/integrations/cloudwatch.mdx @@ -2,7 +2,7 @@ title: CloudWatch description: Query and monitor AWS CloudWatch logs, metrics, and alarms integration: - type: "cloudwatch" + type: "cloudwatch_v2" color: "linear-gradient(45deg, #B0084D 0%, #FF4F8B 100%)" --- @@ -10,14 +10,14 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS CloudWatch](https://aws.amazon.com/cloudwatch/) to query logs, retrieve log events, inspect log groups and streams, read metrics and alarms, and publish custom metric data. Connect with an AWS access key ID and secret access key. +Use [AWS CloudWatch](https://aws.amazon.com/cloudwatch/) to query logs, retrieve log events, inspect log groups and streams, read metrics and alarms, and publish custom metric data. Connect with a saved [AWS credential](/integrations/aws-credentials). Choose **Query Logs (Insights)** for a query across log groups, or **Get Log Events** for one stream. Metric statistics use a time range and period; alarm actions report the current state. Pass results to later steps for incident investigation or threshold-based notifications. {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Run Log Insights queries, list log groups, retrieve log events, list and get metrics, and monitor alarms. Requires AWS access key and secret access key. +Run Log Insights queries, list log groups, retrieve log events, list and get metrics, and monitor alarms. ## Actions @@ -32,8 +32,6 @@ Run a CloudWatch Log Insights query against one or more log groups | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `logGroupNames` | array | Yes | Log group names to query | | `queryString` | string | Yes | CloudWatch Log Insights query string | | `startTime` | number | Yes | Start time as Unix epoch seconds | @@ -64,8 +62,6 @@ Search log events across all streams in a log group by filter pattern and time r | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `logGroupName` | string | Yes | CloudWatch log group name to search | | `filterPattern` | string | No | CloudWatch Logs filter pattern \(e.g., "ERROR", "?ERROR ?Exception"\). Matches all events if omitted. | | `logStreamNamePrefix` | string | No | Only search log streams whose name starts with this prefix | @@ -97,8 +93,6 @@ List available CloudWatch log groups | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `prefix` | string | No | Filter log groups by name prefix | | `limit` | number | No | Maximum number of log groups to return | @@ -126,8 +120,6 @@ Retrieve log events from a specific CloudWatch log stream | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `logGroupName` | string | Yes | CloudWatch log group name | | `logStreamName` | string | Yes | CloudWatch log stream name | | `startTime` | number | No | Start time as Unix epoch seconds | @@ -156,8 +148,6 @@ List log streams within a CloudWatch log group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `logGroupName` | string | Yes | CloudWatch log group name | | `prefix` | string | No | Filter log streams by name prefix | | `limit` | number | No | Maximum number of log streams to return | @@ -186,8 +176,6 @@ Set (or clear, for never-expire) the retention period for a CloudWatch log group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `logGroupName` | string | Yes | CloudWatch log group name | | `retentionInDays` | number | No | Days to retain log events \(one of 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, 3653\). Omit to make events never expire. | @@ -212,8 +200,6 @@ List available CloudWatch metrics | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `namespace` | string | No | Filter by namespace \(e.g., AWS/EC2, AWS/Lambda\) | | `metricName` | string | No | Filter by metric name | | `recentlyActive` | boolean | No | Only show metrics active in the last 3 hours | @@ -241,8 +227,6 @@ Get statistics for a CloudWatch metric over a time range | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `namespace` | string | Yes | Metric namespace \(e.g., AWS/EC2, AWS/Lambda\) | | `metricName` | string | Yes | Metric name \(e.g., CPUUtilization, Invocations\) | | `startTime` | number | Yes | Start time as Unix epoch seconds | @@ -278,8 +262,6 @@ Publish a custom metric data point to CloudWatch | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `namespace` | string | Yes | Metric namespace \(e.g., Custom/MyApp\) | | `metricName` | string | Yes | Name of the metric | | `value` | number | Yes | Metric value to publish | @@ -310,8 +292,6 @@ List and filter CloudWatch alarms | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `alarmNamePrefix` | string | No | Filter alarms by name prefix | | `stateValue` | string | No | Filter by alarm state \(OK, ALARM, INSUFFICIENT_DATA\) | | `alarmType` | string | No | Filter by alarm type \(MetricAlarm, CompositeAlarm\) | @@ -344,8 +324,6 @@ Retrieve state-change and configuration history for CloudWatch alarms | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `alarmName` | string | No | Name of a specific alarm to retrieve history for. Omit for all alarms. | | `historyItemType` | string | No | Filter by history item type \(ConfigurationUpdate, StateUpdate, Action, AlarmContributorStateUpdate, AlarmContributorAction\) | | `startDate` | number | No | Start of the history window as Unix epoch seconds | @@ -377,8 +355,6 @@ Create a CloudWatch alarm mute rule that suppresses alarms for a fixed duration | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `muteRuleName` | string | Yes | Unique name for the mute rule \(used later to unmute\) | | `alarmNames` | array | Yes | Names of the CloudWatch alarms this mute rule targets | | `durationValue` | number | Yes | How long the mute lasts \(paired with durationUnit\) | @@ -409,8 +385,6 @@ Delete a CloudWatch alarm mute rule, restoring alarm notifications | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `muteRuleName` | string | Yes | Name of the mute rule to delete | #### Output diff --git a/apps/docs/content/docs/integrations/codepipeline.mdx b/apps/docs/content/docs/integrations/codepipeline.mdx index ccb81d700f0..63e4bddc64d 100644 --- a/apps/docs/content/docs/integrations/codepipeline.mdx +++ b/apps/docs/content/docs/integrations/codepipeline.mdx @@ -2,7 +2,7 @@ title: CodePipeline description: Run, monitor, and approve AWS CodePipeline pipelines integration: - type: "codepipeline" + type: "codepipeline_v2" color: "linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)" --- @@ -10,12 +10,12 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS CodePipeline](https://aws.amazon.com/codepipeline/) to inspect release pipelines and execution history, start or stop runs, retry stages, and approve or reject manual approval actions. Stage transitions can be disabled or re-enabled to control pipeline flow. +Use [AWS CodePipeline](https://aws.amazon.com/codepipeline/) to inspect release pipelines and execution history, start or stop runs, retry stages, and approve or reject manual approval actions. Stage transitions can be disabled or re-enabled to control pipeline flow. Connect with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Start, stop, and monitor pipeline executions, retry failed stages, and approve or reject manual approval actions. Requires AWS access key and secret access key. +Start, stop, and monitor pipeline executions, retry failed stages, and approve or reject manual approval actions. ## Actions @@ -30,8 +30,6 @@ List all CodePipeline pipelines in an AWS account and region | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum number of pipelines to return \(1-1000\) | | `nextToken` | string | No | Pagination token from a previous call | @@ -61,8 +59,6 @@ Get the structure of a CodePipeline pipeline, including its stages, actions, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `version` | number | No | Pipeline version to retrieve \(defaults to the current version\) | @@ -101,8 +97,6 @@ Get the current state of a CodePipeline pipeline, including stage and action sta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | #### Output @@ -133,8 +127,6 @@ Get details of a CodePipeline execution, including status, trigger, source revis | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `pipelineExecutionId` | string | Yes | ID of the pipeline execution | @@ -174,8 +166,6 @@ List recent executions of a CodePipeline pipeline with status and source revisio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `maxResults` | number | No | Maximum number of executions to return \(1-100, default 100\) | | `nextToken` | string | No | Pagination token from a previous call | @@ -213,8 +203,6 @@ List action-level execution history for a CodePipeline pipeline, including per-a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `pipelineExecutionId` | string | No | Only return action executions for this pipeline execution | | `maxResults` | number | No | Maximum number of action executions to return \(1-100, default 100\) | @@ -254,8 +242,6 @@ Start a CodePipeline pipeline execution, optionally overriding pipeline variable | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline to start | | `clientRequestToken` | string | No | Idempotency token to identify a unique execution request | | `variables` | json | No | Pipeline variable overrides as an array of \{ name, value \} objects | @@ -279,8 +265,6 @@ Stop a CodePipeline pipeline execution, either finishing in-progress actions or | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `pipelineExecutionId` | string | Yes | ID of the pipeline execution to stop | | `abandon` | boolean | No | Abandon in-progress actions instead of letting them finish \(default false\) | @@ -305,8 +289,6 @@ Retry the failed actions (or all actions) of a failed CodePipeline stage | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `stageName` | string | Yes | Name of the failed stage to retry | | `pipelineExecutionId` | string | Yes | ID of the pipeline execution in the failed stage | @@ -331,8 +313,6 @@ Approve or reject a pending CodePipeline manual approval action. The approval to | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `stageName` | string | Yes | Name of the stage containing the approval action | | `actionName` | string | Yes | Name of the manual approval action | @@ -360,8 +340,6 @@ Prevent artifacts from transitioning into or out of a CodePipeline stage, freezi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `stageName` | string | Yes | Name of the stage to disable the transition for | | `transitionType` | string | Yes | Inbound to block artifacts entering the stage, Outbound to block artifacts leaving it | @@ -388,8 +366,6 @@ Re-enable artifacts transitioning into or out of a CodePipeline stage after it w | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `pipelineName` | string | Yes | Name of the pipeline | | `stageName` | string | Yes | Name of the stage to enable the transition for | | `transitionType` | string | Yes | Inbound to allow artifacts entering the stage, Outbound to allow artifacts leaving it | diff --git a/apps/docs/content/docs/integrations/crunchbase.mdx b/apps/docs/content/docs/integrations/crunchbase.mdx index d58c8ff64c7..b21451c8338 100644 --- a/apps/docs/content/docs/integrations/crunchbase.mdx +++ b/apps/docs/content/docs/integrations/crunchbase.mdx @@ -2,7 +2,7 @@ title: Crunchbase description: Search and look up companies, people, funding rounds, and acquisitions integration: - type: "crunchbase" + type: "crunchbase_v2" color: "#0287D1" --- @@ -39,7 +39,6 @@ Search Crunchbase companies, investors, and schools with filter predicates on fu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `query` | json | Yes | Filter predicates, combined with AND. Array of \{type:"predicate", field_id, operator_id, values\}. Operators: blank, eq, not_eq, gt, gte, lt, lte, starts, contains, not_contains, between, includes, not_includes, includes_all, not_includes_all, domain_eq, not_domain_eq, domain_blank, domain_includes, not_domain_includes. Max 25 predicates. Example: \[\{"type":"predicate","field_id":"categories","operator_id":"includes","values":\["biotechnology"\]\}\] | | `fieldIds` | json | No | Organization fields to return as columns, e.g. \["identifier","name","founded_on","categories"\]. Defaults to identifier, name, short_description, website_url, linkedin, location_identifiers, categories, founded_on, num_employees_enum, operating_status, rank_org, permalink. | | `order` | json | No | Sort clauses, e.g. \[\{"field_id":"rank_org","sort":"asc","nulls":"last"\}\]. Sort is "asc" or "desc". | @@ -67,7 +66,6 @@ Look up a single Crunchbase organization by permalink or UUID, returning the req | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `entityId` | string | Yes | Organization permalink \(e.g. "tesla-motors"\) or UUID | | `fieldIds` | json | No | Organization fields to return, e.g. \["identifier","name","founded_on","categories"\]. Defaults to identifier, name, short_description, website_url, linkedin, location_identifiers, categories, founded_on, num_employees_enum, operating_status, rank_org, permalink. | | `cardIds` | json | No | Related-entity cards to include, e.g. \["founders","headquarters_address"\]. Available on every license tier: child_organizations, child_ownerships, event_appearances, fields, founders, headquarters_address, parent_organization, parent_ownership. Richer packages add acquiree_acquisitions, acquirer_acquisitions, investors, ipos, jobs, participated_funding_rounds, participated_funds, participated_investments, press_references, raised_funding_rounds, raised_funds, raised_investments. A card returns at most 100 items. | @@ -94,7 +92,6 @@ Search Crunchbase people — founders, executives, and investors — with filter | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `query` | json | Yes | Filter predicates, combined with AND. Array of \{type:"predicate", field_id, operator_id, values\}. Operators: blank, eq, not_eq, gt, gte, lt, lte, starts, contains, not_contains, between, includes, not_includes, includes_all, not_includes_all, domain_eq, not_domain_eq, domain_blank, domain_includes, not_domain_includes. Max 25 predicates. Example: \[\{"type":"predicate","field_id":"primary_job_title","operator_id":"contains","values":\["Founder"\]\}\] | | `fieldIds` | json | No | Person fields to return as columns, e.g. \["identifier","name","primary_job_title","primary_organization"\]. Defaults to identifier, name, first_name, last_name, primary_job_title, primary_organization, short_description, location_identifiers, linkedin, rank_person, permalink. | | `order` | json | No | Sort clauses, e.g. \[\{"field_id":"rank_person","sort":"asc","nulls":"last"\}\]. Sort is "asc" or "desc". | @@ -122,7 +119,6 @@ Look up a single Crunchbase person by permalink or UUID, returning the requested | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `entityId` | string | Yes | Person permalink \(e.g. "elon-musk"\) or UUID | | `fieldIds` | json | No | Person fields to return, e.g. \["identifier","name","primary_job_title","primary_organization"\]. Defaults to identifier, name, first_name, last_name, primary_job_title, primary_organization, short_description, location_identifiers, linkedin, rank_person, permalink. | | `cardIds` | json | No | Related-entity cards to include, e.g. \["jobs","primary_organization"\]. Available on every license tier: degrees, event_appearances, fields, founded_organizations, jobs, primary_job, primary_organization. Advanced Financials adds participated_funding_rounds, participated_funds, participated_investments, partner_funding_rounds, partner_investments, press_references. A card returns at most 100 items. | @@ -149,7 +145,6 @@ Search Crunchbase funding rounds with filter predicates on announced date, inves | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `query` | json | Yes | Filter predicates, combined with AND. Array of \{type:"predicate", field_id, operator_id, values\}. Operators: blank, eq, not_eq, gt, gte, lt, lte, starts, contains, not_contains, between, includes, not_includes, includes_all, not_includes_all, domain_eq, not_domain_eq, domain_blank, domain_includes, not_domain_includes. Max 25 predicates. Example: \[\{"type":"predicate","field_id":"announced_on","operator_id":"gte","values":\["2026-01-01"\]\}\] | | `fieldIds` | json | No | Funding round fields to return as columns, e.g. \["identifier","announced_on","money_raised","investor_identifiers"\]. Defaults to identifier, announced_on, investment_type, investment_stage, money_raised, funded_organization_identifier, investor_identifiers, lead_investor_identifiers, num_investors, short_description, permalink. | | `order` | json | No | Sort clauses, e.g. \[\{"field_id":"announced_on","sort":"desc","nulls":"last"\}\]. Sort is "asc" or "desc". | @@ -177,7 +172,6 @@ Look up a single Crunchbase funding round by permalink or UUID, returning the re | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `entityId` | string | Yes | Funding round permalink \(e.g. "tesla-motors-series-c--12345678"\) or UUID | | `fieldIds` | json | No | Funding round fields to return, e.g. \["identifier","announced_on","money_raised","investor_identifiers"\]. Defaults to identifier, announced_on, investment_type, investment_stage, money_raised, funded_organization_identifier, investor_identifiers, lead_investor_identifiers, num_investors, short_description, permalink. | | `cardIds` | json | No | Related-entity cards to include, e.g. \["investors","organization"\]. Available: fields, investments, investors, lead_investors, organization, partners, press_references. A card returns at most 100 items. | @@ -204,7 +198,6 @@ Search Crunchbase acquisitions with filter predicates on announced date, price, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `query` | json | Yes | Filter predicates, combined with AND. Array of \{type:"predicate", field_id, operator_id, values\}. Operators: blank, eq, not_eq, gt, gte, lt, lte, starts, contains, not_contains, between, includes, not_includes, includes_all, not_includes_all, domain_eq, not_domain_eq, domain_blank, domain_includes, not_domain_includes. Max 25 predicates. Example: \[\{"type":"predicate","field_id":"announced_on","operator_id":"gte","values":\["2026-01-01"\]\}\] | | `fieldIds` | json | No | Acquisition fields to return as columns, e.g. \["identifier","acquiree_identifier","acquirer_identifier","price"\]. Defaults to identifier, acquiree_identifier, acquirer_identifier, announced_on, completed_on, price, acquisition_type, status, terms, short_description, permalink. | | `order` | json | No | Sort clauses, e.g. \[\{"field_id":"announced_on","sort":"desc","nulls":"last"\}\]. Sort is "asc" or "desc". | @@ -232,7 +225,6 @@ Look up a single Crunchbase acquisition by permalink or UUID, returning the requ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `entityId` | string | Yes | Acquisition permalink or UUID | | `fieldIds` | json | No | Acquisition fields to return, e.g. \["identifier","acquiree_identifier","acquirer_identifier","price"\]. Defaults to identifier, acquiree_identifier, acquirer_identifier, announced_on, completed_on, price, acquisition_type, status, terms, short_description, permalink. | | `cardIds` | json | No | Related-entity cards to include, e.g. \["acquiree_organization","acquirer_organization"\]. Available: acquiree_organization, acquirer_organization, fields, press_references. A card returns at most 100 items. | @@ -259,7 +251,6 @@ Search any Crunchbase collection — events, jobs, ipos, funds, investments, pre | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `collection` | string | Yes | Collection to search. One of: acquisition_predictions, acquisitions, addresses, awards, categories, category_groups, closure_predictions, current_valuation_estimates, degrees, diversity_spotlights, event_appearances, events, funding_predictions, funding_rounds, funds, growth_insights, growth_predictions, investments, investor_insights, investor_matches, ipo_predictions, ipos, jobs, key_employee_changes, layoff_predictions, layoffs, legal_proceedings, locations, market_insight_reasons, market_insights, micro_categories, org_similarities, organizations, ownerships, partnership_announcements, people, press_references, principals, product_launches, product_similarities, products, remain_private_predictions, research_insights. | | `query` | json | Yes | Filter predicates, combined with AND. Array of \{type:"predicate", field_id, operator_id, values\}. Operators: blank, eq, not_eq, gt, gte, lt, lte, starts, contains, not_contains, between, includes, not_includes, includes_all, not_includes_all, domain_eq, not_domain_eq, domain_blank, domain_includes, not_domain_includes. Max 25 predicates. | | `fieldIds` | json | Yes | Fields to return as columns for the chosen collection, e.g. \["identifier","short_description"\]. Required — the valid ids differ per collection; list them with the Get Fields Metadata operation. | @@ -288,7 +279,6 @@ Look up a single entity in any Crunchbase collection — events, jobs, ipos, fun | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `collection` | string | Yes | Collection the entity belongs to. One of: acquisition_predictions, acquisitions, addresses, awards, categories, category_groups, closure_predictions, current_valuation_estimates, degrees, diversity_spotlights, event_appearances, events, funding_predictions, funding_rounds, funds, growth_insights, growth_predictions, investments, investor_insights, investor_matches, ipo_predictions, ipos, jobs, key_employee_changes, layoff_predictions, layoffs, legal_proceedings, locations, market_insight_reasons, market_insights, micro_categories, org_similarities, organizations, ownerships, partnership_announcements, people, press_references, principals, product_launches, product_similarities, products, remain_private_predictions, research_insights. | | `entityId` | string | Yes | Entity permalink or UUID | | `fieldIds` | json | No | Fields to return for the chosen collection, e.g. \["identifier","short_description"\]. Leave empty to accept the default projection the API returns; list the valid ids with the Get Fields Metadata operation. | @@ -316,7 +306,6 @@ Page through one related-entity card of a Crunchbase entity — an investor's in | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `collection` | string | Yes | Collection the entity belongs to. One of: acquisitions, addresses, categories, category_groups, degrees, event_appearances, events, funding_rounds, funds, investments, ipos, jobs, market_insights, micro_categories, organizations, ownerships, people. | | `entityId` | string | Yes | Entity permalink or UUID | | `cardId` | string | Yes | Card to page through, e.g. "participated_investments" on a person, "founders" on an organization, or "investors" on a funding round. Valid ids differ per collection. | @@ -346,7 +335,6 @@ Suggest Crunchbase entities matching a typed query, returning the permalinks and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `query` | string | Yes | Text to autocomplete against, e.g. "airbnb" | | `collectionIds` | json | No | Collections to search, e.g. \["organizations","people"\]. One or more of: acquisition_predictions, acquisitions, addresses, awards, categories, category_groups, closure_predictions, current_valuation_estimates, degrees, diversity_spotlights, event_appearances, events, funding_predictions, funding_rounds, funds, growth_insights, growth_predictions, investments, investor_insights, investor_matches, ipo_predictions, ipos, jobs, key_employee_changes, layoff_predictions, layoffs, legal_proceedings, locations, market_insight_reasons, market_insights, micro_categories, org_similarities, organizations, ownerships, partnership_announcements, people, press_references, principals, product_launches, product_similarities, products, remain_private_predictions, research_insights. Which of them your key can read depends on your Crunchbase package. Defaults to every collection. | | `limit` | number | No | Suggestions to return, max 25 \(default 10\) | @@ -369,7 +357,6 @@ List entities Crunchbase has deleted, so a mirrored copy can be pruned in step w | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `collection` | string | No | Restrict the feed to a single collection: acquisitions, categories, event_appearances, events, funding_rounds, funds, investments, ipos, jobs, locations, organizations, ownerships, people, or press_references. Which of them your key can read depends on your Crunchbase package. Leave empty to read the feed across collections. | | `collectionIds` | json | No | Collections to include when reading the cross-collection feed, e.g. \["organizations","people"\]. One or more of: acquisitions, categories, event_appearances, events, funding_rounds, funds, investments, ipos, jobs, locations, organizations, ownerships, people, press_references. Ignored when a single collection is set. | | `deletedAtOrder` | string | No | Order by deletion time: "asc" \(default\) or "desc" | @@ -396,7 +383,6 @@ List the field ids, types, and descriptions each Crunchbase collection publishes | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Crunchbase API key, sent as the X-cb-user-key header | | `collectionIds` | json | No | Collections to describe, e.g. \["organizations","people"\]. One or more of: acquisition_predictions, acquisitions, addresses, awards, categories, category_groups, closure_predictions, current_valuation_estimates, degrees, diversity_spotlights, event_appearances, events, funding_predictions, funding_rounds, funds, growth_insights, growth_predictions, investments, investor_insights, investor_matches, ipo_predictions, ipos, jobs, key_employee_changes, layoff_predictions, layoffs, legal_proceedings, locations, market_insight_reasons, market_insights, micro_categories, org_similarities, organizations, ownerships, partnership_announcements, people, press_references, principals, product_launches, product_similarities, products, remain_private_predictions, research_insights. Which of them your key can read depends on your Crunchbase package. Defaults to every collection. | #### Output diff --git a/apps/docs/content/docs/integrations/cursor.mdx b/apps/docs/content/docs/integrations/cursor.mdx index e6855805da9..c50a8e37e64 100644 --- a/apps/docs/content/docs/integrations/cursor.mdx +++ b/apps/docs/content/docs/integrations/cursor.mdx @@ -2,7 +2,7 @@ title: Cursor description: Launch and manage Cursor cloud agents to work on GitHub repositories integration: - type: "cursor_v2" + type: "cursor_v3" color: "#1E1E1E" --- @@ -29,7 +29,6 @@ List all cloud agents for the authenticated user with optional pagination. Retur | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `limit` | number | No | Number of agents to return \(default: 20, max: 100\) | | `cursor` | string | No | Pagination cursor from previous response | | `prUrl` | string | No | Filter agents by pull request URL | @@ -53,7 +52,6 @@ Retrieve the current status and results of a cloud agent. Returns API-aligned fi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `agentId` | string | Yes | Unique identifier for the cloud agent \(e.g., bc_abc123\) | #### Output @@ -80,7 +78,6 @@ Retrieve the conversation history of a cloud agent, including all user prompts a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `agentId` | string | Yes | Unique identifier for the cloud agent \(e.g., bc_abc123\) | #### Output @@ -102,7 +99,6 @@ Start a new cloud agent to work on a GitHub repository with the given instructio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `repository` | string | Yes | GitHub repository URL \(e.g., https://github.com/your-org/your-repo) | | `ref` | string | No | Branch, tag, or commit to work from \(defaults to default branch\) | | `promptText` | string | Yes | The instruction text for the agent | @@ -132,7 +128,6 @@ Add a follow-up instruction to an existing cloud agent. Returns API-aligned fiel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `agentId` | string | Yes | Unique identifier for the cloud agent \(e.g., bc_abc123\) | | `followupPromptText` | string | Yes | The follow-up instruction text for the agent | | `promptImages` | string | No | JSON array of image objects with base64 data and dimensions \(max 5\) | @@ -155,7 +150,6 @@ Stop a running cloud agent. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `agentId` | string | Yes | Unique identifier for the cloud agent \(e.g., bc_abc123\) | #### Output @@ -176,7 +170,6 @@ Permanently delete a cloud agent. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `agentId` | string | Yes | Unique identifier for the cloud agent \(e.g., bc_abc123\) | #### Output @@ -197,7 +190,6 @@ List generated artifact files for a cloud agent. Returns API-aligned fields only | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `agentId` | string | Yes | Unique identifier for the cloud agent \(e.g., bc_abc123\) | #### Output @@ -220,7 +212,6 @@ Download a generated artifact file from a cloud agent. Returns the file for exec | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | | `agentId` | string | Yes | Unique identifier for the cloud agent \(e.g., bc_abc123\) | | `path` | string | Yes | Absolute path of the artifact to download \(e.g., /src/index.ts\) | @@ -242,7 +233,6 @@ List the models available for launching cloud agents. Returns API-aligned fields | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | #### Output @@ -262,7 +252,6 @@ List the GitHub repositories accessible to the authenticated user. Returns API-a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | #### Output @@ -285,7 +274,6 @@ Retrieve details about the API key currently in use. Returns API-aligned fields | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Cursor API key | #### Output diff --git a/apps/docs/content/docs/integrations/databricks-credentials.mdx b/apps/docs/content/docs/integrations/databricks-credentials.mdx new file mode 100644 index 00000000000..c6b7b318fe6 --- /dev/null +++ b/apps/docs/content/docs/integrations/databricks-credentials.mdx @@ -0,0 +1,43 @@ +--- +title: Databricks connections +description: Save a Databricks workspace connection with a personal access token, a service principal OAuth secret, or a keyless service principal that trusts Sim through OpenID Connect +--- + +import { Callout } from '@/components/ui/callout' +import { Step, Steps } from '@/components/ui/steps' + +A Databricks connection holds a workspace host and how Sim authenticates to it. The Databricks block signs in with a saved connection, so the host and secret live in one place instead of in each block. + + +Databricks blocks added before saved connections, which take a host and personal access token typed into the block, are marked legacy and keep working exactly as they are. Upgrade one by replacing it with the current block and selecting a connection. + + +## Choose how Sim signs in + +| Option | What Sim stores | When to use it | +| --- | --- | --- | +| **Service principal (keyless, via Sim OIDC)** | Nothing secret: the host and the service principal's application ID | Recommended. No secret to rotate or leak. | +| **Service principal OAuth secret** | The application ID and an OAuth secret | Machine-to-machine access where federation isn't set up. Sim exchanges the secret for a short-lived token on each run. | +| **Personal access token** | A personal access token | The same behavior as a token typed into the block, shared across blocks. | + +Every option resolves on Sim's servers at run time; tokens never appear in block outputs, logs, or anything a model sees. + +## Set up a keyless service principal [#keyless-service-principal] + + + + In Sim, add a **Databricks connection**, choose **Service principal (keyless, via Sim OIDC)**, and enter the workspace host and the service principal's **application ID**. + + + A Databricks account admin runs the **Federation policy** command from the dialog with the service principal's numeric ID. The policy trusts Sim's issuer, the Sim audience, and this connection's subject only. + + + Make sure the service principal can access the workspace and the resources your workflows use, then save. Sim verifies the connection by exchanging a token and reading the service principal's identity. + + + +Reconnecting a keyless connection keeps its subject by default, so the federation policy keeps working. + +## Self-hosted deployments + +Keyless connections need `WORKLOAD_IDENTITY_SIGNING_KEY` set and an issuer Databricks can reach over the public internet. See [AWS credentials](/integrations/aws-credentials#self-hosted-deployments) for the same settings. diff --git a/apps/docs/content/docs/integrations/databricks.mdx b/apps/docs/content/docs/integrations/databricks.mdx index 991e2f0b68e..568bdfb7642 100644 --- a/apps/docs/content/docs/integrations/databricks.mdx +++ b/apps/docs/content/docs/integrations/databricks.mdx @@ -2,7 +2,7 @@ title: Databricks description: Run SQL, manage jobs, and ask Genie agents on Databricks integration: - type: "databricks" + type: "databricks_v2" color: "#F9F7F4" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [Databricks](https://www.databricks.com/) to execute parameterized SQL, manage jobs and runs, control compute clusters and SQL warehouses, and work with Genie spaces. Connect with a personal access token and your Databricks workspace host URL. +Use [Databricks](https://www.databricks.com/) to execute parameterized SQL, manage jobs and runs, control compute clusters and SQL warehouses, and work with Genie spaces. Connect with a saved [Databricks connection](/integrations/databricks-credentials), which holds the workspace host and how Sim signs in. SQL operations return inline JSON rows, including SQL nulls. If a statement is still running, poll **Get Statement**. Follow `nextChunkIndex` with **Get Statement Chunk** to retrieve additional rows, or use **Cancel Statement** to stop execution. Configure `rowLimit` and `byteLimit` for predictable result sizes; external-link and Arrow/CSV downloads are outside these SQL operations. @@ -21,9 +21,11 @@ Cluster operations support creating, configuring, starting, restarting, resizing Genie operations create and update spaces, answer natural-language questions, manage conversation history, and retrieve generated SQL, results, and charts. Reuse the conversation ID for follow-ups. Use a space's `etag` when updating it to avoid overwriting concurrent changes. Agent mode supports research reports and response cancellation; it must be enabled in your workspace. {/* MANUAL-CONTENT-END */} +Connection guides: [Databricks connections](/integrations/databricks-credentials). + ## Use the block [#usage-instructions] -Execute parameterized SQL and retrieve result chunks, create and manage jobs, submit and repair runs, manage compute clusters and SQL warehouses, and create or update Genie spaces. Ask Genie questions or run agent research, inspect conversations, and retrieve query results and charts. Connect with a personal access token and workspace host URL. +Execute parameterized SQL and retrieve result chunks, create and manage jobs, submit and repair runs, manage compute clusters and SQL warehouses, and create or update Genie spaces. Ask Genie questions or run agent research, inspect conversations, and retrieve query results and charts. ## Actions @@ -37,8 +39,6 @@ Execute a SQL statement against a Databricks SQL warehouse and return results in | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | Yes | The ID of the SQL warehouse to execute against | | `statement` | string | Yes | The SQL statement to execute \(max 16 MiB\) | | `catalog` | string | No | Unity Catalog name \(equivalent to USE CATALOG\) | @@ -81,8 +81,6 @@ Poll a SQL statement by its ID to retrieve status and results. Use this after Ex | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | No | SQL warehouse identifier, when required by the statement endpoint | | `statementId` | string | Yes | The ID of the statement to fetch \(returned by Execute SQL\) | @@ -118,8 +116,6 @@ Retrieve one chunk of an INLINE SQL result using nextChunkIndex from Execute SQL | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `statementId` | string | Yes | SQL statement identifier | | `chunkIndex` | number | Yes | Zero-based result chunk index | | `warehouseId` | string | No | SQL warehouse identifier, when required by the statement endpoint | @@ -147,8 +143,6 @@ Request cancellation of an executing SQL statement; poll Get Statement to confir | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `statementId` | string | Yes | SQL statement identifier | | `warehouseId` | string | No | SQL warehouse identifier, when required by the statement endpoint | @@ -170,8 +164,6 @@ List all jobs in a Databricks workspace with optional filtering by name. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `limit` | number | No | Maximum number of jobs to return \(range 1-100, default 20\) | | `pageToken` | string | No | Token for the next or previous page; takes precedence over legacy offset | | `offset` | number | No | Legacy Jobs 2.1 offset; prefer pageToken | @@ -320,8 +312,6 @@ Get the full definition and settings of a single Databricks job by its job ID. | --------- | ---- | -------- | ----------- | | `includeTriggerState` | boolean | No | Include current job trigger state | | `pageToken` | string | No | Token for the next page of tasks and job clusters | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `jobId` | number | Yes | The canonical identifier of the job to retrieve | #### Output @@ -471,8 +461,6 @@ Create a Databricks job with tasks, scheduling, execution identity, and notifica | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `accessControlList` | json | No | Initial permissions as \[\{user_name, group_name, service_principal_name, permission_level\}\] | | `name` | string | No | Display name of the job | | `description` | string | No | Description of the job | @@ -522,8 +510,6 @@ Merge selected settings into a Databricks job and optionally remove settings or | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `jobId` | number | Yes | Job identifier | | `newSettings` | json | No | Job settings in Databricks API format; Update merges top-level fields and task keys, Reset replaces all settings | | `fieldsToRemove` | json | No | Settings to remove, such as \["schedule", "tasks/task_key"\] | @@ -546,8 +532,6 @@ Replace all settings of a Databricks job. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `jobId` | number | Yes | Job identifier | | `newSettings` | json | Yes | Job settings in Databricks API format; Update merges top-level fields and task keys, Reset replaces all settings | @@ -569,8 +553,6 @@ Delete a Databricks job and cancel its active runs. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `jobId` | number | Yes | Job identifier | #### Output @@ -595,8 +577,6 @@ Trigger an existing Databricks job to run immediately with optional job-level or | `queue` | json | No | Run queue settings as \{enabled: true\} or \{enabled: false\} | | `performanceTarget` | string | No | Serverless performance: STANDARD or PERFORMANCE_OPTIMIZED | | `pipelineParams` | json | No | Pipeline full_refresh and selective table or flow settings | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `jobId` | number | Yes | The ID of the job to trigger | | `jobParameters` | json | No | Job-level parameter overrides as a JSON object \(e.g., \{"key": "value"\}\) | | `notebookParams` | json | No | Notebook task parameters as a JSON object \(e.g., \{"param1": "value1"\}\) | @@ -621,8 +601,6 @@ Submit a one-time task run without creating a saved job. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `accessControlList` | json | No | Initial permissions as \[\{user_name, group_name, service_principal_name, permission_level\}\] | | `queue` | json | No | Queue behavior as \{enabled: true\} or \{enabled: false\} | | `runAs` | json | No | Execution identity as \{user_name\} or \{service_principal_name\} | @@ -658,8 +636,6 @@ List job runs in a Databricks workspace with optional filtering by job, status, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `jobId` | number | No | Filter runs by job ID. Omit to list runs across all jobs | | `activeOnly` | boolean | No | Only include active runs \(PENDING, RUNNING, or TERMINATING\) | | `completedOnly` | boolean | No | Only include completed runs | @@ -827,8 +803,6 @@ Get the status, timing, and details of a Databricks job run by its run ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `pageToken` | string | No | Token for the next page of tasks and job clusters | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `runId` | number | Yes | The canonical identifier of the run | | `includeHistory` | boolean | No | Include repair history in the response | | `includeResolvedValues` | boolean | No | Include resolved parameter values in the response | @@ -1004,8 +978,6 @@ Get the output of a completed Databricks job run, including notebook results, er | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `runId` | number | Yes | The run ID to get output for. For multi-task jobs, use the task run ID | #### Output @@ -1043,8 +1015,6 @@ Rerun failed or selected tasks within an existing Databricks run. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `runId` | number | Yes | Run identifier | | `latestRepairId` | number | No | Most recent repair ID; required after the first repair of a run | | `rerunTasks` | json | No | Task keys to repair; mutually exclusive with rerunAllFailedTasks | @@ -1072,8 +1042,6 @@ Cancel a running or pending Databricks job run. Cancellation is asynchronous; po | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `runId` | number | Yes | The canonical identifier of the run to cancel | #### Output @@ -1094,8 +1062,6 @@ Request cancellation of active runs of a job or queued runs in the workspace. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `jobId` | number | No | Job identifier; required unless allQueuedRuns is true | | `allQueuedRuns` | boolean | No | Cancel queued runs; without a job ID this applies to the workspace | @@ -1117,8 +1083,6 @@ Delete a completed Databricks job run. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `runId` | number | Yes | Run identifier | #### Output @@ -1141,8 +1105,6 @@ List a page of clusters in a Databricks workspace including their state, configu | --------- | ---- | -------- | ----------- | | `pageSize` | number | No | Resources per page \(default 20\) | | `pageToken` | string | No | Token returned by the previous list request | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | #### Output @@ -1185,8 +1147,6 @@ Get the state, configuration, and resource details of a single Databricks cluste | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `clusterId` | string | Yes | The ID of the cluster to retrieve | #### Output @@ -1228,8 +1188,6 @@ Create a compute cluster with runtime, sizing, policy, and cloud-specific settin | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `applyPolicyDefaultValues` | boolean | No | Fill unspecified settings from the compute policy defaults | | `cloneFrom` | json | No | Clone source as \{source_cluster_id, clone_source\} | | `numWorkers` | number | No | Fixed worker count; use this or autoscale | @@ -1285,8 +1243,6 @@ Replace a compute cluster configuration; a running cluster restarts to apply the | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `clusterId` | string | Yes | Compute cluster identifier | | `applyPolicyDefaultValues` | boolean | No | Fill unspecified settings from the compute policy defaults | | `numWorkers` | number | No | Fixed worker count; use this or autoscale | @@ -1342,8 +1298,6 @@ Start a terminated all-purpose compute cluster. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `clusterId` | string | Yes | Compute cluster identifier | #### Output @@ -1364,8 +1318,6 @@ Restart a running compute cluster. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `clusterId` | string | Yes | Compute cluster identifier | | `restartUser` | string | No | User requesting the cluster restart | @@ -1387,8 +1339,6 @@ Change the fixed worker count or autoscaling range of a running cluster. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `clusterId` | string | Yes | Compute cluster identifier | | `numWorkers` | number | No | Fixed worker count; use this or autoscale | | `autoscale` | json | No | Worker range as \{min_workers, max_workers\}; use this or numWorkers | @@ -1411,8 +1361,6 @@ Terminate a compute cluster while retaining its configuration for a later restar | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `clusterId` | string | Yes | Compute cluster identifier | #### Output @@ -1433,8 +1381,6 @@ Permanently delete a compute cluster and its configuration. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `clusterId` | string | Yes | Compute cluster identifier | #### Output @@ -1457,8 +1403,6 @@ List a page of SQL warehouses in a Databricks workspace including their size, st | --------- | ---- | -------- | ----------- | | `pageSize` | number | No | Resources per page \(default 20\) | | `pageToken` | string | No | Token returned by the previous list request | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | #### Output @@ -1512,8 +1456,6 @@ Get the configuration, state, and scaling settings of a SQL warehouse. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | Yes | SQL warehouse identifier | #### Output @@ -1567,8 +1509,6 @@ Create a SQL warehouse with sizing, autoscaling, and serverless settings. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `name` | string | No | Display name of the SQL warehouse | | `clusterSize` | string | No | SQL warehouse size, such as Small or Medium | | `minNumClusters` | number | No | Minimum number of SQL warehouse clusters | @@ -1601,8 +1541,6 @@ Update a SQL warehouse configuration. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | Yes | SQL warehouse identifier | | `name` | string | No | Display name of the SQL warehouse | | `clusterSize` | string | No | SQL warehouse size, such as Small or Medium | @@ -1636,8 +1574,6 @@ Start a stopped SQL warehouse. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | Yes | SQL warehouse identifier | #### Output @@ -1658,8 +1594,6 @@ Stop a running SQL warehouse. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | Yes | SQL warehouse identifier | #### Output @@ -1680,8 +1614,6 @@ Delete a SQL warehouse. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | Yes | SQL warehouse identifier | #### Output @@ -1702,8 +1634,6 @@ List the Genie spaces (Genie agents) you can access. Use this to find the space | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `pageSize` | number | No | Maximum number of spaces to return per page \(default 20, max 100\) | | `pageToken` | string | No | Pagination token from a previous response | @@ -1734,8 +1664,6 @@ Get a Genie space's title, description, and SQL warehouse, optionally with its f | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `includeSerializedSpace` | boolean | No | Include the space's serialized configuration export \(requires CAN EDIT on the space\) | @@ -1765,8 +1693,6 @@ Create a Genie space from its serialized configuration and a SQL warehouse. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `warehouseId` | string | Yes | SQL warehouse identifier | | `parentPath` | string | No | Parent workspace folder for the Genie space | | `serializedSpace` | string | Yes | Serialized Genie configuration JSON, including data_sources, instructions, config, and benchmarks; get an example with Get Genie Space | @@ -1799,8 +1725,6 @@ Update a Genie space, optionally protecting the change with its current ETag. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | Genie space identifier | | `serializedSpace` | string | No | Serialized Genie configuration JSON, including data_sources, instructions, config, and benchmarks; get an example with Get Genie Space | | `title` | string | No | Genie space title | @@ -1835,8 +1759,6 @@ Move a Genie space to the trash. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | Genie space identifier | #### Output @@ -1857,8 +1779,6 @@ Ask a Databricks Genie space a question in natural language and wait for the ans | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `content` | string | Yes | The question to ask Genie | | `conversationId` | string | No | Continue this conversation so Genie uses its earlier messages as context. Omit to start a new conversation. | @@ -1916,8 +1836,6 @@ Get a Genie message's status and answer, including the generated SQL, visualizat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation | | `messageId` | string | Yes | The ID of the Genie message | @@ -1962,8 +1880,6 @@ List the messages in a Genie conversation with their answers and generated SQL, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation | | `pageSize` | number | No | Maximum number of messages to return per page \(default 20, max 100\) | @@ -2011,8 +1927,6 @@ Get the rows returned by the SQL query Genie generated for a message. Available | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation | | `messageId` | string | Yes | The ID of the Genie message | @@ -2050,8 +1964,6 @@ Re-run the SQL query Genie generated for a message. Use this when the message's | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation | | `messageId` | string | Yes | The ID of the Genie message | @@ -2089,8 +2001,6 @@ Download a chart Genie generated as a PNG image, for example to post it to Slack | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation | | `messageId` | string | Yes | The ID of the Genie message | @@ -2114,8 +2024,6 @@ Rate a Genie answer as positive or negative, with an optional comment. Space aut | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation | | `messageId` | string | Yes | The ID of the Genie message | @@ -2140,8 +2048,6 @@ Delete a message from a Genie conversation. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation | | `messageId` | string | Yes | The ID of the Genie message | @@ -2164,8 +2070,6 @@ List conversations in a Genie space, including whether each is a chat-mode or ag | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `includeAll` | boolean | No | Include every user's conversations in the space \(requires CAN MANAGE on the space\) | | `pageSize` | number | No | Maximum number of conversations to return per page \(default 20, max 100\) | @@ -2194,8 +2098,6 @@ Delete a Genie conversation you no longer need. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | The ID of the Genie conversation to delete | @@ -2217,8 +2119,6 @@ Ask a Genie agent a question in agent mode, where Genie plans multi-step researc | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space \(the Genie agent ID\) | | `content` | string | Yes | The question to ask the Genie agent | | `conversationId` | string | No | Continue this agent-mode conversation. Omit to start a new conversation. | @@ -2261,8 +2161,6 @@ List an agent-mode conversation's full history in order: questions, reasoning, S | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space \(the Genie agent ID\) | | `conversationId` | string | Yes | The ID of the agent-mode conversation | | `limit` | number | No | Maximum number of items to return \(1-100, default 100\) | @@ -2300,8 +2198,6 @@ Cancel an in-flight Genie agent response using the response ID returned by the a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `host` | string | Yes | Databricks workspace host \(e.g., dbc-abc123.cloud.databricks.com\) | -| `apiKey` | string | Yes | Databricks Personal Access Token | | `spaceId` | string | Yes | The ID of the Genie space | | `conversationId` | string | Yes | Agent conversation identifier | | `responseId` | string | Yes | Response ID from the response.created stream event | diff --git a/apps/docs/content/docs/integrations/daytona.mdx b/apps/docs/content/docs/integrations/daytona.mdx index 9026dc20019..bae9100557a 100644 --- a/apps/docs/content/docs/integrations/daytona.mdx +++ b/apps/docs/content/docs/integrations/daytona.mdx @@ -2,7 +2,7 @@ title: Daytona description: Run code and commands in secure cloud sandboxes integration: - type: "daytona" + type: "daytona_v2" color: "#FFFFFF" --- @@ -29,7 +29,6 @@ Create a new Daytona sandbox for running AI-generated code in isolation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `snapshot` | string | No | ID or name of the snapshot to create the sandbox from \(uses default if empty\) | | `name` | string | No | Name for the sandbox \(defaults to the sandbox ID\) | | `target` | string | No | Region where the sandbox will be created \(e.g., us, eu\) | @@ -62,7 +61,6 @@ List Daytona sandboxes in the organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `limit` | number | No | Maximum number of sandboxes to return \(1-200\) | | `name` | string | No | Filter sandboxes by name prefix \(case-insensitive\) | | `labels` | json | No | Filter sandboxes by labels as key-value pairs | @@ -87,7 +85,6 @@ Get details of a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID or name of the sandbox | #### Output @@ -108,7 +105,6 @@ Start a stopped Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID or name of the sandbox | #### Output @@ -129,7 +125,6 @@ Stop a running Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID or name of the sandbox | #### Output @@ -150,7 +145,6 @@ Delete a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID or name of the sandbox | #### Output @@ -171,7 +165,6 @@ Execute a shell command inside a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID of the sandbox to execute the command in | | `command` | string | Yes | Shell command to execute | | `cwd` | string | No | Working directory for the command \(defaults to the sandbox working directory\) | @@ -197,7 +190,6 @@ Run Python, JavaScript, or TypeScript code inside a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID of the sandbox to run the code in | | `code` | string | Yes | Code to run | | `language` | string | Yes | Language of the code: python, javascript, or typescript | @@ -224,7 +216,6 @@ Upload a file to a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID of the sandbox to upload the file to | | `destinationPath` | string | Yes | Destination path in the sandbox \(a trailing slash uploads into that directory using the file name\) | | `file` | file | No | The file to upload | @@ -250,7 +241,6 @@ Download a file from a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID of the sandbox to download the file from | | `filePath` | string | Yes | Path of the file in the sandbox | @@ -275,7 +265,6 @@ List files in a directory of a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID of the sandbox to list files in | | `path` | string | No | Directory path to list \(defaults to the sandbox working directory\) | @@ -305,7 +294,6 @@ Clone a Git repository into a Daytona sandbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Daytona API key | | `sandboxId` | string | Yes | ID of the sandbox to clone the repository into | | `url` | string | Yes | URL of the Git repository to clone | | `path` | string | Yes | Path in the sandbox to clone the repository into | diff --git a/apps/docs/content/docs/integrations/discord.mdx b/apps/docs/content/docs/integrations/discord.mdx index d236151b2e4..d63441d0f7a 100644 --- a/apps/docs/content/docs/integrations/discord.mdx +++ b/apps/docs/content/docs/integrations/discord.mdx @@ -2,7 +2,7 @@ title: Discord description: Interact with Discord integration: - type: "discord" + type: "discord_v2" color: "#5865F2" --- @@ -38,7 +38,6 @@ Send a message to a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to send the message to, e.g., 123456789012345678 | | `content` | string | No | The text content of the message | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -79,7 +78,6 @@ Retrieve messages from a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to retrieve messages from, e.g., 123456789012345678 | | `limit` | number | No | Maximum number of messages to retrieve \(default: 10, max: 100\) | @@ -119,7 +117,6 @@ Retrieve information about a Discord server (guild) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -149,7 +146,6 @@ Retrieve information about a Discord user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | Discord bot token for authentication | | `userId` | string | Yes | The Discord user ID, e.g., 123456789012345678 | #### Output @@ -179,7 +175,6 @@ Edit an existing message in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to edit, e.g., 123456789012345678 | | `content` | string | No | The new text content for the message | @@ -208,7 +203,6 @@ Delete a message from a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to delete, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -231,7 +225,6 @@ Delete 2-100 messages from a Discord channel in a single request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to delete messages from, e.g., 123456789012345678 | | `messageIds` | json | Yes | Array of 2-100 message IDs to delete. Messages older than 2 weeks cannot be bulk deleted. | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -254,7 +247,6 @@ Add a reaction emoji to a Discord message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to react to, e.g., 123456789012345678 | | `emoji` | string | Yes | The emoji to react with \(unicode emoji or custom emoji in name:id format\) | @@ -278,7 +270,6 @@ Remove a reaction from a Discord message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message with the reaction, e.g., 123456789012345678 | | `emoji` | string | Yes | The emoji to remove \(unicode emoji or custom emoji in name:id format\) | @@ -303,7 +294,6 @@ Pin a message in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to pin, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -326,7 +316,6 @@ Unpin a message in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to unpin, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -349,7 +338,6 @@ Retrieve all pinned messages in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to retrieve pinned messages from, e.g., 123456789012345678 | | `limit` | number | No | Maximum number of pins to return per page \(1-50\). Defaults to 50. | | `before` | string | No | Return pins created before this ISO8601 timestamp, for paging past the first 50 results | @@ -382,7 +370,6 @@ Create a thread in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to create the thread in, e.g., 123456789012345678 | | `name` | string | Yes | The name of the thread \(1-100 characters\) | | `messageId` | string | No | The message ID to create a thread from \(if creating from existing message\), e.g., 123456789012345678 | @@ -414,7 +401,6 @@ Join a thread in Discord | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `threadId` | string | Yes | The thread ID to join, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -436,7 +422,6 @@ Leave a thread in Discord | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `threadId` | string | Yes | The thread ID to leave, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -458,7 +443,6 @@ Archive or unarchive a thread in Discord | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `threadId` | string | Yes | The thread ID to archive/unarchive, e.g., 123456789012345678 | | `archived` | boolean | Yes | Whether to archive \(true\) or unarchive \(false\) the thread | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -484,7 +468,6 @@ Create a new channel in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `name` | string | Yes | The name of the channel \(1-100 characters\) | | `type` | number | No | Channel type \(0=text, 2=voice, 4=category, 5=announcement, 13=stage\) | @@ -514,7 +497,6 @@ Update a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to update, e.g., 123456789012345678 | | `name` | string | No | The new name for the channel | | `topic` | string | No | The new topic for the channel | @@ -543,7 +525,6 @@ Delete a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to delete, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -570,7 +551,6 @@ Get information about a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to retrieve, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -598,7 +578,6 @@ List all channels in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -626,7 +605,6 @@ Create a new role in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `name` | string | Yes | The name of the role | | `color` | number | No | RGB color value as integer \(e.g., 0xFF0000 for red\) | @@ -657,7 +635,6 @@ Update a role in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to update, e.g., 123456789012345678 | | `name` | string | No | The new name for the role | @@ -687,7 +664,6 @@ Delete a role from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to delete, e.g., 123456789012345678 | @@ -709,7 +685,6 @@ Assign a role to a member in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to assign the role to, e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to assign, e.g., 123456789012345678 | @@ -732,7 +707,6 @@ Remove a role from a member in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to remove the role from, e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to remove, e.g., 123456789012345678 | @@ -755,7 +729,6 @@ List all roles in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -783,7 +756,6 @@ Kick a member from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to kick, e.g., 123456789012345678 | | `reason` | string | No | Reason for kicking the member | @@ -806,7 +778,6 @@ Ban a member from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to ban, e.g., 123456789012345678 | | `reason` | string | No | Reason for banning the member | @@ -830,7 +801,6 @@ Unban a member from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to unban, e.g., 123456789012345678 | | `reason` | string | No | Reason for unbanning the member | @@ -853,7 +823,6 @@ Get information about a member in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to retrieve, e.g., 123456789012345678 | @@ -883,7 +852,6 @@ Update a member in a Discord server (e.g., change nickname) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to update, e.g., 123456789012345678 | | `nick` | string | No | New nickname for the member \(null to remove\) | @@ -912,7 +880,6 @@ Create an invite link for a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to create an invite for, e.g., 123456789012345678 | | `maxAge` | number | No | Duration of invite in seconds \(0 = never expires, default 86400\) | | `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) | @@ -943,7 +910,6 @@ Get information about a Discord invite | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `inviteCode` | string | Yes | The invite code to retrieve | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -971,7 +937,6 @@ Delete a Discord invite | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `inviteCode` | string | Yes | The invite code to delete | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -993,7 +958,6 @@ Create a webhook in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `channelId` | string | Yes | The Discord channel ID to create the webhook in, e.g., 123456789012345678 | | `name` | string | Yes | Name of the webhook \(1-80 characters\) | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -1051,7 +1015,6 @@ Get information about a Discord webhook | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `webhookId` | string | Yes | The webhook ID to retrieve, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | @@ -1079,7 +1042,6 @@ Delete a Discord webhook | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `botToken` | string | Yes | The bot token for authentication | | `webhookId` | string | Yes | The webhook ID to delete, e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | diff --git a/apps/docs/content/docs/integrations/dub.mdx b/apps/docs/content/docs/integrations/dub.mdx index d4faacd9040..e519ef39f57 100644 --- a/apps/docs/content/docs/integrations/dub.mdx +++ b/apps/docs/content/docs/integrations/dub.mdx @@ -2,7 +2,7 @@ title: Dub description: Link management with Dub integration: - type: "dub_v2" + type: "dub_v3" color: "#181C1E" --- @@ -31,7 +31,6 @@ Create a new short link with Dub. Supports custom domains, slugs, UTM parameters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `url` | string | Yes | The destination URL of the short link | | `domain` | string | No | Custom domain for the short link \(defaults to dub.sh\) | | `key` | string | No | Custom slug for the short link \(randomly generated if not provided\) | @@ -97,7 +96,6 @@ Create or update a short link by its URL. If a link with the same URL already ex | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `url` | string | Yes | The destination URL of the short link | | `domain` | string | No | Custom domain for the short link \(defaults to dub.sh\) | | `key` | string | No | Custom slug for the short link \(randomly generated if not provided\) | @@ -163,7 +161,6 @@ Retrieve information about a short link by its link ID, external ID, or domain + | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `linkId` | string | No | The unique ID of the short link | | `externalId` | string | No | The external ID of the link in your database | | `domain` | string | No | The domain of the link \(use with key\) | @@ -213,7 +210,6 @@ Update an existing short link's destination URL, domain, slug, link-preview titl | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `linkId` | string | Yes | The link ID or external ID prefixed with ext_ | | `url` | string | No | New destination URL | | `domain` | string | No | New custom domain | @@ -280,7 +276,6 @@ Delete a short link by its link ID or external ID (prefixed with ext_). | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `linkId` | string | Yes | The link ID or external ID prefixed with ext_ | #### Output @@ -301,7 +296,6 @@ Retrieve a paginated list of short links for the authenticated workspace. Suppor | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `domain` | string | No | Filter by domain | | `search` | string | No | Search query matched against the short link slug and destination URL | | `tagIds` | string | No | Comma-separated tag IDs to filter by | @@ -332,7 +326,6 @@ Retrieve the number of short links for the authenticated workspace, optionally f | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `domain` | string | No | Filter by domain | | `search` | string | No | Search query matched against the short link slug and destination URL | | `tagIds` | string | No | Comma-separated tag IDs to filter by | @@ -360,7 +353,6 @@ Create up to 100 short links in a single request. Returns the created links alon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `links` | json | Yes | JSON array of link objects to create. Each object requires a "url" and may include domain, key, tagIds, and other link fields \(max 100\). | #### Output @@ -383,7 +375,6 @@ Apply the same set of field updates to up to 100 links at once, selected by link | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `linkIds` | string | No | Comma-separated link IDs to update \(max 100, takes precedence over externalIds\) | | `externalIds` | string | No | Comma-separated external IDs to update \(max 100\) | | `data` | json | Yes | JSON object of fields to apply to every selected link \(e.g. \{ "archived": true, "tagIds": \["..."\] \}\) | @@ -407,7 +398,6 @@ Delete up to 100 short links in a single request by their link IDs. Non-existing | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `linkIds` | string | Yes | Comma-separated link IDs to delete \(max 100\) | #### Output @@ -428,7 +418,6 @@ Retrieve analytics for links including clicks, leads, and sales. Supports filter | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `event` | string | No | Event type: clicks \(default\), leads, sales, or composite | | `groupBy` | string | No | Group results by: count \(default\), timeseries, countries, cities, devices, browsers, os, referers, top_links, top_urls | | `linkId` | string | No | Filter by link ID | @@ -462,7 +451,6 @@ Retrieve a paginated stream of individual click, lead, and sale events for links | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `event` | string | No | Event type: clicks \(default\), leads, or sales | | `linkId` | string | No | Filter by link ID | | `externalId` | string | No | Filter by external ID \(prefix with ext_\) | @@ -495,7 +483,6 @@ Generate a customizable QR code (PNG) for a short link, with control over size, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `url` | string | Yes | The short link URL to encode in the QR code | | `logo` | string | No | URL of a custom logo to embed in the QR code \(requires a paid Dub plan\) | | `size` | number | No | QR code size in pixels \(default: 600\) | @@ -523,7 +510,6 @@ Retrieve the custom domains registered in the workspace, so links can be created | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `archived` | boolean | No | Whether to include archived domains \(defaults to false\) | | `search` | string | No | Search by domain name | | `page` | number | No | Page number \(default: 1\) | @@ -548,7 +534,6 @@ Retrieve the tags defined in the workspace, so the right tag IDs can be assigned | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `search` | string | No | Search by tag name | | `sortBy` | string | No | Field to sort by: name \(default\) or createdAt | | `sortOrder` | string | No | Sort order: asc \(default\) or desc | @@ -574,7 +559,6 @@ Create a new tag in the workspace for organizing and filtering short links. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `name` | string | Yes | The name of the tag to create \(1-50 characters\) | | `color` | string | No | Tag color: red, yellow, green, blue, purple, brown, gray, or pink \(random if omitted\) | @@ -598,7 +582,6 @@ Retrieve the folders defined in the workspace, so the right folder ID can be use | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Dub API key | | `search` | string | No | Search by folder name | | `page` | number | No | Page number \(default: 1\) | | `pageSize` | number | No | Number of folders per page \(default: 50, max: 50\) | diff --git a/apps/docs/content/docs/integrations/dynamodb.mdx b/apps/docs/content/docs/integrations/dynamodb.mdx index 443df5f95bd..0aaae67b69a 100644 --- a/apps/docs/content/docs/integrations/dynamodb.mdx +++ b/apps/docs/content/docs/integrations/dynamodb.mdx @@ -2,7 +2,7 @@ title: Amazon DynamoDB description: Get, put, query, scan, update, and delete items in Amazon DynamoDB tables integration: - type: "dynamodb" + type: "dynamodb_v2" color: "linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -[Amazon DynamoDB](https://aws.amazon.com/dynamodb/) stores items in tables identified by primary keys. Use Get to read an item, Put to insert or replace one, Update to change attributes, and Delete to remove it. Query a table or index by key conditions; use Scan when you need to inspect items across the table. The integration also reads table metadata and uses AWS access-key credentials. +[Amazon DynamoDB](https://aws.amazon.com/dynamodb/) stores items in tables identified by primary keys. Use Get to read an item, Put to insert or replace one, Update to change attributes, and Delete to remove it. Query a table or index by key conditions; use Scan when you need to inspect items across the table. The integration also reads table metadata and signs in with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] @@ -30,8 +30,6 @@ Get an item from a DynamoDB table by primary key | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `key` | json | Yes | Primary key of the item to retrieve \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | | `consistentRead` | boolean | No | Use strongly consistent read | @@ -56,8 +54,6 @@ Put an item into a DynamoDB table | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `item` | json | Yes | Item to put into the table \(e.g., \{"pk": "USER#123", "name": "John", "email": "john@example.com"\}\) | | `conditionExpression` | string | No | Condition that must be met for the put to succeed \(e.g., "attribute_not_exists\(pk\)" to prevent overwrites\) | @@ -84,8 +80,6 @@ Query items from a DynamoDB table using key conditions | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk" or "pk = :pk AND sk BEGINS_WITH :prefix"\) | | `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) | @@ -118,8 +112,6 @@ Scan all items in a DynamoDB table | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) | | `projectionExpression` | string | No | Attributes to retrieve \(e.g., "pk, sk, #name, email"\) | @@ -150,8 +142,6 @@ Update an item in a DynamoDB table | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `key` | json | Yes | Primary key of the item to update \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | | `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name, age = :age" or "SET #count = #count + :inc"\) | @@ -179,8 +169,6 @@ Delete an item from a DynamoDB table | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `key` | json | Yes | Primary key of the item to delete \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | | `conditionExpression` | string | No | Condition that must be met for the delete to succeed \(e.g., "attribute_exists\(pk\)"\) | @@ -206,8 +194,6 @@ Introspect DynamoDB to list tables or get detailed schema information for a spec | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `tableName` | string | No | Optional table name to get detailed schema \(e.g., "Users", "Orders"\). If not provided, lists all tables. | #### Output diff --git a/apps/docs/content/docs/integrations/ec2.mdx b/apps/docs/content/docs/integrations/ec2.mdx index d41a80954c8..1065a8b4368 100644 --- a/apps/docs/content/docs/integrations/ec2.mdx +++ b/apps/docs/content/docs/integrations/ec2.mdx @@ -2,7 +2,7 @@ title: Amazon EC2 description: Manage EC2 instances, Elastic IPs, VPC networking, and EBS integration: - type: "ec2" + type: "ec2_v2" color: "linear-gradient(45deg, #C8511B 0%, #FF9900 100%)" --- @@ -24,7 +24,7 @@ With the Amazon EC2 block, you can: ## Credentials and permissions -The block authenticates with an AWS access key ID and secret access key and runs in the region you set. Grant the IAM principal only the EC2 actions the operations you use require. Each operation maps to the IAM action of the same name, for example `ec2:DescribeAddresses`, `ec2:DescribeNatGateways`, and `ec2:DescribeRouteTables` for a read-only egress audit, or `ec2:StopInstances` and `ec2:StartInstances` for scheduling. +The block signs in with a saved [AWS credential](/integrations/aws-credentials) and runs in the region you set. Grant the IAM principal only the EC2 actions the operations you use require. Each operation maps to the IAM action of the same name, for example `ec2:DescribeAddresses`, `ec2:DescribeNatGateways`, and `ec2:DescribeRouteTables` for a read-only egress audit, or `ec2:StopInstances` and `ec2:StartInstances` for scheduling. List operations accept EC2 filters such as `[{"Name": "vpc-id", "Values": ["vpc-0abc123"]}]`. Without IDs they return up to 100 results per page, with a `nextToken` for the next page. @@ -33,7 +33,7 @@ In Sim, the Amazon EC2 block lets your agents map which public IPs your subnets ## Use the block [#usage-instructions] -Integrate Amazon EC2 into workflows. Describe and control instances, manage Elastic IP addresses, inspect VPCs, subnets, route tables, NAT and internet gateways, security groups, and network interfaces, add and revoke security group ingress rules, inspect network ACLs, VPC endpoints, and peering connections, work with EBS volumes and snapshots, list AMIs and key pairs, and tag resources. Requires an AWS access key with the matching ec2:* IAM permissions. +Integrate Amazon EC2 into workflows. Describe and control instances, manage Elastic IP addresses, inspect VPCs, subnets, route tables, NAT and internet gateways, security groups, and network interfaces, add and revoke security group ingress rules, inspect network ACLs, VPC endpoints, and peering connections, work with EBS volumes and snapshots, list AMIs and key pairs, and tag resources. The AWS credential’s identity needs the matching ec2:* IAM permissions. ## Actions @@ -48,8 +48,6 @@ List EC2 instances with their state, type, networking, and tags | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `instanceIds` | string | No | Comma-separated instance IDs \(e.g., i-0abc123,i-0def456\). Leave empty to list all | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"instance-state-name","Values":\["running"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -96,8 +94,6 @@ Get status checks and scheduled events for EC2 instances | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `instanceIds` | string | No | Comma-separated instance IDs \(max 100\). Leave empty to describe all | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"instance-status.status","Values":\["impaired"\]\}\] | | `includeAllInstances` | boolean | No | Include instances that are not running \(by default only running instances are returned\) | @@ -135,8 +131,6 @@ Start one or more stopped EC2 instances | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `instanceIds` | string | Yes | Comma-separated instance IDs to start | #### Output @@ -161,8 +155,6 @@ Stop one or more running EC2 instances | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `instanceIds` | string | Yes | Comma-separated instance IDs to stop | | `hibernate` | boolean | No | Hibernate the instances instead of stopping them \(hibernation must be enabled on the instance\) | | `force` | boolean | No | Force the instances to stop without flushing file system caches | @@ -189,8 +181,6 @@ Request a reboot of one or more EC2 instances | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `instanceIds` | string | Yes | Comma-separated instance IDs to reboot | #### Output @@ -213,8 +203,6 @@ Permanently terminate one or more EC2 instances | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `instanceIds` | string | Yes | Comma-separated instance IDs to terminate | #### Output @@ -239,8 +227,6 @@ List Elastic IP addresses and what they are associated with | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `publicIps` | string | No | Comma-separated Elastic IP addresses to describe | | `allocationIds` | string | No | Comma-separated allocation IDs \(e.g., eipalloc-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"domain","Values":\["vpc"\]\}\] | @@ -276,8 +262,6 @@ Allocate a new Elastic IP address for use in a VPC | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `networkBorderGroup` | string | No | Network border group to allocate from \(defaults to the region\) | | `publicIpv4Pool` | string | No | BYOIP address pool to allocate from \(defaults to the Amazon pool\) | | `tags` | json | No | Tags to apply as a JSON object, e.g. \{"Name":"web-eip"\} | @@ -305,8 +289,6 @@ Associate an Elastic IP address with an instance or network interface | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `allocationId` | string | Yes | Allocation ID of the Elastic IP \(e.g., eipalloc-0abc123\) | | `instanceId` | string | No | Instance ID to associate with \(provide this or networkInterfaceId\) | | `networkInterfaceId` | string | No | Network interface ID to associate with \(provide this or instanceId\) | @@ -332,8 +314,6 @@ Disassociate an Elastic IP address from its instance or network interface | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `associationId` | string | Yes | Association ID of the Elastic IP \(e.g., eipassoc-0abc123\) | #### Output @@ -356,8 +336,6 @@ Release an Elastic IP address back to AWS | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `allocationId` | string | Yes | Allocation ID of the Elastic IP to release | | `networkBorderGroup` | string | No | Network border group the address was allocated from | @@ -381,8 +359,6 @@ List NAT gateways with their state, subnet, and IP addresses | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `natGatewayIds` | string | No | Comma-separated NAT gateway IDs \(e.g., nat-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -426,8 +402,6 @@ List VPC route tables with their routes and subnet associations | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `routeTableIds` | string | No | Comma-separated route table IDs \(e.g., rtb-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-100, default 100\) | @@ -476,8 +450,6 @@ List VPCs with their CIDR blocks and state | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `vpcIds` | string | No | Comma-separated VPC IDs \(e.g., vpc-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"is-default","Values":\["false"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -513,8 +485,6 @@ List subnets with their CIDR, Availability Zone, and free IP count | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `subnetIds` | string | No | Comma-separated subnet IDs \(e.g., subnet-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -553,8 +523,6 @@ List security groups with their inbound and outbound rules | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `groupIds` | string | No | Comma-separated security group IDs \(e.g., sg-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -616,8 +584,6 @@ List internet gateways and the VPCs they are attached to | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `internetGatewayIds` | string | No | Comma-separated internet gateway IDs \(e.g., igw-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"attachment.vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -649,8 +615,6 @@ List elastic network interfaces with their IPs, attachment, and security groups | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `networkInterfaceIds` | string | No | Comma-separated network interface IDs \(e.g., eni-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -698,8 +662,6 @@ List EBS volumes with their size, type, state, and attachments | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `volumeIds` | string | No | Comma-separated volume IDs \(e.g., vol-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"status","Values":\["available"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -744,8 +706,6 @@ List EBS snapshots owned by the account (or by the owners you specify) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `snapshotIds` | string | No | Comma-separated snapshot IDs \(e.g., snap-0abc123\) | | `ownerIds` | string | No | Comma-separated owners: AWS account IDs, self, or amazon \(defaults to self\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"volume-id","Values":\["vol-0abc123"\]\}\] | @@ -784,8 +744,6 @@ Create a point-in-time snapshot of an EBS volume | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `volumeId` | string | Yes | ID of the EBS volume to snapshot \(e.g., vol-0abc123\) | | `description` | string | No | Description for the snapshot | | `tags` | json | No | Tags to apply as a JSON object, e.g. \{"Name":"nightly-backup"\} | @@ -817,8 +775,6 @@ Add or overwrite tags on one or more EC2 resources | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `resourceIds` | string | Yes | Comma-separated resource IDs to tag \(e.g., i-0abc123,vol-0def456\) | | `tags` | json | Yes | Tags as a JSON object, e.g. \{"Environment":"prod","Owner":"platform"\} | @@ -842,8 +798,6 @@ Remove tags from one or more EC2 resources | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `resourceIds` | string | Yes | Comma-separated resource IDs to untag | | `tagKeys` | string | Yes | Comma-separated tag keys to remove | @@ -867,8 +821,6 @@ List AWS Regions available to the account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `regionNames` | string | No | Comma-separated region names to describe | | `allRegions` | boolean | No | Include Regions that are not enabled for the account | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"opt-in-status","Values":\["opted-in"\]\}\] | @@ -895,8 +847,6 @@ List Availability Zones, Local Zones, and Wavelength Zones in the region | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `zoneNames` | string | No | Comma-separated zone names \(e.g., us-east-1a\) | | `allAvailabilityZones` | boolean | No | Include zones that are not opted in | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"state","Values":\["available"\]\}\] | @@ -928,8 +878,6 @@ Add an inbound rule to a security group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `groupId` | string | Yes | Security group ID \(e.g., sg-0abc123\) | | `ipProtocol` | string | Yes | IP protocol: tcp, udp, icmp, icmpv6, or -1 for all traffic | | `fromPort` | number | No | Start of the port range \(ICMP type for icmp; omit for -1\) | @@ -968,8 +916,6 @@ Remove inbound rules from a security group by rule ID or by matching protocol, p | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `groupId` | string | Yes | Security group ID \(e.g., sg-0abc123\) | | `ipProtocol` | string | No | IP protocol: tcp, udp, icmp, icmpv6, or -1 for all traffic | | `fromPort` | number | No | Start of the port range \(ICMP type for icmp; omit for -1\) | @@ -1008,8 +954,6 @@ List network ACLs with their inbound and outbound rules and subnet associations | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `networkAclIds` | string | No | Comma-separated network ACL IDs \(e.g., acl-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -1054,8 +998,6 @@ List VPC endpoints with their service, type, state, and network placement | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `vpcEndpointIds` | string | No | Comma-separated VPC endpoint IDs \(e.g., vpce-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"vpc-id","Values":\["vpc-0abc123"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -1095,8 +1037,6 @@ List VPC peering connections with their status and both VPCs | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `vpcPeeringConnectionIds` | string | No | Comma-separated VPC peering connection IDs \(e.g., pcx-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"status-code","Values":\["active"\]\}\] | | `maxResults` | number | No | Maximum results per page when no IDs are given \(5-1000, default 100\) | @@ -1137,8 +1077,6 @@ Permanently delete an EBS volume that is not attached to an instance | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `volumeId` | string | Yes | ID of the EBS volume to delete \(e.g., vol-0abc123\) | #### Output @@ -1161,8 +1099,6 @@ Permanently delete an EBS snapshot | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `snapshotId` | string | Yes | ID of the EBS snapshot to delete \(e.g., snap-0abc123\) | #### Output @@ -1185,8 +1121,6 @@ List AMIs owned by the account (or by the owners you specify) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `imageIds` | string | No | Comma-separated AMI IDs \(e.g., ami-0abc123\) | | `owners` | string | No | Comma-separated owners: AWS account IDs, self, amazon, or aws-marketplace \(defaults to self\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"name","Values":\["my-app-*"\]\}\] | @@ -1228,8 +1162,6 @@ List EC2 key pairs with their type, fingerprint, and creation time | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `keyNames` | string | No | Comma-separated key pair names | | `keyPairIds` | string | No | Comma-separated key pair IDs \(e.g., key-0abc123\) | | `filters` | json | No | EC2 filters as a JSON array, e.g. \[\{"Name":"key-name","Values":\["deploy-*"\]\}\] | diff --git a/apps/docs/content/docs/integrations/elevenlabs.mdx b/apps/docs/content/docs/integrations/elevenlabs.mdx index 2065aced76a..d35cf68d0f6 100644 --- a/apps/docs/content/docs/integrations/elevenlabs.mdx +++ b/apps/docs/content/docs/integrations/elevenlabs.mdx @@ -2,7 +2,7 @@ title: ElevenLabs description: Generate and transform audio with ElevenLabs integration: - type: "elevenlabs" + type: "elevenlabs_v2" color: "#181C1E" --- @@ -34,7 +34,6 @@ Convert text to speech using ElevenLabs voices | `modelId` | string | No | The ID of the model to use \(e.g., "eleven_multilingual_v2", "eleven_turbo_v2"\). Defaults to eleven_monolingual_v1 | | `stability` | number | No | Voice stability setting from 0.0 to 1.0 \(e.g., 0.5 for balanced, 0.75 for more stable\). Higher values produce more consistent output | | `similarityBoost` | number | No | Similarity boost setting from 0.0 to 1.0 \(e.g., 0.75 for natural, 1.0 for maximum similarity\). Higher values make the voice more similar to the original | -| `apiKey` | string | Yes | Your ElevenLabs API key | #### Output @@ -55,7 +54,6 @@ Generate a sound effect from a text prompt using ElevenLabs | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | | `text` | string | Yes | The prompt describing the sound effect \(e.g., "thunder rumbling in the distance"\) | | `modelId` | string | No | The model to use \(defaults to eleven_text_to_sound_v2\) | | `durationSeconds` | number | No | Length of the sound in seconds \(0.5-30\). Omit to auto-determine | @@ -81,7 +79,6 @@ Convert audio into a chosen ElevenLabs voice while preserving content and emotio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | | `voiceId` | string | Yes | The ID of the target voice to convert the audio into | | `audioFile` | file | Yes | The source audio file to convert \(e.g., MP3, WAV, M4A\) | | `modelId` | string | No | The model to use \(defaults to eleven_english_sts_v2\) | @@ -106,7 +103,6 @@ Remove background noise from an audio file, isolating the speech using ElevenLab | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | | `audioFile` | file | Yes | The audio file to isolate speech from \(e.g., MP3, WAV, M4A\) | #### Output @@ -128,7 +124,6 @@ List the voices available in your ElevenLabs account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | | `search` | string | No | Search term to filter voices by name, description, labels, or category | | `category` | string | No | Filter by category: premade, cloned, generated, or professional | | `pageSize` | number | No | Number of voices to return \(1-100, default 10\) | @@ -162,7 +157,6 @@ Get metadata and settings for a specific ElevenLabs voice | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | | `voiceId` | string | Yes | The ID of the voice to retrieve \(e.g., "21m00Tcm4TlvDq8ikWAM"\) | #### Output @@ -192,7 +186,6 @@ Get the configured settings for a specific ElevenLabs voice | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | | `voiceId` | string | Yes | The ID of the voice whose settings to retrieve | #### Output @@ -217,7 +210,6 @@ Update the settings for a specific ElevenLabs voice | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | | `voiceId` | string | Yes | The ID of the voice to update | | `stability` | number | No | Voice stability from 0.0 to 1.0 \(default 0.5\) | | `similarityBoost` | number | No | Similarity boost from 0.0 to 1.0 \(default 0.75\) | @@ -243,7 +235,6 @@ List the models available in ElevenLabs | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | #### Output @@ -273,7 +264,6 @@ Get account and subscription information for the ElevenLabs user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Your ElevenLabs API key | #### Output diff --git a/apps/docs/content/docs/integrations/enrich.mdx b/apps/docs/content/docs/integrations/enrich.mdx index 99aa6d47d4b..ac35946ada4 100644 --- a/apps/docs/content/docs/integrations/enrich.mdx +++ b/apps/docs/content/docs/integrations/enrich.mdx @@ -2,7 +2,7 @@ title: Enrich description: B2B data enrichment and LinkedIn intelligence with Enrich.so integration: - type: "enrich" + type: "enrich_v2" color: "#E5E5E6" --- @@ -29,7 +29,6 @@ Check your Enrich API credit usage and remaining balance. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | #### Output @@ -51,7 +50,6 @@ Retrieve detailed LinkedIn profile information using an email address including | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `email` | string | Yes | Email address to look up \(e.g., john.doe@company.com\) | | `inRealtime` | boolean | No | Set to true to retrieve fresh data, bypassing cached information | @@ -104,7 +102,6 @@ Retrieve basic LinkedIn profile information from an email address. A lighter ver | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `email` | string | Yes | Email address to look up \(e.g., john.doe@company.com\) | #### Output @@ -144,7 +141,6 @@ Enrich a LinkedIn profile URL with detailed information including positions, edu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `url` | string | Yes | LinkedIn profile URL \(e.g., linkedin.com/in/williamhgates\) | #### Output @@ -190,7 +186,6 @@ Find a person's work email address using their full name and company domain. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `fullName` | string | Yes | Person's full name \(e.g., John Doe\) | | `companyDomain` | string | Yes | Company domain \(e.g., example.com\) | @@ -217,7 +212,6 @@ Find a work email address from a LinkedIn profile URL. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `linkedinProfile` | string | Yes | LinkedIn profile URL \(e.g., https://www.linkedin.com/in/williamhgates) | #### Output @@ -240,7 +234,6 @@ Find personal email address from a LinkedIn profile URL. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `linkedinProfile` | string | Yes | LinkedIn profile URL \(e.g., linkedin.com/in/username\) | #### Output @@ -263,7 +256,6 @@ Find a phone number from a LinkedIn profile URL. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `linkedinProfile` | string | Yes | LinkedIn profile URL \(e.g., linkedin.com/in/williamhgates\) | #### Output @@ -287,7 +279,6 @@ Find a phone number associated with an email address. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `email` | string | Yes | Email address to look up \(e.g., john.doe@example.com\) | #### Output @@ -311,7 +302,6 @@ Verify an email address for deliverability, including catch-all detection and pr | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `email` | string | Yes | Email address to verify \(e.g., john.doe@example.com\) | #### Output @@ -339,7 +329,6 @@ Check if an email address is from a disposable or temporary email provider. Retu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `email` | string | Yes | Email address to check \(e.g., john.doe@example.com\) | #### Output @@ -368,7 +357,6 @@ Discover an IP address associated with an email address. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `email` | string | Yes | Email address to look up \(e.g., john.doe@example.com\) | #### Output @@ -391,7 +379,6 @@ Identify a company from an IP address with detailed firmographic information. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `ip` | string | Yes | IP address to look up \(e.g., 86.92.60.221\) | #### Output @@ -428,7 +415,6 @@ Look up company information by name or domain, including funding, location, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `name` | string | No | Company name \(e.g., Google\) | | `domain` | string | No | Company domain \(e.g., google.com\) | @@ -474,7 +460,6 @@ Retrieve company funding history, traffic metrics, and executive information by | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `domain` | string | Yes | Company domain \(e.g., example.com\) | #### Output @@ -510,7 +495,6 @@ Retrieve company revenue data, CEO information, and competitive analysis by doma | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `domain` | string | Yes | Company domain \(e.g., clay.io\) | #### Output @@ -556,7 +540,6 @@ Search for professionals by various criteria including name, title, skills, educ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `firstName` | string | No | First name | | `lastName` | string | No | Last name | | `summary` | string | No | Professional summary keywords | @@ -610,7 +593,6 @@ Search for companies by various criteria including name, industry, location, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `name` | string | No | Company name | | `website` | string | No | Company website URL | | `tagline` | string | No | Company tagline | @@ -657,7 +639,6 @@ Search for employees within specific companies by location and job title. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `companyIds` | json | No | Array of company IDs to search within | | `country` | string | No | Country filter \(e.g., United States\) | | `city` | string | No | City filter \(e.g., San Francisco\) | @@ -696,7 +677,6 @@ Find companies similar to a given company by LinkedIn URL with filters for locat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `url` | string | Yes | LinkedIn company URL \(e.g., linkedin.com/company/google\) | | `accountLocation` | json | No | Filter by locations \(array of country names\) | | `employeeSizeType` | string | No | Employee size filter type \(e.g., RANGE\) | @@ -735,7 +715,6 @@ Advanced people search with complex filters for location, company size, seniorit | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `page` | number | Yes | Page number \(starts at 1\) | | `filters` | json | Yes | Array of filter objects. Each filter has type \(e.g., POSTAL_CODE, COMPANY_HEADCOUNT\), values \(array with id, text, selectionType: INCLUDED/EXCLUDED\), and optional selectedSubFilter | @@ -769,7 +748,6 @@ Search LinkedIn job postings by keywords with filters for location, job type, wo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `keywords` | string | Yes | Search keywords \(e.g., "software engineer"\) | | `location` | string | No | Location filter \(e.g., London\) | | `jobTypes` | string | No | Comma-separated job types \(e.g., "full time, part time"\) | @@ -808,7 +786,6 @@ Search LinkedIn posts by keywords with date filtering. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `keywords` | string | Yes | Search keywords \(e.g., "AI automation"\) | | `datePosted` | string | No | Time filter \(e.g., past_week, past_month\) | | `page` | number | No | Page number \(default: 1\) | @@ -845,7 +822,6 @@ Get detailed information about a LinkedIn post by URL. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `url` | string | Yes | LinkedIn post URL | #### Output @@ -877,7 +853,6 @@ Get reactions on a LinkedIn post with filtering by reaction type. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `postUrn` | string | Yes | LinkedIn activity URN \(e.g., urn:li:activity:7231931952839196672\) | | `reactionType` | string | Yes | Reaction type filter: all, like, love, celebrate, insightful, or funny \(default: all\) | | `page` | number | Yes | Page number \(starts at 1\) | @@ -910,7 +885,6 @@ Get reactions on a LinkedIn post by its URL, filtered by reaction type. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `postUrl` | string | Yes | LinkedIn post URL \(e.g., https://www.linkedin.com/posts/...) | | `reactionType` | string | Yes | Reaction type filter: all, like, love, celebrate, insightful, or funny \(default: all\) | | `page` | number | Yes | Page number \(starts at 1\) | @@ -943,7 +917,6 @@ Get comments on a LinkedIn post. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `postUrn` | string | Yes | LinkedIn activity URN \(e.g., urn:li:activity:7191163324208705536\) | | `page` | number | No | Page number \(starts at 1, default: 1\) | @@ -985,7 +958,6 @@ Get comments on a LinkedIn post by its URL. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `postUrl` | string | Yes | LinkedIn post URL \(e.g., https://www.linkedin.com/posts/...) | | `page` | number | No | Page number \(starts at 1, default: 1\) | @@ -1027,7 +999,6 @@ Get a person's LinkedIn activities (posts, comments, or articles) by profile ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `profileId` | string | Yes | LinkedIn profile ID | | `activityType` | string | Yes | Activity type: posts, comments, or articles | | `paginationToken` | string | No | Pagination token for next page of results | @@ -1066,7 +1037,6 @@ Get a company's LinkedIn activities (posts, comments, or articles) by company ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `companyId` | string | Yes | LinkedIn company ID | | `activityType` | string | Yes | Activity type: posts, comments, or articles | | `paginationToken` | string | No | Pagination token for next page of results | @@ -1106,7 +1076,6 @@ Convert an MD5 email hash back to the original email address and display name. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `hash` | string | Yes | MD5 hash value to look up | #### Output @@ -1130,7 +1099,6 @@ Get a company logo image URL by domain. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Enrich API key | | `url` | string | Yes | Company domain \(e.g., google.com\) | #### Output diff --git a/apps/docs/content/docs/integrations/extend.mdx b/apps/docs/content/docs/integrations/extend.mdx index cb54644bdcb..a32e17b4c72 100644 --- a/apps/docs/content/docs/integrations/extend.mdx +++ b/apps/docs/content/docs/integrations/extend.mdx @@ -2,7 +2,7 @@ title: Extend description: Parse and extract content from documents integration: - type: "extend_v2" + type: "extend_v3" color: "#000000" --- @@ -33,7 +33,6 @@ Parse and extract content from documents using Extend AI | `outputFormat` | string | No | Target output format \(markdown or spatial\). Defaults to markdown. | | `chunking` | string | No | Chunking strategy \(page, document, or section\). Defaults to page. | | `engine` | string | No | Parsing engine \(parse_performance or parse_light\). Defaults to parse_performance. | -| `apiKey` | string | Yes | Extend API key | #### Output diff --git a/apps/docs/content/docs/integrations/fireflies.mdx b/apps/docs/content/docs/integrations/fireflies.mdx index 9540c7072c6..27cf424f2d7 100644 --- a/apps/docs/content/docs/integrations/fireflies.mdx +++ b/apps/docs/content/docs/integrations/fireflies.mdx @@ -2,7 +2,7 @@ title: Fireflies description: Interact with Fireflies.ai meeting transcripts and recordings integration: - type: "fireflies_v2" + type: "fireflies_v3" color: "#100730" --- @@ -31,7 +31,6 @@ List meeting transcripts from Fireflies.ai with optional filtering | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `keyword` | string | No | Search keyword in meeting title or transcript \(e.g., "quarterly review"\) | | `fromDate` | string | No | Filter transcripts from this date \(ISO 8601 format\) | | `toDate` | string | No | Filter transcripts until this date \(ISO 8601 format\) | @@ -59,7 +58,6 @@ Get a single transcript with full details including summary, action items, and a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `transcriptId` | string | Yes | The transcript ID to retrieve \(e.g., "abc123def456"\) | #### Output @@ -92,7 +90,6 @@ Get user information from Fireflies.ai. Returns current user if no ID specified. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `userId` | string | No | User ID to retrieve \(e.g., "user_abc123", defaults to API key owner\) | #### Output @@ -122,7 +119,6 @@ List all users within your Fireflies.ai team | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | #### Output @@ -142,7 +138,6 @@ Upload an audio file URL to Fireflies.ai for transcription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `audioFile` | file | No | Audio/video file to upload for transcription | | `audioUrl` | string | No | Public HTTPS URL of the audio/video file \(MP3, MP4, WAV, M4A, OGG\) | | `title` | string | No | Title for the meeting/transcript | @@ -171,7 +166,6 @@ Delete a transcript from Fireflies.ai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `transcriptId` | string | Yes | The transcript ID to delete \(e.g., "abc123def456"\) | #### Output @@ -199,7 +193,6 @@ Add the Fireflies.ai bot to an ongoing meeting to record and transcribe | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `meetingLink` | string | Yes | Valid meeting URL \(Zoom, Google Meet, Microsoft Teams, etc.\) | | `title` | string | No | Title for the meeting \(max 256 characters\) | | `meetingPassword` | string | No | Password for the meeting if required \(max 32 characters\) | @@ -224,7 +217,6 @@ Create a soundbite/highlight from a specific time range in a transcript | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `transcriptId` | string | Yes | ID of the transcript to create the bite from \(e.g., "abc123def456"\) | | `startTime` | number | Yes | Start time of the bite in seconds | | `endTime` | number | Yes | End time of the bite in seconds | @@ -253,7 +245,6 @@ List soundbites/highlights from Fireflies.ai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | | `transcriptId` | string | No | Filter bites for a specific transcript \(e.g., "abc123def456"\) | | `mine` | boolean | No | Only return bites owned by the API key owner \(default: true\) | | `limit` | number | No | Maximum number of bites to return \(e.g., 10, max 50\) | @@ -277,7 +268,6 @@ List all contacts from your Fireflies.ai meetings | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Fireflies API key | #### Output diff --git a/apps/docs/content/docs/integrations/flint.mdx b/apps/docs/content/docs/integrations/flint.mdx index 48f581b7553..fabb4fc33c4 100644 --- a/apps/docs/content/docs/integrations/flint.mdx +++ b/apps/docs/content/docs/integrations/flint.mdx @@ -2,7 +2,7 @@ title: Flint description: Run background agent tasks on your Flint sites integration: - type: "flint" + type: "flint_v2" color: "#F6F54F" --- @@ -29,7 +29,6 @@ Start a background Flint agent task that modifies a site from a natural-language | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Flint API key \(found in Flint team settings, starts with ak_\) | | `siteId` | string | Yes | ID of the Flint site the agent should modify | | `prompt` | string | Yes | Natural-language instructions for the agent \(e.g., "Add a new About page with a team section"\) | | `callbackUrl` | string | No | HTTPS webhook URL that Flint will POST to when the task completes or fails | @@ -55,7 +54,6 @@ Start a background Flint agent task that generates up to 10 pages from a templat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Flint API key \(found in Flint team settings, starts with ak_\) | | `siteId` | string | Yes | ID of the Flint site the agent should modify | | `templatePageSlug` | string | Yes | Slug of the existing template page to generate from \(e.g., /case-studies/template\) | | `items` | array | Yes | JSON array of 1-10 pages to generate. Each item requires targetPageSlug \(slug for the new page\) and context \(content details the agent should use\). | @@ -82,7 +80,6 @@ Get the status and results of a background Flint agent task. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Flint API key \(found in Flint team settings, starts with ak_\) | | `taskId` | string | Yes | Identifier of the task returned when it was created \(e.g., bg-...\) | #### Output diff --git a/apps/docs/content/docs/integrations/gamma.mdx b/apps/docs/content/docs/integrations/gamma.mdx index e47cbfaa8b4..c261b7db2e3 100644 --- a/apps/docs/content/docs/integrations/gamma.mdx +++ b/apps/docs/content/docs/integrations/gamma.mdx @@ -2,7 +2,7 @@ title: Gamma description: Generate presentations, documents, and webpages with AI integration: - type: "gamma" + type: "gamma_v2" color: "#002253" --- @@ -29,7 +29,6 @@ Generate a new Gamma presentation, document, webpage, or social post from text i | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Gamma API key | | `inputText` | string | Yes | Text and image URLs used to generate your gamma \(1-100,000 tokens\) | | `textMode` | string | Yes | How to handle input text: generate \(AI expands\), condense \(AI summarizes\), or preserve \(keep as-is\) | | `format` | string | No | Output format: presentation, document, webpage, or social \(default: presentation\) | @@ -66,7 +65,6 @@ Generate a new Gamma by adapting an existing template with a prompt. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Gamma API key | | `gammaId` | string | Yes | The ID of the template gamma to adapt | | `prompt` | string | Yes | Instructions for how to adapt the template \(1-100,000 tokens\) | | `themeId` | string | No | Custom Gamma workspace theme ID to apply | @@ -93,7 +91,6 @@ Check the status of a Gamma generation job. Returns the gamma URL when completed | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Gamma API key | | `generationId` | string | Yes | The generation ID returned by the Generate or Generate from Template tool | #### Output @@ -122,7 +119,6 @@ List available themes in your Gamma workspace. Returns theme IDs, names, and key | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Gamma API key | | `query` | string | No | Search query to filter themes by name \(case-insensitive\) | | `limit` | number | No | Maximum number of themes to return per page \(max 50\) | | `after` | string | No | Pagination cursor from a previous response \(nextCursor\) to fetch the next page | @@ -152,7 +148,6 @@ List available folders in your Gamma workspace. Returns folder IDs and names for | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Gamma API key | | `query` | string | No | Search query to filter folders by name \(case-sensitive\) | | `limit` | number | No | Maximum number of folders to return per page \(max 50\) | | `after` | string | No | Pagination cursor from a previous response \(nextCursor\) to fetch the next page | diff --git a/apps/docs/content/docs/integrations/hex.mdx b/apps/docs/content/docs/integrations/hex.mdx index 699e7f231a7..1e8c22216f9 100644 --- a/apps/docs/content/docs/integrations/hex.mdx +++ b/apps/docs/content/docs/integrations/hex.mdx @@ -2,7 +2,7 @@ title: Hex description: Run and manage Hex projects integration: - type: "hex" + type: "hex_v2" color: "#14151A" --- @@ -15,7 +15,7 @@ Use [Hex](https://hex.tech/) to run analytics projects, inspect results and run ## Use the block [#usage-instructions] -Run projects, check run status, manage collections and groups (including membership and deactivating users), list users, and view data connections. Requires a Hex API token. +Run projects, check run status, manage collections and groups (including membership and deactivating users), list users, and view data connections. ## Actions @@ -29,7 +29,6 @@ Cancel an active Hex project run. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `projectId` | string | Yes | The UUID of the Hex project | | `runId` | string | Yes | The UUID of the run to cancel | @@ -53,7 +52,6 @@ Create a new collection in the Hex workspace to organize projects. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `name` | string | Yes | Name for the new collection | | `description` | string | No | Optional description for the collection | @@ -80,7 +78,6 @@ Create a new group in the Hex workspace, optionally with initial members. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `name` | string | Yes | Name for the new group | | `memberUserIds` | json | No | JSON array of user UUIDs to add as initial group members \(e.g., \["uuid1", "uuid2"\]\) | @@ -104,7 +101,6 @@ Deactivate a user in the Hex workspace. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `userId` | string | Yes | The UUID of the user to deactivate | #### Output @@ -126,7 +122,6 @@ Delete a group from the Hex workspace. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `groupId` | string | Yes | The UUID of the group to delete | #### Output @@ -148,7 +143,6 @@ Retrieve details for a specific Hex collection by its ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `collectionId` | string | Yes | The UUID of the collection | #### Output @@ -174,7 +168,6 @@ Retrieve details for a specific data connection including type, description, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `dataConnectionId` | string | Yes | The UUID of the data connection | #### Output @@ -201,7 +194,6 @@ Retrieve details for a specific Hex group. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `groupId` | string | Yes | The UUID of the group | #### Output @@ -224,7 +216,6 @@ Get metadata and details for a specific Hex project by its ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `projectId` | string | Yes | The UUID of the Hex project | #### Output @@ -262,7 +253,6 @@ Retrieve API-triggered runs for a Hex project with optional filtering by status | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `projectId` | string | Yes | The UUID of the Hex project | | `limit` | number | No | Maximum number of runs to return \(1-100, default: 25\) | | `offset` | number | No | Offset for paginated results \(default: 0\) | @@ -300,7 +290,6 @@ Return the warehouse tables queried by a Hex project, including data connection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `projectId` | string | Yes | The UUID of the Hex project | | `limit` | number | No | Maximum number of tables to return \(1-100\) | @@ -326,7 +315,6 @@ Check the status of a Hex project run by its run ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `projectId` | string | Yes | The UUID of the Hex project | | `runId` | string | Yes | The UUID of the run to check | @@ -356,7 +344,6 @@ List all collections in the Hex workspace. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `limit` | number | No | Maximum number of collections to return \(1-500, default: 25\) | | `sortBy` | string | No | Sort by field: NAME | | `after` | string | No | Cursor to fetch the page of results after this value | @@ -389,7 +376,6 @@ List all data connections in the Hex workspace (e.g., Snowflake, PostgreSQL, Big | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `limit` | number | No | Maximum number of connections to return \(1-500, default: 25\) | | `sortBy` | string | No | Sort by field: CREATED_AT or NAME | | `sortDirection` | string | No | Sort direction: ASC or DESC | @@ -424,7 +410,6 @@ List all groups in the Hex workspace with optional sorting. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `limit` | number | No | Maximum number of groups to return \(1-500, default: 25\) | | `sortBy` | string | No | Sort by field: CREATED_AT or NAME | | `sortDirection` | string | No | Sort direction: ASC or DESC | @@ -455,7 +440,6 @@ List all projects in your Hex workspace with optional filtering by status. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `limit` | number | No | Maximum number of projects to return \(1-100\) | | `includeArchived` | boolean | No | Include archived projects in results | | `statusFilter` | string | No | Filter by status: PUBLISHED, DRAFT, or ALL | @@ -505,7 +489,6 @@ List all users in the Hex workspace with optional filtering and sorting. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `limit` | number | No | Maximum number of users to return \(1-100, default: 25\) | | `sortBy` | string | No | Sort by field: NAME or EMAIL | | `sortDirection` | string | No | Sort direction: ASC or DESC | @@ -540,7 +523,6 @@ Execute a published Hex project. Optionally pass input parameters and control ca | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `projectId` | string | Yes | The UUID of the Hex project to run | | `inputParams` | json | No | JSON object of input parameters for the project \(e.g., \{"date": "2024-01-01"\}\) | | `dryRun` | boolean | No | If true, perform a dry run without executing the project | @@ -573,7 +555,6 @@ Update the name or description of an existing Hex collection. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `collectionId` | string | Yes | The UUID of the collection to update | | `name` | string | No | New name for the collection | | `description` | string | No | New description for the collection | @@ -601,7 +582,6 @@ Rename a Hex group or add/remove members from it. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `groupId` | string | Yes | The UUID of the group to update | | `name` | string | No | New name for the group | | `addUserIds` | json | No | JSON array of user UUIDs to add to the group \(e.g., \["uuid1", "uuid2"\]\) | @@ -627,7 +607,6 @@ Update a Hex project status label (e.g., endorsement or custom workspace statuse | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Hex API token \(Personal or Workspace\) | | `projectId` | string | Yes | The UUID of the Hex project to update | | `status` | string | Yes | New project status name \(custom workspace status label\) | diff --git a/apps/docs/content/docs/integrations/huggingface.mdx b/apps/docs/content/docs/integrations/huggingface.mdx index 545d678fffa..a09ac12149d 100644 --- a/apps/docs/content/docs/integrations/huggingface.mdx +++ b/apps/docs/content/docs/integrations/huggingface.mdx @@ -2,7 +2,7 @@ title: Hugging Face description: Use Hugging Face Inference API integration: - type: "huggingface" + type: "huggingface_v2" color: "#0B0F19" --- @@ -35,7 +35,6 @@ Generate completions using Hugging Face Inference API | `model` | string | Yes | Model to use for chat completions \(e.g., "deepseek/deepseek-v3-0324", "meta-llama/Llama-3.3-70B-Instruct"\) | | `maxTokens` | number | No | Maximum number of tokens to generate | | `temperature` | number | No | Sampling temperature \(0-2\). Higher values make output more random | -| `apiKey` | string | Yes | Hugging Face API token | #### Output diff --git a/apps/docs/content/docs/integrations/iam.mdx b/apps/docs/content/docs/integrations/iam.mdx index 6679fbac775..68ed7f380d5 100644 --- a/apps/docs/content/docs/integrations/iam.mdx +++ b/apps/docs/content/docs/integrations/iam.mdx @@ -2,7 +2,7 @@ title: AWS IAM description: Manage AWS IAM users, roles, policies, and groups integration: - type: "iam" + type: "iam_v2" color: "linear-gradient(45deg, #BD0816 0%, #FF5252 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -[AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/) controls access to AWS resources. Use this integration to manage users, roles, policies, groups, and access keys, or simulate a principal’s permissions before changing them. +[AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/) controls access to AWS resources. Use this integration to manage users, roles, policies, groups, and access keys, or simulate a principal’s permissions before changing them. Connect with a saved [AWS credential](/integrations/aws-credentials). `Simulate Principal Policy` returns one result per action regardless of how many resource ARNs you pass. The top-level decision is the **aggregate** across every resource — most restrictive wins — and the top-level resource name is an ARN *template* for the resource type, not one of your ARNs. Per-resource answers live in `resourceSpecificResults`, and when you supply concrete ARNs, missing context keys are reported there too rather than at the top level. Read `resourceSpecificResults` whenever you simulate against more than one resource: the aggregate alone will tell you a principal is denied when it is in fact allowed on some of them. @@ -34,8 +34,6 @@ List IAM users in your AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `pathPrefix` | string | No | Path prefix to filter users \(e.g., /division_abc/\) | | `maxItems` | number | No | Maximum number of users to return \(1-1000, default 100\) | | `marker` | string | No | Pagination marker from a previous request | @@ -62,8 +60,6 @@ Get detailed information about an IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | No | The name of the IAM user to retrieve \(defaults to the caller if omitted\) | #### Output @@ -92,8 +88,6 @@ Create a new IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | Yes | Name for the new IAM user \(1-64 characters\) | | `path` | string | No | Path for the user \(e.g., /division_abc/\), defaults to / | @@ -121,8 +115,6 @@ Delete an IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | Yes | The name of the IAM user to delete | #### Output @@ -144,8 +136,6 @@ List IAM roles in your AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `pathPrefix` | string | No | Path prefix to filter roles \(e.g., /application/\) | | `maxItems` | number | No | Maximum number of roles to return \(1-1000, default 100\) | | `marker` | string | No | Pagination marker from a previous request | @@ -172,8 +162,6 @@ Get detailed information about an IAM role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `roleName` | string | Yes | The name of the IAM role to retrieve | #### Output @@ -204,8 +192,6 @@ Create a new IAM role with a trust policy | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `roleName` | string | Yes | Name for the new IAM role \(1-64 characters\) | | `assumeRolePolicyDocument` | string | Yes | Trust policy JSON specifying who can assume this role | | `description` | string | No | Description of the role | @@ -236,8 +222,6 @@ Delete an IAM role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `roleName` | string | Yes | The name of the IAM role to delete | #### Output @@ -259,8 +243,6 @@ Attach a managed policy to an IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | Yes | The name of the IAM user | | `policyArn` | string | Yes | The ARN of the managed policy to attach | @@ -283,8 +265,6 @@ Remove a managed policy from an IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | Yes | The name of the IAM user | | `policyArn` | string | Yes | The ARN of the managed policy to detach | @@ -307,8 +287,6 @@ Attach a managed policy to an IAM role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `roleName` | string | Yes | The name of the IAM role | | `policyArn` | string | Yes | The ARN of the managed policy to attach | @@ -331,8 +309,6 @@ Remove a managed policy from an IAM role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `roleName` | string | Yes | The name of the IAM role | | `policyArn` | string | Yes | The ARN of the managed policy to detach | @@ -355,8 +331,6 @@ List managed IAM policies | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `scope` | string | No | Filter by scope. Must be exactly one of: All, AWS \(AWS-managed\), Local \(customer-managed\) | | `onlyAttached` | boolean | No | If true, only return policies attached to an entity | | `pathPrefix` | string | No | Path prefix to filter policies | @@ -385,8 +359,6 @@ Get details about a managed IAM policy, including its description — the field | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `policyArn` | string | Yes | ARN of the managed policy to retrieve \(e.g., arn:aws:iam::aws:policy/ReadOnlyAccess\) | #### Output @@ -419,8 +391,6 @@ Create a new access key pair for an IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | No | The IAM user to create the key for \(defaults to current user\) | #### Output @@ -447,8 +417,6 @@ Delete an access key pair for an IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `accessKeyIdToDelete` | string | Yes | The access key ID to delete | | `userName` | string | No | The IAM user whose key to delete \(defaults to current user\) | @@ -471,8 +439,6 @@ List an IAM user's access key IDs with their status and age — use to find stal | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | No | The IAM user whose keys to list \(defaults to the calling user if omitted\) | | `maxItems` | number | No | Maximum number of access keys to return \(1-1000\) | | `marker` | string | No | Pagination marker from a previous request | @@ -499,8 +465,6 @@ Activate or deactivate an IAM access key — deactivate an old key and verify no | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `accessKeyIdToUpdate` | string | Yes | The access key ID whose status to change | | `status` | string | Yes | The status to set. Must be exactly one of: Active, Inactive. An Inactive key is rejected by AWS but can be reactivated. | | `userName` | string | No | The IAM user that owns the key \(defaults to the calling user if omitted\) | @@ -524,8 +488,6 @@ List IAM groups in your AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `pathPrefix` | string | No | Path prefix to filter groups | | `maxItems` | number | No | Maximum number of groups to return \(1-1000, default 100\) | | `marker` | string | No | Pagination marker from a previous request | @@ -552,8 +514,6 @@ Add an IAM user to a group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | Yes | The name of the IAM user | | `groupName` | string | Yes | The name of the IAM group | @@ -576,8 +536,6 @@ Remove an IAM user from a group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | Yes | The name of the IAM user | | `groupName` | string | Yes | The name of the IAM group | @@ -600,8 +558,6 @@ List all managed policies attached to an IAM role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `roleName` | string | Yes | Name of the IAM role | | `pathPrefix` | string | No | Path prefix to filter policies \(e.g., /application/\) | | `maxItems` | number | No | Maximum number of policies to return \(1-1000\) | @@ -629,8 +585,6 @@ List all managed policies attached to an IAM user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `userName` | string | Yes | Name of the IAM user | | `pathPrefix` | string | No | Path prefix to filter policies \(e.g., /application/\) | | `maxItems` | number | No | Maximum number of policies to return \(1-1000\) | @@ -658,8 +612,6 @@ Simulate whether a user, role, or group is allowed to perform specific AWS actio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `policySourceArn` | string | Yes | ARN of the user, group, or role to simulate \(e.g., arn:aws:iam::123456789012:user/alice\) | | `actionNames` | string | Yes | Comma-separated list of AWS actions to simulate \(e.g., s3:GetObject,ec2:DescribeInstances\) | | `resourceArns` | string | No | Comma-separated list of resource ARNs to simulate against \(defaults to * if not provided\). Read the per-ARN verdict from resourceSpecificResults, not from evalDecision. | diff --git a/apps/docs/content/docs/integrations/identity_center.mdx b/apps/docs/content/docs/integrations/identity_center.mdx index df1d7e7fec3..5655532ee83 100644 --- a/apps/docs/content/docs/integrations/identity_center.mdx +++ b/apps/docs/content/docs/integrations/identity_center.mdx @@ -2,7 +2,7 @@ title: AWS Identity Center description: Manage account access in AWS IAM Identity Center integration: - type: "identity_center" + type: "identity_center_v2" color: "linear-gradient(45deg, #BD0816 0%, #FF5252 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/) to assign or revoke permission sets for AWS accounts, resolve users and groups, and inspect account access. +Use [AWS IAM Identity Center](https://aws.amazon.com/iam/identity-center/) to assign or revoke permission sets for AWS accounts, resolve users and groups, and inspect account access. Connect with a saved [AWS credential](/integrations/aws-credentials). The same operations support the reverse direction — access review. Starting from an account, an agent can list its assignments, resolve the principals, expand groups into their members, and produce a written report of exactly who can reach that account and through which permission set. @@ -36,8 +36,6 @@ List all AWS IAM Identity Center instances in your account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum number of instances to return \(1-100\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -69,8 +67,6 @@ List all AWS accounts in your organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum number of accounts to return \(1-20; the AWS Organizations ceiling\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -101,8 +97,6 @@ Retrieve details about a specific AWS account by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `accountId` | string | Yes | AWS account ID to describe | #### Output @@ -129,8 +123,6 @@ List all permission sets defined in an IAM Identity Center instance | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceArn` | string | Yes | ARN of the Identity Center instance | | `maxResults` | number | No | Maximum number of permission sets to return \(1-100\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -161,8 +153,6 @@ Look up a user in the Identity Store by email address | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `identityStoreId` | string | Yes | Identity Store ID \(from the Identity Center instance\) | | `email` | string | Yes | Email address of the user to look up | @@ -188,8 +178,6 @@ Resolve an Identity Store user ID to the user behind it. Use to turn the princip | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `identityStoreId` | string | Yes | Identity Store ID \(e.g., d-1234567890\) | | `userId` | string | Yes | Identity Store user ID, such as the principalId on a USER account assignment | @@ -220,8 +208,6 @@ Look up a group in the Identity Store by display name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `identityStoreId` | string | Yes | Identity Store ID \(from the Identity Center instance\) | | `displayName` | string | Yes | Display name of the group to look up | @@ -246,8 +232,6 @@ Resolve an Identity Store group ID to the group behind it. Use to turn the princ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `identityStoreId` | string | Yes | Identity Store ID \(e.g., d-1234567890\) | | `groupId` | string | Yes | Identity Store group ID, such as the principalId on a GROUP account assignment | @@ -275,8 +259,6 @@ List all groups in the Identity Store | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `identityStoreId` | string | Yes | Identity Store ID \(from the Identity Center instance\) | | `maxResults` | number | No | Maximum number of groups to return \(1-100\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -308,8 +290,6 @@ List the users who belong to an Identity Store group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `identityStoreId` | string | Yes | Identity Store ID \(e.g., d-1234567890\) | | `groupId` | string | Yes | Identity Store group ID whose members to list | | `maxResults` | number | No | Maximum number of memberships to return \(1-100\) | @@ -339,8 +319,6 @@ Grant a user or group access to an AWS account via a permission set (temporary e | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceArn` | string | Yes | ARN of the Identity Center instance | | `accountId` | string | Yes | AWS account ID to grant access to | | `permissionSetArn` | string | Yes | ARN of the permission set to assign | @@ -374,8 +352,6 @@ Revoke a user or group access to an AWS account by removing a permission set ass | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceArn` | string | Yes | ARN of the Identity Center instance | | `accountId` | string | Yes | AWS account ID to revoke access from | | `permissionSetArn` | string | Yes | ARN of the permission set to remove | @@ -409,8 +385,6 @@ Check the provisioning status of an account assignment creation request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceArn` | string | Yes | ARN of the Identity Center instance | | `requestId` | string | Yes | Request ID returned from Create Account Assignment. Deletion request IDs are not accepted — use Check Assignment Deletion Status for those. | @@ -441,8 +415,6 @@ Check the deprovisioning status of an account assignment deletion request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceArn` | string | Yes | ARN of the Identity Center instance | | `requestId` | string | Yes | Request ID returned from Delete Account Assignment | @@ -473,8 +445,6 @@ List every account and permission set a specific user or group is assigned. Use | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceArn` | string | Yes | ARN of the Identity Center instance | | `principalId` | string | Yes | Identity Store ID of the user or group | | `principalType` | string | Yes | Type of principal: USER or GROUP | @@ -506,8 +476,6 @@ List every principal assigned a specific permission set on a specific AWS accoun | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceArn` | string | Yes | ARN of the Identity Center instance | | `accountId` | string | Yes | AWS account ID to list assignments for \(12 digits\) | | `permissionSetArn` | string | Yes | ARN of the permission set to list assignments for | diff --git a/apps/docs/content/docs/integrations/incidentio.mdx b/apps/docs/content/docs/integrations/incidentio.mdx index 5e9f8f96c29..b70b6bd9022 100644 --- a/apps/docs/content/docs/integrations/incidentio.mdx +++ b/apps/docs/content/docs/integrations/incidentio.mdx @@ -2,7 +2,7 @@ title: incident.io description: Manage incidents with incident.io integration: - type: "incidentio" + type: "incidentio_v2" color: "#FFFFFF" --- @@ -29,7 +29,6 @@ List incidents from incident.io. Returns a list of incidents with their details | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `page_size` | number | No | Number of incidents to return per page \(e.g., 10, 25, 50\). Default: 25 | | `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `sort_by` | string | No | Sort order for incidents: created_at_newest_first or created_at_oldest_first | @@ -83,7 +82,6 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `idempotency_key` | string | Yes | Unique identifier to prevent duplicate incident creation. Use a UUID or unique string. | | `name` | string | No | Name of the incident \(e.g., "Database connection issues"\) | | `summary` | string | No | Brief summary of the incident \(e.g., "Intermittent connection failures to primary database"\) | @@ -132,7 +130,6 @@ Retrieve detailed information about a specific incident from incident.io by its | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | ID of the incident to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -177,7 +174,6 @@ Update an existing incident in incident.io. Can update name, summary, severity, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | ID of the incident to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `name` | string | No | Updated name of the incident \(e.g., "Database connection issues"\) | | `summary` | string | No | Updated summary of the incident \(e.g., "Intermittent connection failures to primary database"\) | @@ -226,7 +222,6 @@ List actions from incident.io. Optionally filter by incident ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | No | Filter actions by incident ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_mode` | string | No | Filter actions by incident mode \(standard, retrospective, test, tutorial, or stream\) | @@ -268,7 +263,6 @@ Get detailed information about a specific action from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | Action ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -309,7 +303,6 @@ List follow-ups from incident.io. Optionally filter by incident ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | No | Filter follow-ups by incident ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_mode` | string | No | Filter follow-ups by incident mode \(standard, retrospective, test, tutorial, or stream\) | @@ -357,7 +350,6 @@ Get detailed information about a specific follow-up from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | Follow-up ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -404,7 +396,6 @@ List all users in your Incident.io workspace. Returns user details including id, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Incident.io API Key | | `page_size` | number | No | Number of results to return per page \(e.g., 10, 25, 50\). Default: 25 | | `after` | string | No | Pagination cursor to fetch the next page of results | | `email` | string | No | Filter users by email address | @@ -436,7 +427,6 @@ Get detailed information about a specific user in your Incident.io workspace by | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Incident.io API Key | | `id` | string | Yes | The unique identifier of the user to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -461,7 +451,6 @@ List all workflows in your incident.io workspace. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | #### Output @@ -499,7 +488,6 @@ Create a new workflow in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `name` | string | Yes | Name of the workflow \(e.g., "Notify on Critical Incidents"\) | | `folder` | string | No | Folder to organize the workflow in | | `state` | string | No | State of the workflow \(active, draft, or disabled\) | @@ -551,7 +539,6 @@ Get details of a specific workflow in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the workflow to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `skip_step_upgrades` | boolean | No | Skip workflow step upgrades when existing workflow step parameters changed | @@ -592,7 +579,6 @@ Update an existing workflow in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the workflow to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `name` | string | Yes | New name for the workflow \(e.g., "Notify on Critical Incidents"\) | | `steps` | string | Yes | Complete array of workflow steps as a JSON string | @@ -644,7 +630,6 @@ Delete a workflow in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the workflow to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -665,7 +650,6 @@ List all schedules in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | | `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | @@ -711,7 +695,6 @@ Create a new schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `name` | string | Yes | Name of the schedule \(e.g., "Primary On-Call"\) | | `timezone` | string | Yes | Timezone for the schedule \(e.g., America/New_York\) | | `config` | string | Yes | Schedule configuration as JSON string with rotations. Example: \{"rotations": \[\{"name": "Primary", "users": \[\{"id": "user_id"\}\], "handover_start_at": "2024-01-01T09:00:00Z", "handovers": \[\{"interval": 1, "interval_type": "weekly"\}\]\}\]\} | @@ -739,7 +722,6 @@ Get details of a specific schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the schedule \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -781,7 +763,6 @@ Update an existing schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the schedule to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `name` | string | No | New name for the schedule \(e.g., "Primary On-Call"\) | | `timezone` | string | No | New timezone for the schedule \(e.g., America/New_York\) | @@ -810,7 +791,6 @@ Delete a schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the schedule to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -831,7 +811,6 @@ List all escalation policies in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `page_size` | number | No | Number of escalations to return per page | | `after` | string | No | Pagination cursor to fetch the next page of results | @@ -864,7 +843,6 @@ Create a new escalation policy in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `idempotency_key` | string | Yes | Unique identifier to prevent duplicate escalation creation. Use a UUID or unique string. | | `title` | string | Yes | Title of the escalation \(e.g., "Database Critical Alert"\) | | `escalation_path_id` | string | No | ID of the escalation path to use \(required if user_ids not provided\) | @@ -896,7 +874,6 @@ Get details of a specific escalation policy in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the escalation policy \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -925,7 +902,6 @@ List all custom fields from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | #### Output @@ -951,7 +927,6 @@ Create a new custom field in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `name` | string | Yes | Name of the custom field \(e.g., "Affected Service"\) | | `description` | string | Yes | Description of the custom field \(required\) | | `field_type` | string | Yes | Type of the custom field: text, link, numeric, single_select, or multi_select | @@ -980,7 +955,6 @@ Get detailed information about a specific custom field from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1007,7 +981,6 @@ Update an existing custom field in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `name` | string | Yes | New name for the custom field \(e.g., "Affected Service"\) | | `description` | string | Yes | New description for the custom field \(required\) | @@ -1036,7 +1009,6 @@ Delete a custom field from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1057,7 +1029,6 @@ List all severity levels configured in your Incident.io workspace. Returns sever | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Incident.io API Key | #### Output @@ -1081,7 +1052,6 @@ List all incident statuses configured in your Incident.io workspace. Returns sta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Incident.io API Key | #### Output @@ -1105,7 +1075,6 @@ List all incident types configured in your Incident.io workspace. Returns type d | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Incident.io API Key | #### Output @@ -1129,7 +1098,6 @@ List all incident roles in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | #### Output @@ -1158,7 +1126,6 @@ Create a new incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `name` | string | Yes | Name of the incident role \(e.g., "Incident Commander"\) | | `description` | string | Yes | Description of the incident role | | `instructions` | string | Yes | Instructions for the incident role | @@ -1191,7 +1158,6 @@ Get details of a specific incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the incident role \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1221,7 +1187,6 @@ Update an existing incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the incident role to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `name` | string | Yes | Name of the incident role \(e.g., "Incident Commander"\) | | `description` | string | Yes | Description of the incident role | @@ -1255,7 +1220,6 @@ Delete an incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the incident role to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1276,7 +1240,6 @@ List all incident timestamp definitions in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | #### Output @@ -1301,7 +1264,6 @@ Get details of a specific incident timestamp definition in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the incident timestamp \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1327,7 +1289,6 @@ List all updates for a specific incident in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | No | The ID of the incident to get updates for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\). If not provided, returns all updates | | `page_size` | number | No | Number of results to return per page \(e.g., 10, 25, 50\) | | `after` | string | No | Cursor for pagination \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | @@ -1380,7 +1341,6 @@ List all entries for a specific schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `schedule_id` | string | Yes | The ID of the schedule to get entries for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `entry_window_start` | string | No | Start date/time to filter entries in ISO 8601 format \(e.g., "2024-01-15T09:00:00Z"\) | | `entry_window_end` | string | No | End date/time to filter entries in ISO 8601 format \(e.g., "2024-01-22T09:00:00Z"\) | @@ -1409,7 +1369,6 @@ Create a new schedule override in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `rotation_id` | string | Yes | The ID of the rotation to override \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `layer_id` | string | Yes | The ID of the layer this override applies to | | `schedule_id` | string | Yes | The ID of the schedule \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | @@ -1449,7 +1408,6 @@ List escalation paths in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `page_size` | number | No | Number of escalation paths to return per page | | `after` | string | No | Pagination cursor to fetch the next page of results | @@ -1478,7 +1436,6 @@ Create a new escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `name` | string | Yes | Name of the escalation path \(e.g., "Critical Incident Path"\) | | `path` | json | Yes | Array of escalation levels with targets and time to acknowledge in seconds. Each level should have: targets \(array of \{id, type, schedule_id?, user_id?, urgency\}\) and time_to_ack_seconds \(number\) | | `working_hours` | json | No | Optional working hours configuration. Array of \{weekday, start_time, end_time\} | @@ -1515,7 +1472,6 @@ Get details of a specific escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the escalation path \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1550,7 +1506,6 @@ Update an existing escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the escalation path to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `name` | string | Yes | New name for the escalation path \(e.g., "Critical Incident Path"\) | | `path` | json | Yes | New escalation path configuration. Array of escalation levels with targets and time_to_ack_seconds | @@ -1588,7 +1543,6 @@ Delete an escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the escalation path to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1609,7 +1563,6 @@ Get who is currently on call in incident.io, as one row per ongoing shift across | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `schedule_id` | string | No | Limit the result to a single schedule by ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\). Leave empty to return who is on call across every schedule. | | `page_size` | number | No | Number of schedules to scan per page when no schedule ID is given \(e.g., 10, 25\). Defaults to 25; upcoming shifts are only returned at 25 or lower. | | `after` | string | No | Pagination cursor to fetch the next page of schedules \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | @@ -1637,7 +1590,6 @@ List the one-off overrides layered on top of a schedule in incident.io, such as | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `schedule_id` | string | Yes | The ID of the schedule to get overrides for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `rotation_id` | string | No | Only return overrides on this rotation | | `layer_id` | string | No | Only return overrides on this layer | @@ -1679,7 +1631,6 @@ List alerts in incident.io, optionally filtered by status, source, or created da | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | | `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `status` | string | No | Filter by alert status: "firing" or "resolved" | @@ -1725,7 +1676,6 @@ Get a single alert by ID from incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the alert to fetch \(e.g., "01GW2G3V0S59R238FAHPDS1R66"\) | #### Output @@ -1758,7 +1708,6 @@ Resolve a currently firing alert in incident.io. Resolving an already-resolved a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the alert to resolve \(e.g., "01GW2G3V0S59R238FAHPDS1R66"\) | #### Output @@ -1820,7 +1769,6 @@ List the connections between incidents and alerts in incident.io — which alert | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | | `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_id` | string | No | Only return alerts attached to this incident \(e.g., "01FDAG4SAP5TYPT98WGR2N7W91"\) | @@ -1868,7 +1816,6 @@ Cancel an escalation in incident.io. Notifications stop, and the escalation will | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the escalation to cancel \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1889,7 +1836,6 @@ List all catalog types in incident.io, including those synced from external reso | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | #### Output @@ -1931,7 +1877,6 @@ List the entries of a catalog type in incident.io — for example every service, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `catalog_type_id` | string | Yes | The ID of the catalog type to list entries for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | | `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | @@ -1992,7 +1937,6 @@ List all teams in the incident.io organisation, along with their members | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\) | | `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | @@ -2028,7 +1972,6 @@ Get a single team by ID from incident.io, along with its members | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the team to fetch \(e.g., "01JPQA75EPNEES4479P16P4XAB"\) | #### Output @@ -2060,7 +2003,6 @@ Create a new follow-up on an incident in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | Yes | The ID of the incident the follow-up belongs to \(e.g., "01FDAG4SAP5TYPT98WGR2N7W91"\) | | `title` | string | Yes | Title of the follow-up \(e.g., "Add alerting on connection pool saturation"\) | | `description` | string | No | Description of the follow-up. Supports Markdown. | @@ -2132,7 +2074,6 @@ Update an existing follow-up in incident.io, for example to mark it completed or | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the follow-up to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `title` | string | Yes | Title of the follow-up. This endpoint replaces the title, so always send it. | | `status` | string | Yes | Status of the follow-up: "outstanding", "completed", or "not_doing". Deleting is not supported here. | @@ -2204,7 +2145,6 @@ Create a new action on an incident in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | Yes | The ID of the incident the action belongs to \(e.g., "01FDAG4SAP5TYPT98WGR2N7W91"\) | | `description` | string | Yes | Description of the action. Supports Markdown. | | `assignee_id` | string | No | ID of the user to assign this action to | @@ -2260,7 +2200,6 @@ Update an existing action in incident.io, for example to mark it completed or re | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `id` | string | Yes | The ID of the action to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `description` | string | Yes | Description of the action. This endpoint replaces the description, so always send it. | | `status` | string | Yes | Status of the action: "outstanding", "completed", or "not_doing". Deleting is not supported here. | @@ -2317,7 +2256,6 @@ List the participants of an incident in incident.io, split into those actively h | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | Yes | The ID of the incident to find participants of \(e.g., "01FDAG4SAP5TYPT98WGR2N7W91"\) | #### Output @@ -2339,7 +2277,6 @@ Make a user a member of a private incident in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | Yes | The ID of the private incident \(e.g., "01FCNDV6P870EA6S7TK1DSYD5H"\) | | `user_id` | string | Yes | The ID of the user to grant access to \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | @@ -2371,7 +2308,6 @@ Revoke a user's membership of a private incident in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | incident.io API Key | | `incident_id` | string | Yes | The ID of the private incident \(e.g., "01FCNDV6P870EA6S7TK1DSYD5H"\) | | `user_id` | string | Yes | The ID of the user to revoke access from \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | diff --git a/apps/docs/content/docs/integrations/instantly.mdx b/apps/docs/content/docs/integrations/instantly.mdx index f1791cc0802..f04114e0b84 100644 --- a/apps/docs/content/docs/integrations/instantly.mdx +++ b/apps/docs/content/docs/integrations/instantly.mdx @@ -2,7 +2,7 @@ title: Instantly description: Manage Instantly leads, campaigns, emails, and lead lists integration: - type: "instantly" + type: "instantly_v2" color: "#FFFFFF" --- @@ -31,7 +31,6 @@ Retrieves Instantly V2 leads with search, campaign, list, and pagination filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `search` | string | No | Search by first name, last name, or email | | `filter` | string | No | Instantly lead filter value, such as FILTER_VAL_CONTACTED or FILTER_VAL_ACTIVE | | `campaign` | string | No | Campaign ID to filter leads | @@ -86,7 +85,6 @@ Retrieves an Instantly V2 lead by ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `leadId` | string | Yes | Lead ID | #### Output @@ -125,7 +123,6 @@ Creates an Instantly V2 lead in a campaign or lead list. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `campaign` | string | No | Campaign ID associated with the lead | | `list_id` | string | No | Lead list ID associated with the lead | | `email` | string | No | Lead email address. Required when adding to a campaign. | @@ -183,7 +180,6 @@ Updates fields on an existing Instantly V2 lead. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `leadId` | string | Yes | Lead ID | | `first_name` | string | No | Lead first name | | `last_name` | string | No | Lead last name | @@ -233,7 +229,6 @@ Deletes Instantly V2 leads in bulk from a campaign or lead list. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `campaign_id` | string | No | Campaign ID to delete leads from. Required if list_id is not provided. | | `list_id` | string | No | Lead list ID to delete leads from. Required if campaign_id is not provided. | | `status` | number | No | Optional lead status filter | @@ -258,7 +253,6 @@ Submits an Instantly V2 background job to update a lead interest status. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `lead_email` | string | Yes | Lead email address | | `interest_value` | number | No | Interest status value. Leave empty in the block or pass null to reset to Lead. | | `campaign_id` | string | No | Campaign ID for the lead | @@ -284,7 +278,6 @@ Retrieves Instantly V2 campaigns with search, status, tag, and pagination filter | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `limit` | number | No | Number of campaigns to return, from 1 to 100 | | `starting_after` | string | No | Pagination cursor from next_starting_after | | `search` | string | No | Search by campaign name | @@ -328,7 +321,6 @@ Creates an Instantly V2 campaign using the documented campaign schedule schema. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `name` | string | Yes | Campaign name | | `campaign_schedule` | json | Yes | Campaign schedule object with schedules array | | `sequences` | array | No | Campaign sequence definitions | @@ -378,7 +370,6 @@ Updates documented Instantly V2 campaign fields. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `campaignId` | string | Yes | Campaign ID | | `name` | string | No | Campaign name | | `campaign_schedule` | json | No | Campaign schedule object with schedules array | @@ -429,7 +420,6 @@ Activates, starts, or resumes an Instantly V2 campaign. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `campaignId` | string | Yes | Campaign ID | #### Output @@ -468,7 +458,6 @@ Pauses a running Instantly V2 campaign, stopping further email sends. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `campaignId` | string | Yes | Campaign ID | #### Output @@ -507,7 +496,6 @@ Permanently deletes an Instantly V2 campaign. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `campaignId` | string | Yes | Campaign ID | #### Output @@ -546,7 +534,6 @@ Retrieves Instantly V2 Unibox emails with search and pagination filters. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `limit` | number | No | Number of emails to return, from 1 to 100 | | `starting_after` | string | No | Pagination cursor from next_starting_after | | `search` | string | No | Search query, email address, or thread:<thread-id> | @@ -593,7 +580,6 @@ Sends an Instantly V2 reply to an existing Unibox email. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `eaccount` | string | Yes | Connected email account used to send the reply | | `reply_to_uuid` | string | Yes | Email ID to reply to | | `subject` | string | Yes | Reply subject | @@ -637,7 +623,6 @@ Retrieves Instantly V2 lead lists with search and pagination filters. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `limit` | number | No | Number of lead lists to return, from 1 to 100 | | `starting_after` | string | No | Starting-after timestamp cursor | | `has_enrichment_task` | boolean | No | Filter by enrichment task setting | @@ -679,7 +664,6 @@ Creates an Instantly V2 lead list. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Instantly API key with the required V2 scopes | | `name` | string | Yes | Lead list name | | `has_enrichment_task` | boolean | No | Whether this list runs enrichment for every added lead | | `owned_by` | string | No | User ID of the lead list owner | diff --git a/apps/docs/content/docs/integrations/intercom.mdx b/apps/docs/content/docs/integrations/intercom.mdx index a5aeb158d97..44c2884ee57 100644 --- a/apps/docs/content/docs/integrations/intercom.mdx +++ b/apps/docs/content/docs/integrations/intercom.mdx @@ -2,7 +2,7 @@ title: Intercom description: Manage contacts, companies, conversations, tickets, and messages in Intercom integration: - type: "intercom_v2" + type: "intercom_v3" color: "#FFFFFF" --- diff --git a/apps/docs/content/docs/integrations/lambda.mdx b/apps/docs/content/docs/integrations/lambda.mdx index d66bbe257ab..bce1356987f 100644 --- a/apps/docs/content/docs/integrations/lambda.mdx +++ b/apps/docs/content/docs/integrations/lambda.mdx @@ -2,7 +2,7 @@ title: Lambda description: Invoke, deploy, and manage AWS Lambda functions integration: - type: "lambda" + type: "lambda_v2" color: "linear-gradient(45deg, #C8511B 0%, #FF9900 100%)" --- @@ -26,7 +26,7 @@ With the Lambda integration, you can: ## Credentials and permissions -The block authenticates with an AWS access key ID and secret access key scoped to a region. Grant the IAM principal only the Lambda actions the operations you use require — for example `lambda:InvokeFunction` for invocation, `lambda:GetFunction` and `lambda:ListFunctions` for read-only inventory, or `lambda:UpdateFunctionCode` and `lambda:PublishVersion` for deployments. +The block signs in with a saved [AWS credential](/integrations/aws-credentials) and runs in the region you set. Grant the IAM principal only the Lambda actions the operations you use require — for example `lambda:InvokeFunction` for invocation, `lambda:GetFunction` and `lambda:ListFunctions` for read-only inventory, or `lambda:UpdateFunctionCode` and `lambda:PublishVersion` for deployments. ## Deployment packages @@ -37,7 +37,7 @@ Use CloudWatch for function logs and metrics, S3 for deployment archives, and SQ ## Use the block [#usage-instructions] -Invoke functions and read their response payload, create and update functions from Amazon S3 packages or container images, publish versions and aliases, wire up event source mappings, manage concurrency, function URLs, layers, permissions, and tags. Requires an AWS access key and secret access key. +Invoke functions and read their response payload, create and update functions from Amazon S3 packages or container images, publish versions and aliases, wire up event source mappings, manage concurrency, function URLs, layers, permissions, and tags. ## Actions @@ -52,8 +52,6 @@ Invoke a Lambda function synchronously for its response payload, asynchronously | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `payload` | json | No | JSON event payload passed to the function handler | | `invocationType` | string | No | RequestResponse waits for the result, Event queues the invocation, DryRun only validates permissions | @@ -84,8 +82,6 @@ List Lambda functions with the version-specific configuration of each | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionVersion` | string | No | Set to ALL to include every published version of each function | | `masterRegion` | string | No | For Lambda@Edge functions, the region of the master function. Requires functionVersion ALL | | `marker` | string | No | Pagination token returned by a previous request | @@ -111,8 +107,6 @@ Get a function's configuration, code location, tags, and reserved concurrency | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -139,8 +133,6 @@ Get a function's version-specific configuration | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -163,8 +155,6 @@ Create a Lambda function from a deployment package in Amazon S3 or a container i | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `role` | string | Yes | ARN of the function's execution role | | `runtime` | string | No | Runtime identifier such as nodejs22.x or python3.13. Required for .zip packages, omit for container images | @@ -212,8 +202,6 @@ Update a function's deployment package from Amazon S3 or a container image | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `s3Bucket` | string | No | Amazon S3 bucket holding the new deployment package, in the same region as the function | | `s3Key` | string | No | Amazon S3 key of the .zip package | @@ -244,8 +232,6 @@ Update a function's settings such as memory, timeout, role, and environment vari | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `role` | string | No | ARN of the function's execution role | | `runtime` | string | No | Runtime identifier such as nodejs22.x or python3.13 | @@ -285,8 +271,6 @@ Delete a Lambda function, or a single published version of it | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number to delete. Omit to delete the whole function including all versions and aliases | @@ -309,8 +293,6 @@ Publish an immutable version from the current code and configuration of a functi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `codeSha256` | string | No | Publish only if the SHA256 hash of the deployment package matches this value | | `description` | string | No | Description of the version | @@ -335,8 +317,6 @@ List the published versions of a Lambda function, plus $LATEST | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `marker` | string | No | Pagination token returned by a previous request | | `maxItems` | number | No | Maximum number of items to return \(1-10000\) | @@ -361,8 +341,6 @@ Create an alias that points to a published function version | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `aliasName` | string | Yes | Name of the alias, such as prod or staging | | `aliasFunctionVersion` | string | Yes | Function version the alias points to | @@ -388,8 +366,6 @@ Get details about a Lambda function alias | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `aliasName` | string | Yes | Name of the alias | @@ -412,8 +388,6 @@ Update the target version, description, or traffic weights of an alias | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `aliasName` | string | Yes | Name of the alias | | `aliasFunctionVersion` | string | No | Function version the alias should point to | @@ -440,8 +414,6 @@ Delete a Lambda function alias | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `aliasName` | string | Yes | Name of the alias | @@ -464,8 +436,6 @@ List the aliases of a Lambda function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `aliasFunctionVersion` | string | No | Return only aliases that point to this function version | | `marker` | string | No | Pagination token returned by a previous request | @@ -491,8 +461,6 @@ Grant an AWS service, account, or organization permission to use a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `statementId` | string | Yes | Unique identifier for the policy statement \(letters, numbers, hyphens, and underscores\) | | `action` | string | Yes | Action the principal is granted, such as lambda:InvokeFunction | @@ -524,8 +492,6 @@ Remove a statement from a function's resource-based policy | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `statementId` | string | Yes | Identifier of the policy statement to remove | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -550,8 +516,6 @@ Get the resource-based IAM policy attached to a function, version, or alias | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -575,8 +539,6 @@ Map an event source such as SQS, Kinesis, DynamoDB Streams, or Kafka to a functi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `eventSourceArn` | string | No | ARN of the event source. Omit only for self-managed Kafka | | `enabled` | boolean | No | Whether the mapping is active | @@ -625,8 +587,6 @@ Get details about an event source mapping | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `uuid` | string | Yes | Identifier of the event source mapping | #### Output @@ -648,8 +608,6 @@ Update the batching, retry, filtering, or enabled state of an event source mappi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `uuid` | string | Yes | Identifier of the event source mapping | | `functionName` | string | No | Function the mapping should invoke | | `enabled` | boolean | No | Whether the mapping is active | @@ -692,8 +650,6 @@ Delete an event source mapping | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `uuid` | string | Yes | Identifier of the event source mapping | #### Output @@ -715,8 +671,6 @@ List event source mappings, optionally filtered by function or event source | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | No | Return only mappings that invoke this function | | `eventSourceArn` | string | No | Return only mappings for this event source ARN | | `marker` | string | No | Pagination token returned by a previous request | @@ -742,8 +696,6 @@ Get the reserved concurrency configured for a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | #### Output @@ -765,8 +717,6 @@ Reserve a share of the account concurrency limit for a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `reservedConcurrentExecutions` | number | Yes | Number of simultaneous executions to reserve for this function | @@ -789,8 +739,6 @@ Remove the reserved concurrency configuration from a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | #### Output @@ -812,8 +760,6 @@ Get the provisioned concurrency configuration of a function version or alias | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | Yes | Version number or alias name the configuration applies to | @@ -836,8 +782,6 @@ Allocate provisioned concurrency to a function version or alias | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | Yes | Version number or alias name the configuration applies to | | `provisionedConcurrentExecutions` | number | Yes | Number of pre-initialized execution environments to allocate | @@ -861,8 +805,6 @@ Remove the provisioned concurrency configuration from a function version or alia | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | Yes | Version number or alias name the configuration applies to | @@ -885,8 +827,6 @@ List the provisioned concurrency configurations of a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `marker` | string | No | Pagination token returned by a previous request | | `maxItems` | number | No | Maximum number of items to return \(1-50\) | @@ -911,8 +851,6 @@ Create a dedicated HTTPS endpoint for a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `authType` | string | Yes | AWS_IAM requires signed requests, NONE allows public unauthenticated access | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -943,8 +881,6 @@ Get details about a function URL | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -967,8 +903,6 @@ Update the auth type, invoke mode, or CORS settings of a function URL | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `authType` | string | No | AWS_IAM requires signed requests, NONE allows public unauthenticated access | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -999,8 +933,6 @@ Delete the URL configuration of a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -1023,8 +955,6 @@ List the URL configurations of a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `marker` | string | No | Pagination token returned by a previous request | | `maxItems` | number | No | Maximum number of items to return \(1-50\) | @@ -1049,8 +979,6 @@ Get the asynchronous invocation retry and destination settings of a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -1073,8 +1001,6 @@ Configure retry limits and destinations for asynchronous invocations of a functi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | | `maximumRetryAttempts` | number | No | Times Lambda retries a failed asynchronous invocation \(0-2\) | @@ -1101,8 +1027,6 @@ Remove the asynchronous invocation configuration of a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -1125,8 +1049,6 @@ List the asynchronous invocation configurations of a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `marker` | string | No | Pagination token returned by a previous request | | `maxItems` | number | No | Maximum number of items to return \(1-50\) | @@ -1151,8 +1073,6 @@ List Lambda layers and the latest version of each | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `compatibleRuntime` | string | No | Return only layers compatible with this runtime, such as python3.13 | | `compatibleArchitecture` | string | No | Return only layers compatible with this instruction set architecture | | `marker` | string | No | Pagination token returned by a previous request | @@ -1178,8 +1098,6 @@ List the versions of a Lambda layer | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `layerName` | string | Yes | The name or ARN of the layer | | `compatibleRuntime` | string | No | Return only versions compatible with this runtime, such as python3.13 | | `compatibleArchitecture` | string | No | Return only versions compatible with this instruction set architecture | @@ -1206,8 +1124,6 @@ Get details and a download link for a specific layer version | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `layerName` | string | Yes | The name or ARN of the layer | | `versionNumber` | number | Yes | Version number of the layer | @@ -1230,8 +1146,6 @@ List the tags applied to a Lambda function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | The function's Amazon Resource Name \(ARN\) | #### Output @@ -1253,8 +1167,6 @@ Add tags to a Lambda function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | The function's Amazon Resource Name \(ARN\) | | `tags` | json | Yes | Tags to apply, as a flat key/value JSON object | @@ -1277,8 +1189,6 @@ Remove tags from a Lambda function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | The function's Amazon Resource Name \(ARN\) | | `tagKeys` | array | Yes | Tag keys to remove | @@ -1301,8 +1211,6 @@ Get the Lambda limits and usage of the current AWS account and region | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | #### Output @@ -1324,8 +1232,6 @@ Get the recursive loop detection setting of a function | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | #### Output @@ -1347,8 +1253,6 @@ Set whether Lambda stops a function that invokes itself recursively | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `recursiveLoop` | string | Yes | Terminate stops the function after 16 recursive invocations, Allow permits recursion | @@ -1371,8 +1275,6 @@ Get the runtime update policy of a function version | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `qualifier` | string | No | Version number or alias name to act on. Omit to target the function itself | @@ -1397,8 +1299,6 @@ Set how and when Lambda applies runtime updates to a function version | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `awsRegion` | string | Yes | AWS region \(e.g., us-east-1\) | -| `awsAccessKeyId` | string | Yes | AWS access key ID | -| `awsSecretAccessKey` | string | Yes | AWS secret access key | | `functionName` | string | Yes | Function name, ARN, or partial ARN \(e.g. my-function, or arn:aws:lambda:us-east-1:123456789012:function:my-function\) | | `updateRuntimeOn` | string | Yes | Auto applies updates automatically, FunctionUpdate applies them on the next function update, Manual pins a runtime version | | `runtimeVersionArn` | string | No | ARN of the runtime version to pin to. Required when updateRuntimeOn is Manual | diff --git a/apps/docs/content/docs/integrations/langsmith.mdx b/apps/docs/content/docs/integrations/langsmith.mdx index 9424423025c..70f961cf5fa 100644 --- a/apps/docs/content/docs/integrations/langsmith.mdx +++ b/apps/docs/content/docs/integrations/langsmith.mdx @@ -2,7 +2,7 @@ title: LangSmith description: Forward workflow runs to LangSmith for observability integration: - type: "langsmith" + type: "langsmith_v2" color: "#181C1E" --- @@ -29,7 +29,6 @@ Forward a single run to LangSmith for ingestion. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LangSmith API key | | `id` | string | No | Unique run identifier | | `name` | string | Yes | Run name | | `run_type` | string | Yes | Run type \(tool, chain, llm, retriever, embedding, prompt, parser\) | @@ -68,7 +67,6 @@ Forward multiple runs to LangSmith in a single batch. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LangSmith API key | | `post` | json | No | Array of new runs to ingest | | `patch` | json | No | Array of runs to update/patch | @@ -93,7 +91,6 @@ Patch an existing LangSmith run with outputs, status, or timing once it complete | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LangSmith API key | | `runId` | string | Yes | ID of the run to update | | `name` | string | No | Corrected run name | | `end_time` | string | No | Run end time in ISO-8601 format | @@ -120,7 +117,6 @@ Retrieve a single LangSmith run by ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LangSmith API key | | `runId` | string | Yes | ID of the run to retrieve | #### Output @@ -156,7 +152,6 @@ Attach a score, correction, or comment to a LangSmith run. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LangSmith API key | | `runId` | string | Yes | ID of the run to attach feedback to | | `key` | string | Yes | Feedback metric name \(e.g. "correctness", "user_score"\) | | `score` | number | No | Numeric score for the feedback metric | diff --git a/apps/docs/content/docs/integrations/launchdarkly.mdx b/apps/docs/content/docs/integrations/launchdarkly.mdx index d7445234528..8351557e2a4 100644 --- a/apps/docs/content/docs/integrations/launchdarkly.mdx +++ b/apps/docs/content/docs/integrations/launchdarkly.mdx @@ -2,7 +2,7 @@ title: LaunchDarkly description: Manage feature flags with LaunchDarkly integration: - type: "launchdarkly" + type: "launchdarkly_v2" color: "#191919" --- @@ -21,7 +21,7 @@ Create a personal access token or service token under **Organization settings > ## Use the block [#usage-instructions] -List, create, update, toggle, and delete feature flags. Read projects, environments, segments, members, and audit logs. Requires an API key. +List, create, update, toggle, and delete feature flags. Read projects, environments, segments, members, and audit logs. ## Actions @@ -35,7 +35,6 @@ Create a new feature flag in a LaunchDarkly project. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key to create the flag in | | `name` | string | Yes | Human-readable name for the feature flag | | `key` | string | Yes | Unique key for the feature flag \(used in code\) | @@ -75,7 +74,6 @@ Delete a feature flag from a LaunchDarkly project. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key | | `flagKey` | string | Yes | The feature flag key to delete | @@ -97,7 +95,6 @@ List audit log entries from your LaunchDarkly account. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `limit` | number | No | Maximum number of entries to return \(default 10, max 20\) | | `spec` | string | No | Resource specifier filter \(e.g. "proj/*:env/*:flag/*" for all flag changes, or "proj/default:env/production:flag/my-flag" for one flag in one environment\) | @@ -129,7 +126,6 @@ Get a single feature flag by key from a LaunchDarkly project. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key | | `flagKey` | string | Yes | The feature flag key | | `environmentKey` | string | No | Filter flag configuration to a specific environment | @@ -167,7 +163,6 @@ Get the status of a feature flag across environments (active, inactive, launched | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key | | `flagKey` | string | Yes | The feature flag key | | `environmentKey` | string | Yes | The environment key | @@ -192,7 +187,6 @@ List environments in a LaunchDarkly project. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key to list environments for | | `limit` | number | No | Maximum number of environments to return \(default 20\) | @@ -222,7 +216,6 @@ List feature flags in a LaunchDarkly project. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key to list flags for | | `environmentKey` | string | No | Filter flag configurations to a specific environment | | `tag` | string | No | Filter flags by tag name | @@ -262,7 +255,6 @@ List account members in your LaunchDarkly organization. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `limit` | number | No | Maximum number of members to return \(default 20\) | #### Output @@ -292,7 +284,6 @@ List all projects in your LaunchDarkly account. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `limit` | number | No | Maximum number of projects to return \(default 20\) | #### Output @@ -318,7 +309,6 @@ List user segments in a LaunchDarkly project and environment. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key | | `environmentKey` | string | Yes | The environment key | | `limit` | number | No | Maximum number of segments to return \(default 20\) | @@ -350,7 +340,6 @@ Toggle a feature flag on or off in a specific LaunchDarkly environment. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key | | `flagKey` | string | Yes | The feature flag key to toggle | | `environmentKey` | string | Yes | The environment key to toggle the flag in | @@ -389,7 +378,6 @@ Update feature flag metadata (name, description, tags, temporary, archived) usin | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | LaunchDarkly API key | | `projectKey` | string | Yes | The project key | | `flagKey` | string | Yes | The feature flag key to update | | `updateName` | string | No | New name for the flag | diff --git a/apps/docs/content/docs/integrations/linq.mdx b/apps/docs/content/docs/integrations/linq.mdx index e47fbd52339..2290e2ec39f 100644 --- a/apps/docs/content/docs/integrations/linq.mdx +++ b/apps/docs/content/docs/integrations/linq.mdx @@ -2,7 +2,7 @@ title: Linq description: Send iMessage, SMS, and RCS messages and manage conversations with Linq integration: - type: "linq" + type: "linq_v2" color: "#000000" --- @@ -19,7 +19,7 @@ Check iMessage or RCS capability before selecting a preferred service. Upload at ## Use the block [#usage-instructions] -Reach people on iMessage, SMS, and RCS through Linq. Start chats, send messages with media, links, effects, and replies, send voice memos, react with tapbacks, manage group participants, check iMessage/RCS capability, configure contact cards, and subscribe to webhook events — all through a single Linq API key. +Reach people on iMessage, SMS, and RCS through Linq. Start chats, send messages with media, links, effects, and replies, send voice memos, react with tapbacks, manage group participants, check iMessage/RCS capability, configure contact cards, and subscribe to webhook events. ## Actions @@ -33,7 +33,6 @@ Add a participant to a group chat (3+ existing participants) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the group chat | | `handle` | string | Yes | Phone number \(E.164 format\) or email address of the participant to add | @@ -57,7 +56,6 @@ Check whether an address (phone number or email) supports iMessage | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `address` | string | Yes | Phone number \(E.164 format\) or email address to check | | `from` | string | No | Sender phone number to check from \(defaults to an available number\) | @@ -80,7 +78,6 @@ Check whether an address (phone number or email) supports RCS | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `address` | string | Yes | Phone number \(E.164 format\) to check | | `from` | string | No | Sender phone number to check from \(defaults to an available number\) | @@ -103,7 +100,6 @@ Upload a file to Linq as a reusable attachment (max 100MB) and get an attachment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `file` | file | No | File to upload \(a UserFile from a file-upload field or a previous block\) | | `filename` | string | No | Override the file name \(defaults to the uploaded file name\) | | `contentType` | string | No | Override the MIME type \(defaults to the uploaded file type\) | @@ -131,7 +127,6 @@ Start a new iMessage, SMS, or RCS chat and send the first message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `from` | string | Yes | Sender phone number in E.164 format \(e.g. +14155551234\) | | `to` | array | Yes | Recipient handles \(phone numbers in E.164 format or email addresses\) | | `text` | string | No | Text content of the first message. Optional, but at least one of text, media, attachment, or link is required | @@ -168,7 +163,6 @@ Set up a contact card (Name and Photo Sharing) for a phone number | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `phoneNumber` | string | Yes | Phone number in E.164 format the card applies to | | `firstName` | string | Yes | First name to display | | `lastName` | string | No | Last name to display | @@ -196,7 +190,6 @@ Subscribe an HTTPS endpoint to Linq webhook events | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `targetUrl` | string | Yes | HTTPS endpoint that will receive webhook events | | `subscribedEvents` | array | Yes | Event types to subscribe to \(e.g. message.sent, message.delivered\) | | `phoneNumbers` | array | No | E.164 phone numbers to filter events by \(omit for all numbers\) | @@ -226,7 +219,6 @@ Permanently delete an attachment owned by your account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `attachmentId` | string | Yes | The unique identifier of the attachment to delete | #### Output @@ -247,7 +239,6 @@ Delete a message from the Linq API only (does not unsend it; recipients still se | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `messageId` | string | Yes | The unique identifier of the message to delete | #### Output @@ -268,7 +259,6 @@ Delete a webhook subscription from your account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `subscriptionId` | string | Yes | The unique identifier of the webhook subscription to delete | #### Output @@ -289,7 +279,6 @@ Edit the text of a sent message (up to 5 times, within 15 minutes of sending; iM | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `messageId` | string | Yes | The unique identifier of the message to edit | | `text` | string | Yes | New text content for the message part | | `partIndex` | number | No | Index of the message part to edit \(defaults to 0\) | @@ -323,7 +312,6 @@ Retrieve metadata for an attachment, including its download URL and status | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `attachmentId` | string | Yes | The unique identifier of the attachment | #### Output @@ -350,7 +338,6 @@ Retrieve a chat by ID, including participants and line health | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | #### Output @@ -379,7 +366,6 @@ Retrieve contact cards, optionally filtered by phone number | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `phoneNumber` | string | No | E.164 phone number to filter by \(omit to return all cards\) | #### Output @@ -405,7 +391,6 @@ Retrieve a single message by ID, including parts, reactions, and delivery status | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `messageId` | string | Yes | The unique identifier of the message | #### Output @@ -437,7 +422,6 @@ Retrieve a webhook subscription by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `subscriptionId` | string | Yes | The unique identifier of the webhook subscription | #### Output @@ -464,7 +448,6 @@ Leave an iMessage group chat (4+ active participants; not supported for direct c | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the group chat | #### Output @@ -487,7 +470,6 @@ List chats, optionally filtered by sender or participant handle | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `from` | string | No | Filter by sender phone number in E.164 format | | `to` | string | No | Filter by participant handle \(phone number or email\) | | `limit` | number | No | Results per page \(default 20, max 100\) | @@ -512,7 +494,6 @@ List messages in a chat with pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | | `limit` | number | No | Maximum number of messages to return | | `cursor` | string | No | Pagination cursor from a previous response | @@ -536,7 +517,6 @@ List all phone numbers assigned to your partner account, with line health | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | #### Output @@ -560,7 +540,6 @@ List all messages in the thread that contains a given message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `messageId` | string | Yes | The ID of any message in the thread | | `order` | string | No | Sort order: asc \(oldest first\) or desc \(newest first\) | | `limit` | number | No | Maximum number of messages to return | @@ -585,7 +564,6 @@ List all webhook event types available to subscribe to | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | #### Output @@ -606,7 +584,6 @@ List all webhook subscriptions on your account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | #### Output @@ -633,7 +610,6 @@ Mark messages in a chat as read (only applies to 1:1 iMessage/RCS; no effect on | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | #### Output @@ -654,7 +630,6 @@ Add or remove a tapback reaction on a message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `messageId` | string | Yes | The unique identifier of the message to react to | | `operation` | string | Yes | Whether to add or remove the reaction: add or remove | | `type` | string | Yes | Reaction type: love, like, dislike, laugh, emphasize, question, custom, or sticker | @@ -681,7 +656,6 @@ Remove a participant from a group chat (minimum 3 participants must remain) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the group chat | | `handle` | string | Yes | Phone number \(E.164 format\) or email address of the participant to remove | @@ -705,7 +679,6 @@ Send a message to an existing chat, with optional media, link, effect, or reply | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | | `text` | string | No | Text content of the message. Optional, but at least one of text, media, attachment, or link is required | | `mediaUrl` | string | No | Optional publicly accessible HTTPS URL of an image, video, or file to attach | @@ -741,7 +714,6 @@ Send a voice memo to a chat from a URL or a pre-uploaded attachment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | | `voiceMemoUrl` | string | No | Publicly accessible HTTPS URL of the audio file \(MP3, M4A, AAC, CAF, WAV, AIFF, AMR\) | | `attachmentId` | string | No | ID of a pre-uploaded audio attachment \(use instead of voiceMemoUrl\) | @@ -769,7 +741,6 @@ Share your configured contact card (Name and Photo Sharing) with a chat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | #### Output @@ -790,7 +761,6 @@ Show a typing indicator in a one-on-one chat (iMessage only, not group chats) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | #### Output @@ -811,7 +781,6 @@ Stop the typing indicator in a one-on-one chat (iMessage only, not group chats) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | #### Output @@ -832,7 +801,6 @@ Update chat properties such as group display name and icon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `chatId` | string | Yes | The unique identifier of the chat | | `displayName` | string | No | New display name for the group chat | | `groupChatIcon` | string | No | New group chat icon \(publicly accessible image URL\) | @@ -856,7 +824,6 @@ Partially update an existing active contact card for a phone number | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `phoneNumber` | string | Yes | Phone number in E.164 format identifying the card to update | | `firstName` | string | No | New first name | | `lastName` | string | No | New last name | @@ -884,7 +851,6 @@ Update a webhook subscription (target URL, events, phone filter, or active state | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Linq API key | | `subscriptionId` | string | Yes | The unique identifier of the webhook subscription | | `targetUrl` | string | No | New HTTPS endpoint that will receive events | | `subscribedEvents` | array | No | New set of event types to subscribe to | diff --git a/apps/docs/content/docs/integrations/loops.mdx b/apps/docs/content/docs/integrations/loops.mdx index bb6ddc19b55..45c5c9cc551 100644 --- a/apps/docs/content/docs/integrations/loops.mdx +++ b/apps/docs/content/docs/integrations/loops.mdx @@ -2,7 +2,7 @@ title: Loops description: Manage contacts and send emails with Loops integration: - type: "loops" + type: "loops_v2" color: "#FAFAF9" --- @@ -29,7 +29,6 @@ Create a new contact in your Loops audience with an email address and optional p | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | Yes | The email address for the new contact | | `firstName` | string | No | The contact first name | | `lastName` | string | No | The contact last name | @@ -59,7 +58,6 @@ Update an existing contact in Loops by email or userId. Creates a new contact if | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | No | The contact email address \(at least one of email or userId is required\) | | `userId` | string | No | The contact userId \(at least one of email or userId is required\) | | `firstName` | string | No | The contact first name | @@ -89,7 +87,6 @@ Find a contact in Loops by email address or userId. Returns an array of matching | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | No | The contact email address to search for \(at least one of email or userId is required\) | | `userId` | string | No | The contact userId to search for \(at least one of email or userId is required\) | @@ -121,7 +118,6 @@ Delete a contact from Loops by email address or userId. At least one identifier | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | No | The email address of the contact to delete \(at least one of email or userId is required\) | | `userId` | string | No | The userId of the contact to delete \(at least one of email or userId is required\) | @@ -144,7 +140,6 @@ Send a transactional email to a recipient using a Loops template. Supports dynam | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | Yes | The email address of the recipient | | `transactionalId` | string | Yes | The ID of the transactional email template to send | | `dataVariables` | json | No | Template data variables as key-value pairs \(string or number values\) | @@ -169,7 +164,6 @@ Send an event to Loops to trigger automated email sequences for a contact. Ident | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | No | The email address of the contact \(at least one of email or userId is required\) | | `userId` | string | No | The userId of the contact \(at least one of email or userId is required\) | | `eventName` | string | Yes | The name of the event to trigger | @@ -194,7 +188,6 @@ Retrieve all mailing lists from your Loops account. Returns each list with its I | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | #### Output @@ -218,7 +211,6 @@ Retrieve a list of published transactional email templates from your Loops accou | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `perPage` | string | No | Number of results per page \(10-50, default: 20\) | | `cursor` | string | No | Pagination cursor from a previous response to fetch the next page | @@ -253,7 +245,6 @@ Create a new custom contact property in your Loops account. The property name mu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `name` | string | Yes | The property name in camelCase format \(e.g., "favoriteColor"\) | | `type` | string | Yes | The property data type \(e.g., "string", "number", "boolean", "date"\) | @@ -275,7 +266,6 @@ Retrieve a list of contact properties from your Loops account. Returns each prop | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `list` | string | No | Filter type: "all" for all properties \(default\) or "custom" for custom properties only | #### Output @@ -299,7 +289,6 @@ Check whether a Loops contact is on the suppression list (bounced, complained, o | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | No | The contact email address to check \(at least one of email or userId is required\) | | `userId` | string | No | The contact userId to check \(at least one of email or userId is required\) | @@ -326,7 +315,6 @@ Remove a Loops contact from the suppression list by email address or userId, all | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `email` | string | No | The contact email address to remove from suppression \(at least one of email or userId is required\) | | `userId` | string | No | The contact userId to remove from suppression \(at least one of email or userId is required\) | @@ -351,7 +339,6 @@ Retrieve a single transactional email template from your Loops account by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Loops API key for authentication | | `transactionalId` | string | Yes | The ID of the transactional email template to retrieve | #### Output diff --git a/apps/docs/content/docs/integrations/luma.mdx b/apps/docs/content/docs/integrations/luma.mdx index 569755306ea..e5c350cbf43 100644 --- a/apps/docs/content/docs/integrations/luma.mdx +++ b/apps/docs/content/docs/integrations/luma.mdx @@ -2,7 +2,7 @@ title: Luma description: Manage events and guests on Luma integration: - type: "luma" + type: "luma_v2" color: "#000000" --- @@ -31,7 +31,6 @@ Retrieve details of a Luma event including name, time, location, hosts, and visi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | Yes | Event ID \(starts with evt-\) | #### Output @@ -76,7 +75,6 @@ Create a new event on Luma with a name, start time, timezone, and optional detai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `name` | string | Yes | Event name/title | | `startAt` | string | Yes | Event start time in ISO 8601 format \(e.g., 2025-03-15T18:00:00Z\) | | `timezone` | string | Yes | IANA timezone \(e.g., America/New_York, Europe/London\) | @@ -129,7 +127,6 @@ Update an existing Luma event. Only the fields you provide will be changed; all | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | Yes | Event ID to update \(starts with evt-\) | | `name` | string | No | New event name/title | | `startAt` | string | No | New start time in ISO 8601 format \(e.g., 2025-03-15T18:00:00Z\) | @@ -183,7 +180,6 @@ List events from your Luma calendar with optional date range filtering, sorting, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `after` | string | No | Return events after this ISO 8601 datetime \(e.g., 2025-01-01T00:00:00Z\) | | `before` | string | No | Return events before this ISO 8601 datetime \(e.g., 2025-12-31T23:59:59Z\) | | `paginationLimit` | number | No | Maximum number of events to return per page | @@ -228,7 +224,6 @@ Look up an event by its public URL or event ID to resolve its canonical ID, API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `url` | string | No | Public event URL on lu.ma \(provide this or an event ID\) | | `eventId` | string | No | Event ID to look up \(starts with evt-\). Provide this or a URL. | | `platform` | string | No | Event platform to look up: luma or external \(defaults to luma\) | @@ -254,7 +249,6 @@ Cancel a Luma event. This is irreversible and notifies all registered guests. Re | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | Yes | Event ID to cancel \(starts with evt-\) | | `cancellationToken` | string | Yes | Cancellation token from the Request Event Cancellation endpoint \(POST /v1/event/cancel/request\) | | `shouldRefund` | boolean | No | Whether to refund paid guests. Required if the event has paid registrations. | @@ -277,7 +271,6 @@ Retrieve the guest list for a Luma event with optional filtering by approval sta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | Yes | Event ID \(starts with evt-\) | | `approvalStatus` | string | No | Filter by approval status: approved, session, pending_approval, invited, declined, or waitlist | | `paginationLimit` | number | No | Maximum number of guests to return per page | @@ -316,7 +309,6 @@ Retrieve a single guest's details on a Luma event, including approval status, re | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | Yes | Event ID the guest belongs to \(starts with evt-\) | | `guestIdentifier` | string | Yes | Guest ID \(gst-...\), guest key \(g-...\), ticket key, or the guest's email address | @@ -349,7 +341,6 @@ Add guests to a Luma event by email. Guests are added with Going (approved) stat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | Yes | Event ID \(starts with evt-\) | | `guests` | string | Yes | JSON array of guest objects. Each guest requires an "email" field and optionally "name", "first_name", "last_name". Example: \[\{"email": "user@example.com", "name": "John Doe"\}\] | @@ -371,7 +362,6 @@ Send email invitations to guests for a Luma event. Unlike Add Guests (which regi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | Yes | Event ID to invite guests to \(starts with evt-\) | | `guests` | string | Yes | JSON array of guest objects. Each guest requires an "email" field and optionally "name". Example: \[\{"email": "user@example.com", "name": "John Doe"\}\] | | `message` | string | No | Optional custom message included in the invite email \(max 200 characters\) | @@ -394,7 +384,6 @@ Update a guest's approval status on a Luma event — approve, decline, waitlist, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Luma API key | | `eventId` | string | No | Event ID the guest belongs to \(starts with evt-\) | | `guestIdentifier` | string | Yes | Guest email address or guest ID \(gst-...\). Values containing '@' are treated as emails; otherwise as a guest ID. | | `status` | string | Yes | New approval status: approved, declined, pending_approval, or waitlist | diff --git a/apps/docs/content/docs/integrations/mailchimp.mdx b/apps/docs/content/docs/integrations/mailchimp.mdx index 15e0b60c3a3..f77a710ed18 100644 --- a/apps/docs/content/docs/integrations/mailchimp.mdx +++ b/apps/docs/content/docs/integrations/mailchimp.mdx @@ -2,7 +2,7 @@ title: Mailchimp description: Manage audiences, campaigns, and marketing automation in Mailchimp integration: - type: "mailchimp" + type: "mailchimp_v2" color: "#FFE01B" --- @@ -35,7 +35,6 @@ Retrieve a list of audiences (lists) from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -61,7 +60,6 @@ Retrieve details of a specific audience (list) from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | #### Output @@ -85,7 +83,6 @@ Create a new audience (list) in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `audienceName` | string | Yes | The name of the audience/list \(e.g., "Newsletter Subscribers"\) | | `contact` | string | Yes | JSON object of contact information \(e.g., \{"company": "Acme", "address1": "123 Main St", "city": "NYC", "state": "NY", "zip": "10001", "country": "US"\}\) | | `permissionReminder` | string | Yes | Permission reminder text shown to subscribers \(e.g., "You signed up for updates on our website"\) | @@ -114,7 +111,6 @@ Update an existing audience (list) in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `audienceName` | string | No | The name of the audience/list \(e.g., "Newsletter Subscribers"\) | | `permissionReminder` | string | No | Permission reminder text shown to subscribers \(e.g., "You signed up for updates on our website"\) | @@ -143,7 +139,6 @@ Delete an audience (list) from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list to delete \(e.g., "abc123def4"\) | #### Output @@ -164,7 +159,6 @@ Retrieve a list of members from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `status` | string | No | Filter by status: "subscribed", "unsubscribed", "cleaned", or "pending" | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | @@ -192,7 +186,6 @@ Retrieve details of a specific member from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | @@ -217,7 +210,6 @@ Add a new member to a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | | `status` | string | Yes | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | @@ -246,7 +238,6 @@ Add a new member or update an existing member in a Mailchimp audience (upsert) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | @@ -276,7 +267,6 @@ Update an existing member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `emailAddress` | string | No | New member email address \(e.g., "user@example.com"\) | @@ -306,7 +296,6 @@ Archive a member from a Mailchimp audience without permanently deleting their da | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | @@ -328,7 +317,6 @@ Request permanent deletion of a member and their identifying data. This targets | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | @@ -352,7 +340,6 @@ Restore an archived member to a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | @@ -380,7 +367,6 @@ Retrieve a list of campaigns from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignType` | string | No | Filter by campaign type: "regular", "plaintext", "absplit", "rss", or "variate" | | `status` | string | No | Filter by status: "save", "paused", "schedule", "sending", or "sent" | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | @@ -408,7 +394,6 @@ Retrieve details of a specific campaign from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | #### Output @@ -432,7 +417,6 @@ Create a new campaign in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignType` | string | Yes | Campaign type: "regular", "plaintext", "absplit", "rss", or "variate" | | `campaignSettings` | string | Yes | JSON object of campaign settings \(e.g., \{"subject_line": "Newsletter", "from_name": "Acme", "reply_to": "news@acme.com"\}\) | | `recipients` | string | No | JSON object of recipients \(e.g., \{"list_id": "abc123"\}\) | @@ -459,7 +443,6 @@ Update an existing campaign in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `campaignSettings` | string | No | JSON object of campaign settings \(e.g., \{"subject_line": "Newsletter", "from_name": "Acme"\}\) | | `recipients` | string | No | JSON object of recipients \(e.g., \{"list_id": "abc123"\}\) | @@ -486,7 +469,6 @@ Delete a campaign from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign to delete \(e.g., "abc123def4"\) | #### Output @@ -507,7 +489,6 @@ Send a Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign to send \(e.g., "abc123def4"\) | #### Output @@ -530,7 +511,6 @@ Schedule a Mailchimp campaign to be sent at a specific time | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign to schedule \(e.g., "abc123def4"\) | | `scheduleTime` | string | Yes | Schedule time in ISO 8601 format \(e.g., "2024-12-25T10:00:00Z"\) | @@ -552,7 +532,6 @@ Unschedule a previously scheduled Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign to unschedule \(e.g., "abc123def4"\) | #### Output @@ -575,7 +554,6 @@ Create a copy of an existing Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign to replicate \(e.g., "abc123def4"\) | #### Output @@ -600,7 +578,6 @@ Retrieve the HTML and plain-text content for a Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | #### Output @@ -623,7 +600,6 @@ Set the content for a Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `html` | string | No | The HTML content for the campaign | | `plainText` | string | No | The plain-text content for the campaign | @@ -650,7 +626,6 @@ Retrieve a list of automations from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -676,7 +651,6 @@ Retrieve details of a specific automation from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | #### Output @@ -700,7 +674,6 @@ Start all emails in a Mailchimp automation workflow | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | #### Output @@ -723,7 +696,6 @@ Pause all emails in a Mailchimp automation workflow | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | #### Output @@ -746,7 +718,6 @@ Manually add a subscriber to a workflow email queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | | `workflowEmailId` | string | Yes | The unique ID for the workflow email \(e.g., "xyz789"\) | | `emailAddress` | string | Yes | Email address of the subscriber \(e.g., "user@example.com"\) | @@ -772,7 +743,6 @@ Retrieve a list of templates from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -798,7 +768,6 @@ Retrieve details of a specific template from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `templateId` | string | Yes | The unique ID for the template \(e.g., "12345"\) | #### Output @@ -822,7 +791,6 @@ Create a new template in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `templateName` | string | Yes | The name of the template \(e.g., "Monthly Newsletter"\) | | `templateHtml` | string | Yes | The HTML content for the template | @@ -848,7 +816,6 @@ Update an existing template in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `templateId` | string | Yes | The unique ID for the template \(e.g., "12345"\) | | `templateName` | string | No | The name of the template \(e.g., "Monthly Newsletter"\) | | `templateHtml` | string | No | The HTML content for the template | @@ -875,7 +842,6 @@ Delete a template from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `templateId` | string | Yes | The unique ID for the template to delete \(e.g., "12345"\) | #### Output @@ -896,7 +862,6 @@ Retrieve a list of campaign reports from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -922,7 +887,6 @@ Retrieve the report for a specific campaign from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | #### Output @@ -946,7 +910,6 @@ Retrieve a list of segments from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -973,7 +936,6 @@ Retrieve details of a specific segment from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | @@ -998,7 +960,6 @@ Create a new segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `segmentName` | string | Yes | The name of the segment \(e.g., "VIP Customers"\) | | `segmentOptions` | string | No | JSON object of segment options for saved segments \(e.g., \{"match": "all", "conditions": \[...\]\}\) | @@ -1025,7 +986,6 @@ Update an existing segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `segmentName` | string | No | The name of the segment \(e.g., "VIP Customers"\) | @@ -1053,7 +1013,6 @@ Delete a segment from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `segmentId` | string | Yes | The unique ID for the segment to delete \(e.g., "12345"\) | @@ -1075,7 +1034,6 @@ Retrieve members of a specific segment from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | @@ -1103,7 +1061,6 @@ Add a member to a specific segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `emailAddress` | string | Yes | Email address of the member \(e.g., "user@example.com"\) | @@ -1129,7 +1086,6 @@ Remove a member from a specific segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | @@ -1154,7 +1110,6 @@ Retrieve tags associated with a member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | @@ -1180,7 +1135,6 @@ Add tags to a member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `tags` | string | Yes | JSON array of tag objects \(e.g., \[\{"name": "VIP", "status": "active"\}\]\) | @@ -1205,7 +1159,6 @@ Remove tags from a member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `tags` | string | Yes | JSON array of tag objects with inactive status \(e.g., \[\{"name": "VIP", "status": "inactive"\}\]\) | @@ -1230,7 +1183,6 @@ Retrieve a list of merge fields from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -1257,7 +1209,6 @@ Retrieve details of a specific merge field from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `mergeId` | string | Yes | The unique ID for the merge field \(e.g., "1" or "FNAME"\) | @@ -1282,7 +1233,6 @@ Create a new merge field in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `mergeName` | string | Yes | The name of the merge field \(e.g., "First Name"\) | | `mergeType` | string | Yes | The type of the merge field: "text", "number", "address", "phone", "date", "url", "imageurl", "radio", "dropdown", "birthday", or "zip" | @@ -1309,7 +1259,6 @@ Update an existing merge field in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `mergeId` | string | Yes | The unique ID for the merge field \(e.g., "1" or "FNAME"\) | | `mergeName` | string | No | The name of the merge field \(e.g., "First Name"\) | @@ -1336,7 +1285,6 @@ Delete a merge field from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `mergeId` | string | Yes | The unique ID for the merge field to delete \(e.g., "1" or "FNAME"\) | @@ -1358,7 +1306,6 @@ Retrieve a list of interest categories from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -1385,7 +1332,6 @@ Retrieve details of a specific interest category from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | @@ -1410,7 +1356,6 @@ Create a new interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryTitle` | string | Yes | The title of the interest category \(e.g., "Email Preferences"\) | | `interestCategoryType` | string | Yes | The type of interest category: "checkboxes", "dropdown", "radio", or "hidden" | @@ -1437,7 +1382,6 @@ Update an existing interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryTitle` | string | No | The title of the interest category \(e.g., "Email Preferences"\) | @@ -1464,7 +1408,6 @@ Delete an interest category from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category to delete \(e.g., "xyz789"\) | @@ -1486,7 +1429,6 @@ Retrieve a list of interests from an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | @@ -1514,7 +1456,6 @@ Retrieve details of a specific interest from an interest category in a Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestId` | string | Yes | The unique ID for the interest \(e.g., "def456"\) | @@ -1540,7 +1481,6 @@ Create a new interest in an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestName` | string | Yes | The name of the interest \(e.g., "Weekly Updates"\) | @@ -1567,7 +1507,6 @@ Update an existing interest in an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestId` | string | Yes | The unique ID for the interest \(e.g., "def456"\) | @@ -1595,7 +1534,6 @@ Delete an interest from an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestId` | string | Yes | The unique ID for the interest to delete \(e.g., "def456"\) | @@ -1618,7 +1556,6 @@ Retrieve a list of landing pages from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -1644,7 +1581,6 @@ Retrieve details of a specific landing page from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | #### Output @@ -1668,7 +1604,6 @@ Create a new landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `landingPageType` | string | Yes | The type of landing page: "signup" | | `landingPageTitle` | string | No | The title of the landing page \(e.g., "Join Our Newsletter"\) | @@ -1694,7 +1629,6 @@ Update an existing landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | | `landingPageTitle` | string | No | The title of the landing page \(e.g., "Join Our Newsletter"\) | @@ -1720,7 +1654,6 @@ Delete a landing page from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `pageId` | string | Yes | The unique ID for the landing page to delete \(e.g., "abc123def4"\) | #### Output @@ -1741,7 +1674,6 @@ Publish a landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | #### Output @@ -1764,7 +1696,6 @@ Unpublish a landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | #### Output @@ -1787,7 +1718,6 @@ Retrieve a list of batch operations from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `offset` | string | No | Number of results to skip for pagination | @@ -1813,7 +1743,6 @@ Retrieve details of a specific batch operation from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `batchId` | string | Yes | The unique ID for the batch operation \(e.g., "abc123def4"\) | #### Output @@ -1837,7 +1766,6 @@ Create a new batch operation in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `operations` | string | Yes | JSON array of batch operations \(e.g., \[\{"method": "POST", "path": "/lists/\{list_id\}/members", "body": "..."\}\]\) | #### Output @@ -1862,7 +1790,6 @@ Delete a batch operation from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `batchId` | string | Yes | The unique ID for the batch operation to delete \(e.g., "abc123def4"\) | #### Output diff --git a/apps/docs/content/docs/integrations/mem0.mdx b/apps/docs/content/docs/integrations/mem0.mdx index 74e3aebe6da..33fa41bc6fa 100644 --- a/apps/docs/content/docs/integrations/mem0.mdx +++ b/apps/docs/content/docs/integrations/mem0.mdx @@ -2,7 +2,7 @@ title: Mem0 description: Agent memory management integration: - type: "mem0" + type: "mem0_v2" color: "#181C1E" --- @@ -31,7 +31,6 @@ Add memories to Mem0 for persistent storage and retrieval | --------- | ---- | -------- | ----------- | | `userId` | string | Yes | User ID associated with the memory \(e.g., "user_123", "alice@example.com"\) | | `messages` | json | Yes | Array of message objects with role and content \(e.g., \[\{"role": "user", "content": "Hello"\}\]\) | -| `apiKey` | string | Yes | Your Mem0 API key | #### Output @@ -56,7 +55,6 @@ Search for memories in Mem0 using semantic search | `userId` | string | Yes | User ID to search memories for \(e.g., "user_123", "alice@example.com"\) | | `query` | string | Yes | Search query to find relevant memories \(e.g., "What are my favorite foods?"\) | | `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) | -| `apiKey` | string | Yes | Your Mem0 API key | #### Output @@ -95,7 +93,6 @@ Retrieve memories from Mem0 by ID or filter criteria | `endDate` | string | No | End date for filtering by created_at \(e.g., "2024-12-31"\) | | `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) | | `page` | number | No | Page number to retrieve for paginated list results | -| `apiKey` | string | Yes | Your Mem0 API key | #### Output diff --git a/apps/docs/content/docs/integrations/meta.json b/apps/docs/content/docs/integrations/meta.json index 15dd2516e0a..e58780b050c 100644 --- a/apps/docs/content/docs/integrations/meta.json +++ b/apps/docs/content/docs/integrations/meta.json @@ -21,6 +21,7 @@ "atlassian-service-account", "attio", "attio-service-account", + "aws-credentials", "azure_data_explorer", "azure_devops", "bitbucket", @@ -56,6 +57,7 @@ "cursor", "dagster", "databricks", + "databricks-credentials", "datadog", "datagma", "daytona", diff --git a/apps/docs/content/docs/integrations/otter.mdx b/apps/docs/content/docs/integrations/otter.mdx index 62db5f7e8f0..33641015c63 100644 --- a/apps/docs/content/docs/integrations/otter.mdx +++ b/apps/docs/content/docs/integrations/otter.mdx @@ -2,7 +2,7 @@ title: Otter.ai description: Read Otter.ai meeting conversations, transcripts, and summaries integration: - type: "otter" + type: "otter_v2" color: "#FFFFFF" --- @@ -31,7 +31,6 @@ List Otter conversations for the authenticated user, most recent first, optional | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key | | `includeShared` | boolean | No | Include conversations shared with the user \(default false\). Automatically true when a channel ID is provided. | | `channelId` | string | No | Only return conversations in this channel. Overrides includeShared. | | `limit` | number | No | Number of conversations per page \(1-100\) | @@ -100,7 +99,6 @@ Get an Otter conversation with its summary and details, plus any requested actio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key | | `conversationId` | string | Yes | The Otter conversation ID | | `include` | string | Yes | Comma-separated related data to include: action_items, insights, outline, transcript, or all \(e.g., "insights,transcript"\) | @@ -190,7 +188,6 @@ Get the MP3 audio download link for an Otter conversation. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key | | `conversationId` | string | Yes | The Otter conversation ID | #### Output @@ -212,7 +209,6 @@ Import an audio or video recording into Otter as a new conversation from a publi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key | | `fileUrl` | string | Yes | URL of the recording to import \(e.g., https://example.com/call.mp4) | | `name` | string | No | Name for the new conversation | @@ -236,7 +232,6 @@ List the Otter channels available to the authenticated user, in alphabetical ord | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key | #### Output @@ -267,7 +262,6 @@ List the members of an Otter channel, in alphabetical order. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key | | `channelId` | string | Yes | The Otter channel ID | #### Output @@ -294,7 +288,6 @@ Get the Otter workspace of the authenticated user, including its ID, name, owner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key | #### Output @@ -325,7 +318,6 @@ List every conversation in an Otter workspace, most recent first. Requires an Ot | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Otter API key of a Super Admin | | `workspaceId` | string | Yes | The Otter workspace ID \(the id returned by Get Workspace\) | | `limit` | number | No | Number of conversations per page \(1-100\) | | `cursor` | string | No | Pagination cursor \(nextCursor from a previous response\) | diff --git a/apps/docs/content/docs/integrations/persona.mdx b/apps/docs/content/docs/integrations/persona.mdx index 1bfb0477ae5..4df5f84bc49 100644 --- a/apps/docs/content/docs/integrations/persona.mdx +++ b/apps/docs/content/docs/integrations/persona.mdx @@ -2,7 +2,7 @@ title: Persona description: Verify identities with Persona integration: - type: "persona" + type: "persona_v2" color: "#FFFFFF" --- @@ -12,7 +12,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} Use [Persona](https://withpersona.com/) to create inquiries from verification templates, generate one-time links, inspect verification results, and update inquiry decisions or lifecycle state. The actions also retrieve summary PDFs and documents, manage accounts and CSV imports, run screening reports, and inspect cases. -Provide your Persona API key and the template or resource identifiers required by the action. Keep a human review step where your process requires one before approving or declining an inquiry. +Save your Persona API key as a Persona credential, select it in the block, and provide the template or resource identifiers the action requires. Keep a human review step where your process requires one before approving or declining an inquiry. {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] @@ -31,7 +31,6 @@ Create a new identity verification inquiry from an inquiry template. Returns the | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryTemplateId` | string | Yes | Inquiry template ID \(starts with itmpl_\), inquiry template version ID \(starts with itmplv_\), or legacy template ID \(starts with tmpl_\) | | `accountId` | string | No | Account ID \(starts with act_\) to associate with this inquiry | | `referenceId` | string | No | Reference ID that refers to an entity in your user model. An account is auto-created for it if one does not exist. | @@ -57,7 +56,6 @@ Retrieve a single identity verification inquiry by ID, including its status, col | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to retrieve \(starts with inq_\) | #### Output @@ -78,7 +76,6 @@ List identity verification inquiries, optionally filtered by status, account ID, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `status` | string | No | Filter by inquiry status \(created, pending, completed, failed, expired, needs_review, approved, declined\) | | `accountId` | string | No | Filter by account ID \(starts with act_\); comma-separate multiple IDs | | `referenceId` | string | No | Filter by reference ID | @@ -106,7 +103,6 @@ Update an inquiry’s note, fields, tags, or redirect URI. Only the provided val | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to update \(starts with inq_\) | | `note` | string | No | Free-form note to set on the inquiry | | `fields` | json | No | JSON object of field name to field value pairs to set, as defined by the inquiry template \(e.g. \{"name-first": "Jane"\}\) | @@ -131,7 +127,6 @@ Approve an identity verification inquiry. Approving prevents further progress on | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to approve \(starts with inq_\) | #### Output @@ -152,7 +147,6 @@ Decline an identity verification inquiry. Declining prevents further progress on | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to decline \(starts with inq_\) | #### Output @@ -173,7 +167,6 @@ Mark an identity verification inquiry for manual review, moving it to the needs_ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to mark for review \(starts with inq_\) | #### Output @@ -194,7 +187,6 @@ Resume a pending or expired inquiry, creating a new session so the individual ca | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to resume \(starts with inq_\) | #### Output @@ -216,7 +208,6 @@ Expire an in-progress inquiry, invalidating its sessions and one-time links so t | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to expire \(starts with inq_\) | #### Output @@ -237,7 +228,6 @@ Generate a one-time link for an inquiry that the individual can open to complete | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to generate a one-time link for \(starts with inq_\) | | `expiresInSeconds` | number | No | Number of seconds from now until the link expires \(must be greater than 0; defaults to the inquiry template setting, typically 24 hours\) | @@ -261,7 +251,6 @@ Download a PDF summary of an inquiry, including its collected information and ve | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to print \(starts with inq_\) | #### Output @@ -282,7 +271,6 @@ Permanently delete all personally identifiable information collected by an inqui | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `inquiryId` | string | Yes | Inquiry ID to redact \(starts with inq_\) | #### Output @@ -303,7 +291,6 @@ Create an account that represents an individual in Persona. Accounts consolidate | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `accountTypeId` | string | No | Account type ID to create the account for \(starts with acttp_\); defaults to your organization default | | `referenceId` | string | No | Reference ID that refers to an entity in your user model | | `countryCode` | string | No | ISO 3166-1 alpha-2 country code \(e.g. US\) | @@ -328,7 +315,6 @@ Retrieve a single account by ID, including its reference ID, fields, tags, and s | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `accountId` | string | Yes | Account ID to retrieve \(starts with act_\) | #### Output @@ -349,7 +335,6 @@ List accounts in your Persona organization, optionally filtered by reference ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `referenceId` | string | No | Filter by reference ID | | `pageSize` | number | No | Number of accounts to return per page \(1-100, default 10\) | | `pageAfter` | string | No | Pagination cursor: return accounts after this account ID | @@ -373,7 +358,6 @@ Update an account’s reference ID, country code, fields, or tags. Only the prov | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `accountId` | string | Yes | Account ID to update \(starts with act_\) | | `referenceId` | string | No | Reference ID that refers to an entity in your user model | | `countryCode` | string | No | ISO 3166-1 alpha-2 country code \(e.g. US\) | @@ -398,7 +382,6 @@ Bulk-import accounts into Persona from a CSV file. Returns an importer whose sta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `file` | file | Yes | CSV file of accounts to import | #### Output @@ -419,7 +402,6 @@ Permanently delete all personally identifiable information stored on an account, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `accountId` | string | Yes | Account ID to redact \(starts with act_\) | #### Output @@ -440,7 +422,6 @@ List manual review cases, optionally filtered by status, account ID, or referenc | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `status` | string | No | Filter by case status \(e.g. Open, Resolved\) | | `accountId` | string | No | Filter by account ID \(starts with act_\) | | `referenceId` | string | No | Filter by reference ID | @@ -466,7 +447,6 @@ Retrieve a single manual review case by ID, including its status, resolution, an | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `caseId` | string | Yes | Case ID to retrieve \(starts with case_\) | #### Output @@ -487,7 +467,6 @@ Run a screening report (watchlist, adverse media, or politically exposed person) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `reportType` | string | Yes | Type of report to run: watchlist, adverse-media, or politically-exposed-person | | `reportTemplateId` | string | Yes | Report template ID to run \(starts with rptp_\) | | `term` | string | No | Full-name search term \(e.g. "Jane Q Doe"\). Provide this or the separate name parts. | @@ -516,7 +495,6 @@ Retrieve a single screening report by ID, including its status, match results, a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `reportId` | string | Yes | Report ID to retrieve \(starts with rep_\) | #### Output @@ -537,7 +515,6 @@ List screening reports, optionally filtered by account ID or reference ID. Resul | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `accountId` | string | No | Filter by account ID \(starts with act_\) | | `referenceId` | string | No | Filter by reference ID | | `pageSize` | number | No | Number of reports to return per page \(1-100, default 10\) | @@ -562,7 +539,6 @@ Retrieve a single verification by ID (government ID, selfie, document, database, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `verificationId` | string | Yes | Verification ID to retrieve \(starts with ver_\) | #### Output @@ -583,7 +559,6 @@ Retrieve a single document by ID (government ID, generic document, and more), in | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `documentId` | string | Yes | Document ID to retrieve \(starts with doc_\) | #### Output @@ -604,7 +579,6 @@ List the inquiry templates in your Persona organization, to discover template ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Persona API key | | `pageSize` | number | No | Number of templates to return per page \(1-100, default 10\) | | `pageAfter` | string | No | Pagination cursor: return templates after this template ID | diff --git a/apps/docs/content/docs/integrations/profound.mdx b/apps/docs/content/docs/integrations/profound.mdx index 41d6157701b..cede1cc099c 100644 --- a/apps/docs/content/docs/integrations/profound.mdx +++ b/apps/docs/content/docs/integrations/profound.mdx @@ -2,7 +2,7 @@ title: Profound description: AI visibility and analytics with Profound integration: - type: "profound" + type: "profound_v2" color: "#000000" --- @@ -31,7 +31,6 @@ List all organization categories in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | #### Output @@ -53,7 +52,6 @@ List all organization regions in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | #### Output @@ -75,7 +73,6 @@ List all AI models/platforms tracked in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | #### Output @@ -97,7 +94,6 @@ List all organization domains in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | #### Output @@ -120,7 +116,6 @@ List all organization assets (companies/brands) across all categories in Profoun | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | #### Output @@ -149,7 +144,6 @@ List all organization personas across all categories in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | #### Output @@ -174,7 +168,6 @@ List topics for a specific category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | #### Output @@ -197,7 +190,6 @@ List tags for a specific category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | #### Output @@ -220,7 +212,6 @@ List prompts for a specific category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | | `limit` | number | No | Maximum number of results \(default 10000, max 10000\) | | `cursor` | string | No | Pagination cursor from previous response | @@ -260,7 +251,6 @@ List assets (companies/brands) for a specific category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | #### Output @@ -288,7 +278,6 @@ List personas for a specific category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | #### Output @@ -312,7 +301,6 @@ Query AI visibility report for a category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | Yes | End date \(YYYY-MM-DD or ISO 8601\) | @@ -343,7 +331,6 @@ Query sentiment report for a category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | Yes | End date \(YYYY-MM-DD or ISO 8601\) | @@ -374,7 +361,6 @@ Query citations report for a category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | Yes | End date \(YYYY-MM-DD or ISO 8601\) | @@ -405,7 +391,6 @@ Query fanout report showing how AI models expand prompts into sub-queries in Pro | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | Yes | End date \(YYYY-MM-DD or ISO 8601\) | @@ -436,7 +421,6 @@ Get raw prompt answers data for a category in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `categoryId` | string | Yes | Category ID \(UUID\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | Yes | End date \(YYYY-MM-DD or ISO 8601\) | @@ -472,7 +456,6 @@ Query bot traffic report with hourly granularity for a domain in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `domain` | string | Yes | Domain to query bot traffic for \(e.g. example.com\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | No | End date \(YYYY-MM-DD or ISO 8601\). Defaults to now | @@ -503,7 +486,6 @@ Query human referral traffic report with hourly granularity for a domain in Prof | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `domain` | string | Yes | Domain to query referral traffic for \(e.g. example.com\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | No | End date \(YYYY-MM-DD or ISO 8601\). Defaults to now | @@ -534,7 +516,6 @@ Get raw traffic logs with filters for a domain in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `domain` | string | Yes | Domain to query logs for \(e.g. example.com\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | No | End date \(YYYY-MM-DD or ISO 8601\). Defaults to now | @@ -563,7 +544,6 @@ Get identified bot visit logs with filters for a domain in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `domain` | string | Yes | Domain to query bot logs for \(e.g. example.com\) | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | No | End date \(YYYY-MM-DD or ISO 8601\). Defaults to now | @@ -592,7 +572,6 @@ List content optimization entries for an asset in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `assetId` | string | Yes | Asset ID \(UUID\) | | `limit` | number | No | Maximum number of results \(default 10000, max 50000\) | | `offset` | number | No | Offset for pagination \(default 0\) | @@ -622,7 +601,6 @@ Get detailed content optimization analysis for a specific content item in Profou | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `assetId` | string | Yes | Asset ID \(UUID\) | | `contentId` | string | Yes | Content/optimization ID \(UUID\) | @@ -663,7 +641,6 @@ Query prompt volume data to understand search demand across AI platforms in Prof | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `startDate` | string | Yes | Start date \(YYYY-MM-DD or ISO 8601\) | | `endDate` | string | Yes | End date \(YYYY-MM-DD or ISO 8601\) | | `metrics` | string | Yes | Comma-separated metrics: volume, change | @@ -693,7 +670,6 @@ Get prompts that cite a specific domain across AI platforms in Profound | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Profound API Key | | `inputDomain` | string | Yes | Domain to look up citations for \(e.g. ramp.com\) | #### Output diff --git a/apps/docs/content/docs/integrations/pulse.mdx b/apps/docs/content/docs/integrations/pulse.mdx index b91ebfc1e12..4d271b4d764 100644 --- a/apps/docs/content/docs/integrations/pulse.mdx +++ b/apps/docs/content/docs/integrations/pulse.mdx @@ -2,7 +2,7 @@ title: Pulse description: Extract text from documents using Pulse OCR integration: - type: "pulse_v2" + type: "pulse_v3" color: "#FFFFFF" --- @@ -10,7 +10,7 @@ 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. +Use [Pulse](https://www.runpulse.com) to extract text and structured content from PDFs, images, and Office files with optical character recognition (OCR). Supply an uploaded file or a file reference, select pages when needed, and choose the supported Markdown, text, or JSON output options. 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 */} @@ -35,7 +35,6 @@ Parse documents (PDF, images, Office docs) using Pulse OCR API | `pages` | string | No | Page range to process \(1-indexed, e.g., "1-2,5"\) | | `chunking` | string | No | Chunking strategies \(comma-separated: semantic, header, page, recursive\) | | `chunkSize` | number | No | Maximum characters per chunk when chunking is enabled | -| `apiKey` | string | Yes | Pulse API key | #### Output diff --git a/apps/docs/content/docs/integrations/quartr.mdx b/apps/docs/content/docs/integrations/quartr.mdx index cb8dea0bd46..c554df9d8b3 100644 --- a/apps/docs/content/docs/integrations/quartr.mdx +++ b/apps/docs/content/docs/integrations/quartr.mdx @@ -2,7 +2,7 @@ title: Quartr description: Access earnings calls, transcripts, filings, and slides integration: - type: "quartr" + type: "quartr_v2" color: "#000000" --- @@ -14,12 +14,12 @@ Use [Quartr](https://quartr.com/) to look up companies, corporate events, and ev Downloaded reports, slide decks, and transcripts are stored as execution files, so they can be passed straight into agents, knowledge bases, or other blocks in your workflow. -To use the integration, generate an API key from the Quartr API portal and paste it into the block. Your key inherits the datasets enabled on your Quartr subscription. +To use the integration, generate an API key from the Quartr API portal and add it as a Quartr credential. Your key inherits the datasets enabled on your Quartr subscription. {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Look up companies, corporate events, and event types, retrieve AI-generated event summaries, list and download reports, slide decks, and transcripts, and access archived audio or live event streams. Supply a Quartr API key. +Look up companies, corporate events, and event types, retrieve AI-generated event summaries, list and download reports, slide decks, and transcripts, and access archived audio or live event streams. ## Actions @@ -33,7 +33,6 @@ List companies covered by Quartr, filterable by ticker, ISIN, CIK, OpenFIGI, cou | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | | `isins` | string | No | Comma-separated list of ISINs \(e.g., "US0378331005"\) | | `ciks` | string | No | Comma-separated list of SEC CIKs \(e.g., "0000320193"\) | @@ -79,7 +78,6 @@ Retrieve a single company from Quartr by its company ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyId` | number | Yes | Quartr company ID \(e.g., 4742\) | #### Output @@ -113,7 +111,6 @@ List corporate events (earnings calls, capital markets days, etc.) from Quartr, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyIds` | string | No | Comma-separated list of Quartr company IDs \(e.g., "4742,128"\) | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | | `isins` | string | No | Comma-separated list of ISINs \(e.g., "US0378331005"\) | @@ -160,7 +157,6 @@ Retrieve a single corporate event from Quartr by its event ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `eventId` | number | Yes | Quartr event ID \(e.g., 128301\) | #### Output @@ -192,7 +188,6 @@ Retrieve the AI-generated summary of a corporate event from Quartr, with selecta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `eventId` | number | Yes | Quartr event ID \(e.g., 128301\) | | `summaryLength` | string | No | Length preset for the summary: "line", "short", or "long" \(default: short\) | | `plainSummary` | boolean | No | Return a plain-text summary without embedded document source tags | @@ -224,7 +219,6 @@ List the event types available in Quartr (e.g., earnings calls), useful for filt | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `limit` | number | No | Maximum number of items to return in a single request \(default: 10, max: 500\) | | `cursor` | number | No | Pagination cursor from the previous response \(nextCursor\) for the next page | | `direction` | string | No | Sort direction by id: "asc" or "desc" \(default: asc\) | @@ -253,7 +247,6 @@ List documents of all kinds (reports, slide decks, and transcripts) from Quartr, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyIds` | string | No | Comma-separated list of Quartr company IDs \(e.g., "4742,128"\) | | `eventIds` | string | No | Comma-separated list of Quartr event IDs \(e.g., "128301"\) | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | @@ -305,7 +298,6 @@ List the document types available in Quartr (e.g., 10-Q quarterly reports), usef | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `limit` | number | No | Maximum number of items to return in a single request \(default: 10, max: 500\) | | `cursor` | number | No | Pagination cursor from the previous response \(nextCursor\) for the next page | | `direction` | string | No | Sort direction by id: "asc" or "desc" \(default: asc\) | @@ -337,7 +329,6 @@ List filings and reports (10-K, 10-Q, earnings releases, etc.) from Quartr, filt | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyIds` | string | No | Comma-separated list of Quartr company IDs \(e.g., "4742,128"\) | | `eventIds` | string | No | Comma-separated list of Quartr event IDs \(e.g., "128301"\) | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | @@ -389,7 +380,6 @@ Retrieve a filing or report (10-K, 10-Q, earnings release, etc.) from Quartr by | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `reportId` | number | Yes | Quartr document ID of the report \(e.g., 432907\) | #### Output @@ -426,7 +416,6 @@ List slide presentations from Quartr, filterable by company, event, document typ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyIds` | string | No | Comma-separated list of Quartr company IDs \(e.g., "4742,128"\) | | `eventIds` | string | No | Comma-separated list of Quartr event IDs \(e.g., "128301"\) | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | @@ -478,7 +467,6 @@ Retrieve a slide presentation from Quartr by its document ID and download the PD | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `slideDeckId` | number | Yes | Quartr document ID of the slide deck \(e.g., 432907\) | #### Output @@ -515,7 +503,6 @@ List event transcripts from Quartr, filterable by company, event, document type, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyIds` | string | No | Comma-separated list of Quartr company IDs \(e.g., "4742,128"\) | | `eventIds` | string | No | Comma-separated list of Quartr event IDs \(e.g., "128301"\) | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | @@ -567,7 +554,6 @@ Retrieve an event transcript from Quartr by its document ID and download the tra | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `transcriptId` | number | Yes | Quartr document ID of the transcript \(e.g., 432907\) | #### Output @@ -604,7 +590,6 @@ List archived event audio recordings from Quartr, filterable by company, event, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyIds` | string | No | Comma-separated list of Quartr company IDs \(e.g., "4742,128"\) | | `eventIds` | string | No | Comma-separated list of Quartr event IDs \(e.g., "128301"\) | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | @@ -660,7 +645,6 @@ Retrieve an archived event audio recording from Quartr by its audio ID. Returns | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `audioId` | number | Yes | Quartr audio ID \(e.g., 123964\) | #### Output @@ -701,7 +685,6 @@ List live and upcoming events from Quartr with live audio and transcript stream | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Quartr API key | | `companyIds` | string | No | Comma-separated list of Quartr company IDs \(e.g., "4742,128"\) | | `eventIds` | string | No | Comma-separated list of Quartr event IDs \(e.g., "128301"\) | | `tickers` | string | No | Comma-separated list of company tickers \(e.g., "AAPL,MSFT"\) | diff --git a/apps/docs/content/docs/integrations/quiver.mdx b/apps/docs/content/docs/integrations/quiver.mdx index 337da479f53..4146c050ee3 100644 --- a/apps/docs/content/docs/integrations/quiver.mdx +++ b/apps/docs/content/docs/integrations/quiver.mdx @@ -2,7 +2,7 @@ title: Quiver description: Generate and vectorize SVGs integration: - type: "quiver_v2" + type: "quiver_v3" color: "#FFFFFF" --- @@ -31,7 +31,6 @@ Generate SVG images from text prompts using QuiverAI | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | QuiverAI API key | | `prompt` | string | Yes | A text description of the desired SVG | | `model` | string | Yes | The model to use for SVG generation \(e.g., "arrow-preview"\) | | `instructions` | string | No | Style or formatting guidance for the SVG output | @@ -65,7 +64,6 @@ Convert raster images into vector SVG format using QuiverAI | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | QuiverAI API key | | `model` | string | Yes | The model to use for vectorization \(e.g., "arrow-preview"\) | | `image` | file | Yes | The raster image to vectorize into SVG | | `temperature` | number | No | Sampling temperature \(0-2, default 1\) | @@ -98,7 +96,6 @@ List all available QuiverAI models | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | QuiverAI API key | #### Output diff --git a/apps/docs/content/docs/integrations/rb2b.mdx b/apps/docs/content/docs/integrations/rb2b.mdx index 6f7a67efb22..409a68a4f54 100644 --- a/apps/docs/content/docs/integrations/rb2b.mdx +++ b/apps/docs/content/docs/integrations/rb2b.mdx @@ -2,7 +2,7 @@ title: RB2B description: Identify and enrich website visitors integration: - type: "rb2b" + type: "rb2b_v2" color: "#51FF00" --- @@ -17,7 +17,7 @@ Connect an RB2B API key and inspect the returned match before adding a contact t ## Use the block [#usage-instructions] -Resolve IP addresses, hashed emails, and LinkedIn profiles into person-level identity and B2B enrichment data using the RB2B API. Convert IPs to hashed emails, MAIDs, and company domains; enrich emails into LinkedIn profiles, business profiles, and mobile IDs; and look up emails or phone numbers from LinkedIn. Requires an RB2B API key. +Resolve IP addresses, hashed emails, and LinkedIn profiles into person-level identity and B2B enrichment data using the RB2B API. Convert IPs to hashed emails, MAIDs, and company domains; enrich emails into LinkedIn profiles, business profiles, and mobile IDs; and look up emails or phone numbers from LinkedIn. ## Actions @@ -31,7 +31,6 @@ Check the number of API credits remaining on your RB2B account. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | #### Output @@ -51,7 +50,6 @@ Convert an IP address (and optional user agent) into hashed email addresses (HEM | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `ip_address` | string | Yes | The IP address to resolve \(IPv4 or IPv6\) | | `user_agent` | string | No | Optional user agent string to improve match accuracy | | `include_sha256` | boolean | No | Whether to include SHA-256 hashes in addition to MD5 hashes | @@ -77,7 +75,6 @@ Resolve an IP address (and optional user agent) into mobile advertising identifi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `ip_address` | string | Yes | The IP address to resolve \(IPv4 or IPv6\) | | `user_agent` | string | No | Optional user agent string to improve match accuracy | @@ -101,7 +98,6 @@ Identify the company domains associated with an IP address, ranked by confidence | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `ip_address` | string | Yes | The IP address to resolve \(IPv4 or IPv6\) | #### Output @@ -124,7 +120,6 @@ Return a full business profile (name, title, company, industry, seniority and mo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `email` | string | Yes | A plaintext email address or an MD5 hash of the email | #### Output @@ -162,7 +157,6 @@ Return the most recently active LinkedIn profile URL for an email address or MD5 | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `email` | string | Yes | A plaintext email address or an MD5 hash of the email | #### Output @@ -183,7 +177,6 @@ Return the LinkedIn slug (the profile identifier portion of the URL) for an emai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `email` | string | Yes | A plaintext email address or an MD5 hash of the email | #### Output @@ -204,7 +197,6 @@ Return up to five mobile advertising identifiers (MAIDs) associated with an emai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `email` | string | Yes | A plaintext email address or an MD5 hash of the email | #### Output @@ -227,7 +219,6 @@ Return the last known active date for an email address. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `email` | string | Yes | The email address to look up | #### Output @@ -253,7 +244,6 @@ Return a full business profile (name, title, company, emails and more) for a Lin | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `linkedin_slug` | string | Yes | The LinkedIn profile slug or URL | #### Output @@ -290,7 +280,6 @@ Return the personal email with the most recent known network activity for a Link | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `linkedin_slug` | string | Yes | The LinkedIn profile slug or URL | #### Output @@ -311,7 +300,6 @@ Return the personal email addresses associated with a LinkedIn profile. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `linkedin_slug` | string | Yes | The LinkedIn profile slug or URL | #### Output @@ -332,7 +320,6 @@ Return the business and personal hashed emails (MD5 and SHA-256) associated with | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `linkedin_slug` | string | Yes | The LinkedIn profile slug or URL | #### Output @@ -357,7 +344,6 @@ Return the mobile phone number with the most recent known network activity for a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `linkedin_slug` | string | Yes | The LinkedIn profile slug or URL | #### Output @@ -378,7 +364,6 @@ Find a LinkedIn profile URL from a first name, last name, and company domain. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | RB2B API key | | `first_name` | string | Yes | The person’s first name | | `last_name` | string | Yes | The person’s last name | | `company_domain` | string | Yes | The company domain \(e.g. example.com\) | diff --git a/apps/docs/content/docs/integrations/rds.mdx b/apps/docs/content/docs/integrations/rds.mdx index e1c7aa78bcd..493311bd8ad 100644 --- a/apps/docs/content/docs/integrations/rds.mdx +++ b/apps/docs/content/docs/integrations/rds.mdx @@ -2,7 +2,7 @@ title: Amazon RDS description: Connect to Amazon RDS via Data API integration: - type: "rds" + type: "rds_v2" color: "linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)" --- @@ -10,7 +10,7 @@ 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. +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. Connect with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] @@ -30,8 +30,6 @@ Execute a SELECT query on Amazon RDS using the Data API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | @@ -58,8 +56,6 @@ Insert data into an Amazon RDS table using the Data API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | @@ -87,8 +83,6 @@ Update data in an Amazon RDS table using the Data API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | @@ -117,8 +111,6 @@ Delete data from an Amazon RDS table using the Data API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | @@ -146,8 +138,6 @@ Execute raw SQL on Amazon RDS using the Data API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | @@ -174,8 +164,6 @@ Introspect Amazon RDS Aurora database schema to retrieve table structures, colum | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | diff --git a/apps/docs/content/docs/integrations/reducto.mdx b/apps/docs/content/docs/integrations/reducto.mdx index f22dbf6bc94..042674fabf7 100644 --- a/apps/docs/content/docs/integrations/reducto.mdx +++ b/apps/docs/content/docs/integrations/reducto.mdx @@ -2,7 +2,7 @@ title: Reducto description: Extract text from PDF documents integration: - type: "reducto_v2" + type: "reducto_v3" color: "#5c0c5c" --- @@ -32,7 +32,6 @@ Parse PDF documents using Reducto OCR API | `file` | file | Yes | PDF document to be processed | | `pages` | array | No | Specific pages to process \(1-indexed page numbers\) | | `tableOutputFormat` | string | No | Table output format \(`md` for Markdown or `html` for HTML\). Defaults to `md`. | -| `apiKey` | string | Yes | Reducto API key \(REDUCTO_API_KEY\) | #### Output diff --git a/apps/docs/content/docs/integrations/rippling.mdx b/apps/docs/content/docs/integrations/rippling.mdx index 7e3fcd8c845..39e4bc686b4 100644 --- a/apps/docs/content/docs/integrations/rippling.mdx +++ b/apps/docs/content/docs/integrations/rippling.mdx @@ -2,7 +2,7 @@ title: Rippling description: Manage workers, departments, custom objects, and company data in Rippling integration: - type: "rippling" + type: "rippling_v2" color: "#502D3C" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [Rippling](https://www.rippling.com/) to read workforce data, manage organizational resources and custom objects, and configure custom apps and pages. Connect with an API key. Reporting actions start a report run and retrieve its result; Create Draft Hires submits employees to the onboarding flow. +Use [Rippling](https://www.rippling.com/) to read workforce data, manage organizational resources and custom objects, and configure custom apps and pages. Connect with a saved Rippling API token. Reporting actions start a report run and retrieve its result; Create Draft Hires submits employees to the onboarding flow. {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] @@ -29,7 +29,6 @@ List all workers with optional filtering and pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `filter` | string | No | Filter expression | | `expand` | string | No | Comma-separated fields to expand | | `orderBy` | string | No | Sort field. Prefix with - for descending | @@ -88,7 +87,6 @@ Get a specific worker by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | | `expand` | string | No | Comma-separated fields to expand | @@ -142,7 +140,6 @@ List all users with optional pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -182,7 +179,6 @@ Get a specific user by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -218,7 +214,6 @@ List all companies | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `expand` | string | No | Comma-separated fields to expand | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -255,7 +250,6 @@ Get SSO information for the current user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `expand` | string | No | Comma-separated fields to expand | #### Output @@ -281,7 +275,6 @@ List all entitlements | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | #### Output @@ -307,7 +300,6 @@ List all departments | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `expand` | string | No | Comma-separated fields to expand | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -342,7 +334,6 @@ Get a specific department by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | | `expand` | string | No | Comma-separated fields to expand | @@ -373,7 +364,6 @@ Create a new department | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | Department name | | `parentId` | string | No | Parent department ID | | `referenceCode` | string | No | Reference code | @@ -404,7 +394,6 @@ Update an existing department | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Department ID | | `name` | string | No | Department name | | `parentId` | string | No | Parent department ID | @@ -436,7 +425,6 @@ List all teams | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `expand` | string | No | Comma-separated fields to expand | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -468,7 +456,6 @@ Get a specific team by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | | `expand` | string | No | Comma-separated fields to expand | @@ -496,7 +483,6 @@ List all employment types | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -529,7 +515,6 @@ Get a specific employment type by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -558,7 +543,6 @@ List all titles | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -587,7 +571,6 @@ Get a specific title by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -612,7 +595,6 @@ Create a new title | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | Title name | #### Output @@ -636,7 +618,6 @@ Update an existing title | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Title ID | | `name` | string | No | Title name | @@ -661,7 +642,6 @@ Delete a title | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -682,7 +662,6 @@ List all custom fields | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -714,7 +693,6 @@ List all job functions | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -743,7 +721,6 @@ Get a specific job function by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -768,7 +745,6 @@ List all work locations | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -798,7 +774,6 @@ Get a specific work location by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -824,7 +799,6 @@ Create a new work location | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | Location name | | `streetAddress` | string | Yes | Street address | | `locality` | string | No | City | @@ -855,7 +829,6 @@ Update a work location | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Location ID | | `name` | string | No | Location name | | `streetAddress` | string | No | Street address | @@ -887,7 +860,6 @@ Delete a work location | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -908,7 +880,6 @@ List all business partners | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `filter` | string | No | Filter expression | | `expand` | string | No | Comma-separated fields to expand | | `orderBy` | string | No | Sort field. Prefix with - for descending | @@ -942,7 +913,6 @@ Get a specific business partner by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | | `expand` | string | No | Comma-separated fields to expand | @@ -971,7 +941,6 @@ Create a new business partner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `businessPartnerGroupId` | string | Yes | Business partner group ID | | `workerId` | string | Yes | Worker ID | @@ -999,7 +968,6 @@ Delete a business partner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -1020,7 +988,6 @@ List all business partner groups | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `expand` | string | No | Comma-separated fields to expand | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -1052,7 +1019,6 @@ Get a specific business partner group by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | | `expand` | string | No | Comma-separated fields to expand | @@ -1080,7 +1046,6 @@ Create a new business partner group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | Group name | | `domain` | string | No | Domain \(HR, IT, FINANCE, RECRUITING, OTHER\) | | `defaultBusinessPartnerId` | string | No | Default business partner ID | @@ -1108,7 +1073,6 @@ Delete a business partner group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -1129,7 +1093,6 @@ List all supergroups | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `filter` | string | No | Filter expression \(filterable fields: app_owner_id, group_type\) | | `orderBy` | string | No | Sort field. Prefix with - for descending | @@ -1173,7 +1136,6 @@ Get a specific supergroup by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -1213,7 +1175,6 @@ List members of a supergroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `groupId` | string | Yes | Supergroup ID | | `expand` | string | No | Fields to expand \(e.g., worker\) | | `orderBy` | string | No | Sort field | @@ -1246,7 +1207,6 @@ List inclusion members of a supergroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `groupId` | string | Yes | Supergroup ID | | `expand` | string | No | Fields to expand \(e.g., worker\) | | `orderBy` | string | No | Sort field | @@ -1279,7 +1239,6 @@ List exclusion members of a supergroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `groupId` | string | Yes | Supergroup ID | | `expand` | string | No | Fields to expand \(e.g., worker\) | | `orderBy` | string | No | Sort field | @@ -1312,7 +1271,6 @@ Update inclusion members of a supergroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `groupId` | string | Yes | Supergroup ID | | `operations` | json | Yes | Operations array \[\{op: "add"\|"remove", value: \[\{id: "member_id"\}\]\}\] | @@ -1334,7 +1292,6 @@ Update exclusion members of a supergroup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `groupId` | string | Yes | Supergroup ID | | `operations` | json | Yes | Operations array \[\{op: "add"\|"remove", value: \[\{id: "member_id"\}\]\}\] | @@ -1356,7 +1313,6 @@ List all custom objects | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | #### Output @@ -1390,7 +1346,6 @@ Get a custom object by API name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | custom object api name | #### Output @@ -1422,7 +1377,6 @@ Create a new custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | Object name | | `description` | string | No | Description | | `category` | string | No | Category | @@ -1456,7 +1410,6 @@ Update a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `name` | string | No | Name | | `description` | string | No | Description | @@ -1493,7 +1446,6 @@ Delete a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | ID of the resource to delete | #### Output @@ -1514,7 +1466,6 @@ List all fields for a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | #### Output @@ -1550,7 +1501,6 @@ Get a specific field of a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `fieldApiName` | string | Yes | Field API name | @@ -1584,7 +1534,6 @@ Create a field on a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `name` | string | Yes | Field name | | `description` | string | No | Description | @@ -1628,7 +1577,6 @@ Update a field on a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `fieldApiName` | string | Yes | Field API name | | `name` | string | No | Field name | @@ -1673,7 +1621,6 @@ Delete a field from a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `fieldApiName` | string | Yes | Field API name | @@ -1695,7 +1642,6 @@ List all records for a custom object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | #### Output @@ -1728,7 +1674,6 @@ Get a specific custom object record | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `codrId` | string | Yes | Record ID | @@ -1759,7 +1704,6 @@ Get a custom object record by external ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `externalId` | string | Yes | External ID | @@ -1790,7 +1734,6 @@ Query custom object records with filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `query` | string | No | Query expression | | `limit` | number | No | Maximum number of records to return | @@ -1826,7 +1769,6 @@ Create a custom object record | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `externalId` | string | No | External ID for the record | | `data` | json | Yes | Record data | @@ -1858,7 +1800,6 @@ Update a custom object record | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `codrId` | string | Yes | Record ID | | `externalId` | string | No | External ID for the record | @@ -1891,7 +1832,6 @@ Delete a custom object record | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `codrId` | string | Yes | Record ID | @@ -1913,7 +1853,6 @@ Bulk create custom object records | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `rowsToWrite` | json | Yes | Array of records to create \[\{external_id?, data\}\] | | `allOrNothing` | boolean | No | If true, fail entire batch on any error | @@ -1937,7 +1876,6 @@ Bulk update custom object records | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `rowsToUpdate` | json | Yes | Array of records to update | | `allOrNothing` | boolean | No | If true, fail entire batch on any error | @@ -1961,7 +1899,6 @@ Bulk delete custom object records | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `customObjectApiName` | string | Yes | Custom object API name | | `rowsToDelete` | json | Yes | Array of records to delete | | `allOrNothing` | boolean | No | If true, fail entire batch on any error | @@ -1984,7 +1921,6 @@ List all custom apps | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | #### Output @@ -2015,7 +1951,6 @@ Get a specific custom app | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -2044,7 +1979,6 @@ Create a new custom app | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | App name | | `apiName` | string | Yes | API name | | `description` | string | No | Description | @@ -2074,7 +2008,6 @@ Update a custom app | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | App ID | | `name` | string | No | App name | | `apiName` | string | No | API name | @@ -2105,7 +2038,6 @@ Delete a custom app | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -2126,7 +2058,6 @@ List all custom pages | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | #### Output @@ -2158,7 +2089,6 @@ Get a specific custom page | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -2188,7 +2118,6 @@ Create a new custom page | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | Page name | #### Output @@ -2217,7 +2146,6 @@ Update a custom page | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Page ID | | `name` | string | No | Page name | @@ -2247,7 +2175,6 @@ Delete a custom page | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -2268,7 +2195,6 @@ List all custom settings | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `orderBy` | string | No | Sort field. Prefix with - for descending | | `cursor` | string | No | Pagination cursor from previous response | @@ -2303,7 +2229,6 @@ Get a specific custom setting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -2334,7 +2259,6 @@ Create a new custom setting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `displayName` | string | No | Display name | | `apiName` | string | No | Unique API name | | `dataType` | string | No | Data type of the setting | @@ -2370,7 +2294,6 @@ Update a custom setting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Setting ID | | `displayName` | string | No | Display name | | `apiName` | string | No | Unique API name | @@ -2407,7 +2330,6 @@ Delete a custom setting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -2428,7 +2350,6 @@ List all object categories | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | #### Output @@ -2455,7 +2376,6 @@ Get a specific object category | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Resource ID | #### Output @@ -2480,7 +2400,6 @@ Create a new object category | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `name` | string | Yes | Category name | | `description` | string | No | Description | @@ -2506,7 +2425,6 @@ Update an object category | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | Category ID | | `name` | string | No | Category name | | `description` | string | No | Description | @@ -2533,7 +2451,6 @@ Delete an object category | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `id` | string | Yes | ID of the resource to delete | #### Output @@ -2554,7 +2471,6 @@ Get a report run by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `runId` | string | Yes | run id | #### Output @@ -2581,7 +2497,6 @@ Trigger a new report run | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `reportId` | string | Yes | Report ID to run | | `includeObjectIds` | boolean | No | Include object IDs in the report | | `includeTotalRows` | boolean | No | Include total row count | @@ -2612,7 +2527,6 @@ Create bulk draft hires | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rippling API key | | `draftHires` | json | Yes | Array of draft hire objects | #### Output diff --git a/apps/docs/content/docs/integrations/rocketlane.mdx b/apps/docs/content/docs/integrations/rocketlane.mdx index 45ae4072bbd..2c65ece8311 100644 --- a/apps/docs/content/docs/integrations/rocketlane.mdx +++ b/apps/docs/content/docs/integrations/rocketlane.mdx @@ -2,7 +2,7 @@ title: Rocketlane description: Manage client onboarding projects, tasks, time tracking, and invoices integration: - type: "rocketlane" + type: "rocketlane_v2" color: "#000000" --- @@ -31,7 +31,6 @@ Create a new Rocketlane project with a customer, owner, dates, team members, tem | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectName` | string | Yes | Name of the project | | `customerCompanyName` | string | Yes | Name of the customer company \(case-sensitive exact match; cannot be changed after creation\) | | `ownerUserId` | number | No | User ID of the project owner \(either ownerUserId or ownerEmailId must be provided\) | @@ -185,7 +184,6 @@ Retrieve a Rocketlane project by its unique identifier | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project | | `includeFields` | string | No | Comma-separated extra fields to return in the response \(e.g. budgetedHours,progressPercentage\) | | `includeAllFields` | boolean | No | Return all fields in the response body | @@ -309,7 +307,6 @@ List Rocketlane projects with optional filters, sorting, and token-based paginat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `pageSize` | number | No | Maximum number of projects per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous response \(valid for 15 minutes\) | | `includeFields` | string | No | Comma-separated extra fields to return in the response \(e.g. budgetedHours,progressPercentage\) | @@ -456,7 +453,6 @@ Update a Rocketlane project by ID, including name, dates, visibility, owner, sta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project to update | | `projectName` | string | No | New name of the project | | `startDate` | string | No | Date on which the project begins \(YYYY-MM-DD\) | @@ -593,7 +589,6 @@ Archive a Rocketlane project by ID, making it dormant while preserving its detai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project to archive | #### Output @@ -615,7 +610,6 @@ Permanently delete a Rocketlane project by ID (irreversible; only Admins, Super | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project to delete | #### Output @@ -637,7 +631,6 @@ Add team members and customer stakeholders to a Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project | | `memberUserIds` | array | No | User IDs of team members from your organization to add | | `memberEmailIds` | array | No | Emails of team members from your organization to add | @@ -763,7 +756,6 @@ Remove team members from a Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project | | `memberUserIds` | array | No | User IDs of team members to remove \(at least one of memberUserIds or memberEmailIds is required\) | | `memberEmailIds` | array | No | Emails of team members to remove \(at least one of memberUserIds or memberEmailIds is required\) | @@ -887,7 +879,6 @@ Import a project template into an existing Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project to import the template into | | `templateId` | number | Yes | Unique identifier of the template to import | | `startDate` | string | Yes | Date on which the template goes into effect for the project \(YYYY-MM-DD\) | @@ -1012,7 +1003,6 @@ List the placeholders of a Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project | #### Output @@ -1049,7 +1039,6 @@ Assign a placeholder in a Rocketlane project to a user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project | | `placeholderId` | number | Yes | Unique identifier of the placeholder to assign | | `userId` | number | No | User ID of the project member to assign \(either userId or userEmailId must be provided; must be a customer user for CUSTOMER placeholders\) | @@ -1189,7 +1178,6 @@ Unassign a placeholder from its user in a Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | Unique identifier of the project | | `placeholderId` | number | Yes | Unique identifier of the placeholder to unassign | @@ -1327,7 +1315,6 @@ Create a new task in a Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskName` | string | Yes | Name of the task | | `projectId` | number | Yes | ID of the project the task belongs to | | `taskDescription` | string | No | Description of the task in HTML format | @@ -1444,7 +1431,6 @@ Retrieve detailed information about a Rocketlane task by its unique identifier | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to retrieve | | `includeFields` | array | No | Extra fields to include in the response \(startDateActual, dueDateActual, type, phase, assignees, followers, dependencies, billable, csatEnabled, priority, timeEntryCategory, financialsBudget, taskPrivateNote, parent, externalReferenceId\) | | `includeAllFields` | boolean | No | Whether all fields should be returned in the response | @@ -1543,7 +1529,6 @@ Retrieve all Rocketlane tasks with optional filters, sorting, and pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `pageSize` | number | No | Number of tasks per page \(defaults to 100\) | | `pageToken` | string | No | Token pointing to the next page of results, from a previous response | | `includeFields` | array | No | Extra fields to include in the response \(startDateActual, dueDateActual, type, phase, assignees, followers, dependencies, billable, csatEnabled, priority, timeEntryCategory, financialsBudget, taskPrivateNote, parent, externalReferenceId\) | @@ -1662,7 +1647,6 @@ Update the properties of an existing Rocketlane task by its unique identifier | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to update | | `taskName` | string | No | New name of the task | | `taskDescription` | string | No | Description of the task in HTML format | @@ -1773,7 +1757,6 @@ Permanently delete a Rocketlane task by its unique identifier | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to delete | #### Output @@ -1795,7 +1778,6 @@ Move a Rocketlane task to a given phase, associating the task with that phase | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to move | | `phaseId` | number | Yes | Unique identifier of the phase to move the task to | @@ -1893,7 +1875,6 @@ Add members as assignees to a Rocketlane task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to add assignees to | | `memberUserIds` | array | No | User IDs of members to add as assignees | | `memberEmailIds` | array | No | Email addresses of members to add as assignees | @@ -1992,7 +1973,6 @@ Remove assignees from a Rocketlane task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to remove assignees from | | `memberUserIds` | array | No | User IDs of members to remove from the assignees | | `memberEmailIds` | array | No | Email addresses of members to remove from the assignees | @@ -2091,7 +2071,6 @@ Add members as followers to a Rocketlane task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to add followers to | | `memberUserIds` | array | No | User IDs of members to add as followers | | `memberEmailIds` | array | No | Email addresses of members to add as followers | @@ -2190,7 +2169,6 @@ Remove followers from a Rocketlane task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to remove followers from | | `memberUserIds` | array | No | User IDs of members to remove from the followers | | `memberEmailIds` | array | No | Email addresses of members to remove from the followers | @@ -2289,7 +2267,6 @@ Add finish-to-start dependencies between a Rocketlane task and other tasks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to add dependencies to | | `dependencyTaskIds` | array | Yes | Task IDs the task should depend on | @@ -2387,7 +2364,6 @@ Remove dependencies from a Rocketlane task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `taskId` | number | Yes | Unique identifier of the task to remove dependencies from | | `dependencyTaskIds` | array | Yes | Task IDs to remove from the task dependencies | @@ -2485,7 +2461,6 @@ Create a new phase in a Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `phaseName` | string | Yes | Name of the phase | | `projectId` | number | Yes | ID of the project to create the phase in | | `startDate` | string | Yes | Planned start date of the phase \(YYYY-MM-DD\) | @@ -2538,7 +2513,6 @@ Retrieve a single Rocketlane phase by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `phaseId` | number | Yes | ID of the phase to retrieve | | `includeFields` | string | No | Comma-separated extra phase properties to include in the response \(supported: startDateActual, dueDateActual\) | | `includeAllFields` | boolean | No | Whether to return all phase properties in the response | @@ -2586,7 +2560,6 @@ List phases of a Rocketlane project, with optional filters, sorting, and paginat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | ID of the project to list phases for | | `pageSize` | number | No | Number of phases per page | | `pageToken` | string | No | Page token returned by a previous request \(valid for 15 minutes\) | @@ -2645,7 +2618,6 @@ Update the name, dates, status, or privacy of an existing Rocketlane phase | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `phaseId` | number | Yes | ID of the phase to update | | `phaseName` | string | No | New name of the phase | | `startDate` | string | No | New planned start date of the phase \(YYYY-MM-DD\) | @@ -2698,7 +2670,6 @@ Permanently delete a Rocketlane phase by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `phaseId` | number | Yes | ID of the phase to delete | #### Output @@ -2720,7 +2691,6 @@ Create a custom field in your Rocketlane account, with options for SINGLE_CHOICE | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `fieldLabel` | string | Yes | Name of the field | | `fieldType` | string | Yes | Type of the field \(TEXT, MULTI_LINE_TEXT, YES_OR_NO, DATE, SINGLE_CHOICE, MULTIPLE_CHOICE, SINGLE_USER, MULTIPLE_USER, NUMBER, NOTE, RATING\) | | `objectType` | string | Yes | Object the field is associated with \(PROJECT, TASK, or USER\) | @@ -2774,7 +2744,6 @@ Retrieve a single Rocketlane field by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `fieldId` | number | Yes | ID of the field to retrieve | | `includeFields` | string | No | Comma-separated extra field properties to include in the response \(supported: options\) | | `includeAllFields` | boolean | No | Whether to return all field properties in the response | @@ -2821,7 +2790,6 @@ List fields in your Rocketlane account, with optional filters, sorting, and pagi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `pageSize` | number | No | Number of fields per page | | `pageToken` | string | No | Page token returned by a previous request \(valid for 15 minutes\) | | `includeFields` | string | No | Comma-separated extra field properties to include in the response \(supported: options\) | @@ -2881,7 +2849,6 @@ Update the label, description, enabled state, or privacy of an existing Rocketla | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `fieldId` | number | Yes | ID of the field to update | | `fieldLabel` | string | No | New name of the field | | `fieldDescription` | string | No | New description of the field | @@ -2932,7 +2899,6 @@ Permanently delete a Rocketlane field by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `fieldId` | number | Yes | ID of the field to delete | #### Output @@ -2954,7 +2920,6 @@ Add a new option to an existing SINGLE_CHOICE or MULTIPLE_CHOICE Rocketlane fiel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `fieldId` | number | Yes | ID of the field to add the option to | | `optionLabel` | string | Yes | Display label of the new option | | `optionColor` | string | Yes | Color of the new option \(RED, YELLOW, GREEN, TEAL, CYAN, BLUE, PURPLE, MAGENTA, GRAY, COOL_GRAY\) | @@ -2980,7 +2945,6 @@ Update the label or color of an existing option on a SINGLE_CHOICE or MULTIPLE_C | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `fieldId` | number | Yes | ID of the field the option belongs to | | `optionValue` | number | Yes | Unique identifier of the option to update | | `optionLabel` | string | No | New display label of the option | @@ -3007,7 +2971,6 @@ Create a time entry in Rocketlane against an adhoc activity, task, project phase | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `date` | string | Yes | Date of the time entry in YYYY-MM-DD format | | `minutes` | number | Yes | Duration of the time entry in minutes \(1-1440\) | | `activityName` | string | No | Name of the adhoc activity to track time against. Exactly one source is required among activityName, taskId, projectPhaseId, and projectId — providing more than one results in an error | @@ -3107,7 +3070,6 @@ Get a single Rocketlane time entry by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `timeEntryId` | number | Yes | ID of the time entry to retrieve | | `includeFields` | string | No | Comma-separated extra fields to include in the response \(notes, sourceType, deleted, status, submittedBy, submittedAt, approvedBy, approvedAt, rejectedBy, rejectedAt, costRate, billRate\) | | `includeAllFields` | boolean | No | Whether all fields should be returned in the response | @@ -3197,7 +3159,6 @@ List Rocketlane time entries with optional filters, sorting, and cursor-based pa | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `dateEq` | string | No | Only entries on this exact date \(YYYY-MM-DD\) | | `dateGt` | string | No | Only entries after this date \(YYYY-MM-DD\) | | `dateGe` | string | No | Only entries on or after this date \(YYYY-MM-DD\) | @@ -3320,7 +3281,6 @@ Search Rocketlane time entries with filters, sorting, and pagination (deprecated | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `dateEq` | string | No | Only entries on this exact date \(YYYY-MM-DD\) | | `dateGt` | string | No | Only entries after this date \(YYYY-MM-DD\) | | `dateGe` | string | No | Only entries on or after this date \(YYYY-MM-DD\) | @@ -3433,7 +3393,6 @@ Update a Rocketlane time entry by ID. The activityName, notes, billable, and min | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `timeEntryId` | number | Yes | ID of the time entry to update | | `date` | string | Yes | Date of the time entry in YYYY-MM-DD format \(mandatory so the total time for the date does not exceed 24 hours\) | | `minutes` | number | Yes | Duration of the time entry in minutes \(1-1440\) | @@ -3529,7 +3488,6 @@ Permanently delete a Rocketlane time entry by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `timeEntryId` | number | Yes | ID of the time entry to delete | #### Output @@ -3551,7 +3509,6 @@ List the time entry categories configured in Rocketlane | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `pageSize` | number | No | Maximum number of categories per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous response for fetching the next page | @@ -3580,7 +3537,6 @@ Create a time-off for a team member in Rocketlane. Holidays and weekends within | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `userId` | number | No | User ID of the team member taking the time-off \(provide this or the user email\) | | `userEmail` | string | No | Email of the team member taking the time-off \(provide this or the user ID\) | | `startDate` | string | Yes | Time-off start date in YYYY-MM-DD format | @@ -3636,7 +3592,6 @@ Retrieve a Rocketlane time-off by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `timeOffId` | number | Yes | Unique identifier of the time-off | | `includeFields` | array | No | Optional fields to include in the response: note, notifyUsers | | `includeAllFields` | boolean | No | Return all fields in the response | @@ -3683,7 +3638,6 @@ List time-offs in Rocketlane with optional date, type, and user filters, sorting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `pageSize` | number | No | Maximum number of time-offs per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous response \(valid for 15 minutes\) | | `includeFields` | array | No | Optional fields to include in the response: note, notifyUsers | @@ -3758,7 +3712,6 @@ Permanently delete a Rocketlane time-off by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `timeOffId` | number | Yes | Unique identifier of the time-off to delete | #### Output @@ -3780,7 +3733,6 @@ Retrieve a Rocketlane user by their ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `userId` | number | Yes | ID of the user to retrieve | | `includeFields` | string | No | Comma-separated extra fields to include: role, company, permission, holidayCalendar, capacityInMinutes, profilePictureUrl | | `includeAllFields` | boolean | No | Whether to include all fields in the response | @@ -3840,7 +3792,6 @@ List users in your Rocketlane account, with optional filters, sorting, and pagin | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `pageSize` | number | No | Maximum number of users per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous request \(valid for 15 minutes\) | | `includeFields` | string | No | Comma-separated extra fields to include: role, company, permission, holidayCalendar, capacityInMinutes, profilePictureUrl | @@ -3944,7 +3895,6 @@ Create a new space in a Rocketlane project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | ID of the project the space belongs to | | `spaceName` | string | Yes | Name of the space | | `private` | boolean | No | Whether the space is private or shared \(defaults to false\) | @@ -3985,7 +3935,6 @@ Retrieve a Rocketlane space by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `spaceId` | number | Yes | ID of the space to retrieve | #### Output @@ -4024,7 +3973,6 @@ List spaces in a Rocketlane project, with optional filters, sorting, and paginat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | ID of the project whose spaces to list | | `pageSize` | number | No | Maximum number of spaces per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous request \(valid for 15 minutes\) | @@ -4086,7 +4034,6 @@ Update a Rocketlane space by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `spaceId` | number | Yes | ID of the space to update | | `spaceName` | string | No | New name of the space | @@ -4126,7 +4073,6 @@ Permanently delete a Rocketlane space by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `spaceId` | number | Yes | ID of the space to delete | #### Output @@ -4148,7 +4094,6 @@ Create a new space document in a Rocketlane space | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `spaceId` | number | Yes | ID of the space the document belongs to | | `spaceDocumentType` | string | Yes | Type of the space document: ROCKETLANE_DOCUMENT or EMBEDDED_DOCUMENT | | `spaceDocumentName` | string | No | Name of the space document \(defaults to Untitled\) | @@ -4196,7 +4141,6 @@ Retrieve a Rocketlane space document by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `spaceDocumentId` | number | Yes | ID of the space document to retrieve | #### Output @@ -4240,7 +4184,6 @@ List space documents in a Rocketlane project, with optional filters, sorting, an | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `projectId` | number | Yes | ID of the project whose space documents to list | | `pageSize` | number | No | Maximum number of space documents per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous request \(valid for 15 minutes\) | @@ -4308,7 +4251,6 @@ Update a Rocketlane space document by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `spaceDocumentId` | number | Yes | ID of the space document to update | | `spaceDocumentName` | string | No | New name of the space document | | `url` | string | No | New URL to embed in the space document \(for embedded documents\) | @@ -4354,7 +4296,6 @@ Permanently delete a Rocketlane space document by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `spaceDocumentId` | number | Yes | ID of the space document to delete | #### Output @@ -4376,7 +4317,6 @@ List resource allocations in Rocketlane within a date range, with optional membe | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `startDate` | string | Yes | Return allocations that start on or after this date \(YYYY-MM-DD\) | | `endDate` | string | Yes | Return allocations that end on or before this date \(YYYY-MM-DD\) | | `pageSize` | number | No | Maximum number of allocations per page \(defaults to 100\) | @@ -4463,7 +4403,6 @@ Retrieve a Rocketlane invoice by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `invoiceId` | number | Yes | Unique identifier of the invoice | | `includeFields` | array | No | Optional fields to include in the response: notes, attachments | | `includeAllFields` | boolean | No | Return all fields in the response | @@ -4530,7 +4469,6 @@ Search invoices in Rocketlane with date, amount, company, invoice-number, and st | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `pageSize` | number | No | Maximum number of invoices per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous response \(valid for 15 minutes\) | | `includeFields` | array | No | Optional fields to include in the response: notes, attachments | @@ -4650,7 +4588,6 @@ List line items of a Rocketlane invoice | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `invoiceId` | number | Yes | Unique identifier of the invoice | | `pageSize` | number | No | Maximum number of line items per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous response \(valid for 15 minutes\) | @@ -4696,7 +4633,6 @@ List payments recorded against a Rocketlane invoice | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Rocketlane API key | | `invoiceId` | number | Yes | Unique identifier of the invoice | | `pageSize` | number | No | Maximum number of payments per page \(defaults to 100\) | | `pageToken` | string | No | Page token from a previous response \(valid for 15 minutes\) | diff --git a/apps/docs/content/docs/integrations/s3.mdx b/apps/docs/content/docs/integrations/s3.mdx index ba5e8c119f1..232b598899d 100644 --- a/apps/docs/content/docs/integrations/s3.mdx +++ b/apps/docs/content/docs/integrations/s3.mdx @@ -2,7 +2,7 @@ title: S3 description: Upload, download, list, and manage S3 files and buckets integration: - type: "s3" + type: "s3_v2" color: "linear-gradient(45deg, #1B660F 0%, #6CAE3E 100%)" --- @@ -10,12 +10,12 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [Amazon S3](https://aws.amazon.com/s3/) to manage objects and buckets from a workflow. Upload, download, copy, or delete objects, inspect metadata, and create time-limited presigned URLs. Configure an AWS access key and secret access key. +Use [Amazon S3](https://aws.amazon.com/s3/) to manage objects and buckets from a workflow. Upload, download, copy, or delete objects, inspect metadata, and create time-limited presigned URLs. Connect with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Upload, download, copy, and delete objects (individually or in batches), inspect object metadata, generate time-limited presigned URLs, list bucket contents, and create, list, or delete buckets. Requires AWS access key and secret access key. +Upload, download, copy, and delete objects (individually or in batches), inspect object metadata, generate time-limited presigned URLs, list bucket contents, and create, list, or delete buckets. ## Actions @@ -29,8 +29,6 @@ Upload a file to an AWS S3 bucket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `objectKey` | string | Yes | Object key/path in S3 \(e.g., folder/filename.ext\) | @@ -59,8 +57,6 @@ Retrieve an object from an AWS S3 bucket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | No | Optional region override when URL does not include region \(e.g., us-east-1, eu-west-1\) | | `s3Uri` | string | Yes | S3 Object URL \(e.g., https://bucket.s3.region.amazonaws.com/path/to/file) | @@ -84,8 +80,6 @@ List objects in an AWS S3 bucket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `prefix` | string | No | Prefix to filter objects \(e.g., folder/, images/2024/\) | @@ -115,8 +109,6 @@ Delete an object from an AWS S3 bucket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `objectKey` | string | Yes | Object key/path to delete \(e.g., folder/file.txt\) | @@ -140,8 +132,6 @@ Copy an object within or between AWS S3 buckets | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `sourceBucket` | string | Yes | Source bucket name \(e.g., my-bucket\) | | `sourceKey` | string | Yes | Source object key/path \(e.g., folder/file.txt\) | @@ -169,8 +159,6 @@ List the S3 buckets owned by the authenticated AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region to address the request to \(e.g., us-east-1\) | | `prefix` | string | No | Limit the response to bucket names that begin with this prefix | | `maxBuckets` | number | No | Maximum number of buckets to return \(1-10000\) | @@ -198,8 +186,6 @@ Retrieve metadata for an S3 object without downloading its body | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `objectKey` | string | Yes | Object key/path to inspect \(e.g., folder/file.txt\) | @@ -224,8 +210,6 @@ Create a new AWS S3 bucket in the specified region | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region to create the bucket in \(e.g., us-east-1\) | | `bucketName` | string | Yes | Name for the new S3 bucket \(must be globally unique\) | | `acl` | string | No | Canned ACL for the bucket \(e.g., private, public-read\) | @@ -248,8 +232,6 @@ Delete an empty AWS S3 bucket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region where the bucket is located \(e.g., us-east-1\) | | `bucketName` | string | Yes | Name of the S3 bucket to delete \(must be empty\) | @@ -272,8 +254,6 @@ Generate a time-limited presigned URL to download or upload an S3 object | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region where the bucket is located \(e.g., us-east-1\) | | `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `objectKey` | string | Yes | Object key/path for the presigned URL \(e.g., folder/file.txt\) | @@ -300,8 +280,6 @@ Delete multiple objects from an AWS S3 bucket in a single batch request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | Your AWS Access Key ID | -| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `keys` | json | Yes | Array of object keys to delete \(e.g., \["a.txt", "folder/b.txt"\]\). Max 1000. | diff --git a/apps/docs/content/docs/integrations/secrets_manager.mdx b/apps/docs/content/docs/integrations/secrets_manager.mdx index d2f373a90ab..06e16ad4ee9 100644 --- a/apps/docs/content/docs/integrations/secrets_manager.mdx +++ b/apps/docs/content/docs/integrations/secrets_manager.mdx @@ -2,7 +2,7 @@ title: AWS Secrets Manager description: Connect to AWS Secrets Manager integration: - type: "secrets_manager" + type: "secrets_manager_v2" color: "linear-gradient(45deg, #BD0816 0%, #FF5252 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) to retrieve, create, update, list, describe, delete, restore, tag, untag, or rotate secrets. Configure AWS credentials with permission for the target region and secret. +Use [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) to retrieve, create, update, list, describe, delete, restore, tag, untag, or rotate secrets. Connect with a saved [AWS credential](/integrations/aws-credentials) that has permission for the target region and secret. Deletion and rotation affect credentials used by other systems. Review the selected operation's recovery window and rotation settings before running it. Secret values returned by these actions are available to later workflow steps; handle them as credentials. {/* MANUAL-CONTENT-END */} @@ -32,8 +32,6 @@ Retrieve a secret value from AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to retrieve | | `versionId` | string | No | The unique identifier of the version to retrieve | | `versionStage` | string | No | The staging label of the version to retrieve \(e.g., AWSCURRENT, AWSPREVIOUS\) | @@ -62,8 +60,6 @@ List secrets stored in AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `maxResults` | number | No | Maximum number of secrets to return \(1-100, default 100\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -88,8 +84,6 @@ Create a new secret in AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Name of the secret to create | | `secretValue` | string | Yes | The secret value \(plain text or JSON string\) | | `description` | string | No | Description of the secret | @@ -116,8 +110,6 @@ Update the value of an existing secret in AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to update | | `secretValue` | string | Yes | The new secret value \(plain text or JSON string\) | | `description` | string | No | Updated description of the secret | @@ -144,8 +136,6 @@ Delete a secret from AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to delete | | `recoveryWindowInDays` | number | No | Number of days before permanent deletion \(7-30, default 30\) | | `forceDelete` | boolean | No | If true, immediately delete without recovery window | @@ -172,8 +162,6 @@ Retrieve full metadata for a secret in AWS Secrets Manager, including rotation c | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to describe | #### Output @@ -212,8 +200,6 @@ Attach tags to a secret in AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to tag | | `tags` | json | Yes | Tags to attach, as an array of \{key, value\} pairs \(max 50\) | @@ -237,8 +223,6 @@ Remove tags from a secret in AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to untag | | `tagKeys` | json | Yes | Tag keys to remove, as an array of strings \(max 50\) | @@ -262,8 +246,6 @@ Cancel a scheduled deletion for a secret in AWS Secrets Manager, restoring acces | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to restore | #### Output @@ -287,8 +269,6 @@ Start or reconfigure rotation for a secret in AWS Secrets Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `secretId` | string | Yes | The name or ARN of the secret to rotate | | `clientRequestToken` | string | No | Idempotency token for the new secret version \(32-64 characters\) | | `rotationLambdaARN` | string | No | ARN of the Lambda function that performs rotation \(omit for managed rotation\) | diff --git a/apps/docs/content/docs/integrations/sendgrid.mdx b/apps/docs/content/docs/integrations/sendgrid.mdx index d1357144a95..869ebd7997b 100644 --- a/apps/docs/content/docs/integrations/sendgrid.mdx +++ b/apps/docs/content/docs/integrations/sendgrid.mdx @@ -2,7 +2,7 @@ title: SendGrid description: Send emails and manage contacts, lists, and templates with SendGrid integration: - type: "sendgrid" + type: "sendgrid_v2" color: "#1A82E2" --- @@ -29,7 +29,6 @@ Send an email using SendGrid API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `from` | string | Yes | Sender email address \(must be verified in SendGrid\) | | `fromName` | string | No | Sender name | | `to` | string | Yes | Recipient email address | @@ -66,7 +65,6 @@ Add a new contact to SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `email` | string | Yes | Contact email address | | `firstName` | string | No | Contact first name | | `lastName` | string | No | Contact last name | @@ -95,7 +93,6 @@ Get a specific contact by ID from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `contactId` | string | Yes | Contact ID | #### Output @@ -123,7 +120,6 @@ Search for contacts in SendGrid using a query | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `query` | string | Yes | Search query \(e.g., "email LIKE '%example.com%' AND CONTAINS\(list_ids, 'list-id'\)"\) | #### Output @@ -145,7 +141,6 @@ Delete one or more contacts from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `contactIds` | string | Yes | Comma-separated contact IDs to delete | #### Output @@ -166,7 +161,6 @@ Create a new contact list in SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `name` | string | Yes | List name | #### Output @@ -189,7 +183,6 @@ Get a specific list by ID from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `listId` | string | Yes | List ID | #### Output @@ -212,7 +205,6 @@ Get all contact lists from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `pageSize` | number | No | Number of lists to return per page \(default: 100, max: 1000\) | | `pageToken` | string | No | Page token from a previous response \(nextPageToken\) to fetch the next page | @@ -235,7 +227,6 @@ Delete a contact list from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `listId` | string | Yes | List ID to delete | #### Output @@ -256,7 +247,6 @@ Add or update contacts and assign them to a list in SendGrid (uses PUT /v3/marke | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `listId` | string | Yes | List ID to add contacts to | | `contacts` | json | Yes | JSON array of contact objects. Each contact must have at least: email \(or phone_number_id/external_id/anonymous_id\). Example: \[\{"email": "user@example.com", "first_name": "John"\}\] | @@ -279,7 +269,6 @@ Remove contacts from a specific list in SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `listId` | string | Yes | List ID | | `contactIds` | string | Yes | Comma-separated contact IDs to remove from the list | @@ -301,7 +290,6 @@ Create a new email template in SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `name` | string | Yes | Template name | | `generation` | string | No | Template generation type \(legacy or dynamic, default: dynamic\) | @@ -327,7 +315,6 @@ Get a specific template by ID from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `templateId` | string | Yes | Template ID | #### Output @@ -352,7 +339,6 @@ Get all email templates from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `generations` | string | No | Filter by generation \(legacy, dynamic, or both\) | | `pageSize` | number | No | Number of templates to return per page \(default: 20, max: 200\). When paginating with pageToken, pass the same pageSize used on the first request to keep page boundaries consistent. | | `pageToken` | string | No | Page token from a previous response \(nextPageToken\) to fetch the next page | @@ -376,7 +362,6 @@ Delete an email template from SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `templateId` | string | Yes | Template ID to delete | #### Output @@ -395,7 +380,6 @@ Create a new version of an email template in SendGrid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SendGrid API key | | `templateId` | string | Yes | Template ID | | `name` | string | Yes | Version name | | `subject` | string | Yes | Email subject line | diff --git a/apps/docs/content/docs/integrations/ses.mdx b/apps/docs/content/docs/integrations/ses.mdx index 1e5934752a0..3a9719dfd91 100644 --- a/apps/docs/content/docs/integrations/ses.mdx +++ b/apps/docs/content/docs/integrations/ses.mdx @@ -2,7 +2,7 @@ title: AWS SES description: Send emails and manage templates with AWS Simple Email Service integration: - type: "ses" + type: "ses_v2" color: "linear-gradient(45deg, #BD0816 0%, #FF5252 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [Amazon SES](https://aws.amazon.com/ses/) to send simple, templated, or bulk emails and manage templates, identities, configuration sets, and suppression lists. Account and identity actions report sending configuration and quotas. +Use [Amazon SES](https://aws.amazon.com/ses/) to send simple, templated, or bulk emails and manage templates, identities, configuration sets, and suppression lists. Account and identity actions report sending configuration and quotas. Connect with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] @@ -30,8 +30,6 @@ Send an email via AWS SES using simple or HTML content | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `fromAddress` | string | Yes | Verified sender email address | | `toAddresses` | string | Yes | Comma-separated list of recipient email addresses | | `subject` | string | Yes | Email subject line | @@ -61,8 +59,6 @@ Send an email using an SES email template with dynamic template data | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `fromAddress` | string | Yes | Verified sender email address | | `toAddresses` | string | Yes | Comma-separated list of recipient email addresses | | `templateName` | string | Yes | Name of the SES email template to use | @@ -90,8 +86,6 @@ Send emails to multiple recipients using an SES template with per-recipient data | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `fromAddress` | string | Yes | Verified sender email address | | `templateName` | string | Yes | Name of the SES email template to use | | `destinations` | string | Yes | JSON array of destination objects with toAddresses \(string\[\]\) and optional templateData \(JSON string\); falls back to defaultTemplateData when omitted | @@ -119,8 +113,6 @@ List all verified email identities (email addresses and domains) in your SES acc | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `pageSize` | number | No | Maximum number of identities to return \(1-1000\) | | `nextToken` | string | No | Pagination token from a previous list response | @@ -145,8 +137,6 @@ Get SES account sending quota and status information | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | #### Output @@ -170,8 +160,6 @@ Create a new SES email template for use with templated email sending | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `templateName` | string | Yes | Unique name for the email template | | `subjectPart` | string | Yes | Subject line template \(supports \{\{variable\}\} substitution\) | | `textPart` | string | No | Plain text version of the template body | @@ -196,8 +184,6 @@ Retrieve the content and details of an SES email template | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `templateName` | string | Yes | Name of the template to retrieve | #### Output @@ -222,8 +208,6 @@ List all SES email templates in your account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `pageSize` | number | No | Maximum number of templates to return | | `nextToken` | string | No | Pagination token from a previous list response | @@ -248,8 +232,6 @@ Delete an existing SES email template | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `templateName` | string | Yes | Name of the template to delete | #### Output @@ -271,8 +253,6 @@ Update the subject, HTML, and text content of an existing SES email template | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `templateName` | string | Yes | The name of the template to update | | `subjectPart` | string | Yes | The subject line of the template | | `htmlPart` | string | No | The HTML body of the template | @@ -297,8 +277,6 @@ Add an email address to the account-level SES suppression list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `emailAddress` | string | Yes | The email address to add to the suppression list | | `reason` | string | Yes | The reason the address is suppressed: BOUNCE or COMPLAINT | @@ -321,8 +299,6 @@ Remove an email address from the account-level SES suppression list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `emailAddress` | string | Yes | The email address to remove from the suppression list | #### Output @@ -344,8 +320,6 @@ Retrieve details for a specific email address on the SES suppression list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `emailAddress` | string | Yes | The suppressed email address to look up | #### Output @@ -371,8 +345,6 @@ List email addresses on the account-level SES suppression list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `reasons` | string | No | Comma-separated suppression reasons to filter by: BOUNCE, COMPLAINT | | `startDate` | string | No | Only include addresses suppressed after this ISO 8601 date | | `endDate` | string | No | Only include addresses suppressed before this ISO 8601 date | @@ -400,8 +372,6 @@ Start verification of a new SES email address or domain identity | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `emailIdentity` | string | Yes | The email address or domain to verify | | `dkimSigningAttributes` | json | No | Bring-your-own-DKIM signing attributes as JSON \(domainSigningSelector, domainSigningPrivateKey, nextSigningKeyLength\). Domain identities only. | | `tags` | json | No | JSON array of tags to associate with the identity: \[\{"key":"","value":""\}\] | @@ -428,8 +398,6 @@ Delete a verified SES email address or domain identity | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `emailIdentity` | string | Yes | The email address or domain identity to delete | #### Output @@ -451,8 +419,6 @@ Retrieve verification status, DKIM, Mail-From, and policy details for an SES ide | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `emailIdentity` | string | Yes | The email address or domain identity to look up | #### Output @@ -483,8 +449,6 @@ Create an SES configuration set to control tracking, delivery, reputation, sendi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `configurationSetName` | string | Yes | Name of the configuration set \(letters, numbers, hyphens, underscores\) | | `customRedirectDomain` | string | No | Custom domain to use for open/click tracking links | | `httpsPolicy` | string | No | HTTPS policy for tracking links: REQUIRE, REQUIRE_OPEN_ONLY, or OPTIONAL | @@ -514,8 +478,6 @@ Send a branded custom verification email to an address using a custom verificati | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `emailAddress` | string | Yes | The email address to verify | | `templateName` | string | Yes | The name of the custom verification email template to use | | `configurationSetName` | string | No | Configuration set to use when sending the verification email | diff --git a/apps/docs/content/docs/integrations/similarweb.mdx b/apps/docs/content/docs/integrations/similarweb.mdx index cf74d3d35ca..42007a6aa8d 100644 --- a/apps/docs/content/docs/integrations/similarweb.mdx +++ b/apps/docs/content/docs/integrations/similarweb.mdx @@ -2,7 +2,7 @@ title: Similarweb description: Website traffic and analytics data integration: - type: "similarweb" + type: "similarweb_v2" color: "#000922" --- @@ -31,7 +31,6 @@ Get website traffic, rankings, engagement, and traffic sources. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | #### Output @@ -71,7 +70,6 @@ Get total website visits over time (desktop and mobile combined) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | | `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | @@ -103,7 +101,6 @@ Get website bounce rate over time (desktop and mobile combined) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | | `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | @@ -135,7 +132,6 @@ Get average pages per visit over time (desktop and mobile combined) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | | `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | @@ -167,7 +163,6 @@ Get average desktop visit duration over time (in seconds) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | | `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | @@ -199,7 +194,6 @@ Get total page views over time (desktop and mobile combined) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | SimilarWeb API key | | `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | | `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | diff --git a/apps/docs/content/docs/integrations/sixtyfour.mdx b/apps/docs/content/docs/integrations/sixtyfour.mdx index 39dd2922e65..0be83662025 100644 --- a/apps/docs/content/docs/integrations/sixtyfour.mdx +++ b/apps/docs/content/docs/integrations/sixtyfour.mdx @@ -2,7 +2,7 @@ title: Sixtyfour AI description: Enrich leads and companies with AI-powered research integration: - type: "sixtyfour" + type: "sixtyfour_v2" color: "#000000" --- @@ -29,7 +29,6 @@ Find phone numbers for a lead using Sixtyfour AI. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sixtyfour API key | | `name` | string | Yes | Full name of the person | | `company` | string | No | Company name | | `linkedinUrl` | string | No | LinkedIn profile URL | @@ -57,7 +56,6 @@ Find email addresses for a lead using Sixtyfour AI. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sixtyfour API key | | `name` | string | Yes | Full name of the person | | `company` | string | No | Company name | | `linkedinUrl` | string | No | LinkedIn profile URL | @@ -96,7 +94,6 @@ Enrich lead information with contact details, social profiles, and company data | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sixtyfour API key | | `leadInfo` | string | Yes | Lead information as JSON object with key-value pairs \(e.g. name, company, title, linkedin\) | | `struct` | string | Yes | Fields to collect as JSON object. Keys are field names, values are descriptions \(e.g. \{"email": "The individual's email address", "phone": "Phone number"\}\) | | `researchPlan` | string | No | Optional research plan to guide enrichment strategy | @@ -122,7 +119,6 @@ Enrich company data with additional information and find associated people using | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sixtyfour API key | | `targetCompany` | string | Yes | Company data as JSON object \(e.g. \{"name": "Acme Inc", "domain": "acme.com"\}\) | | `struct` | string | Yes | Fields to collect as JSON object. Keys are field names, values are descriptions \(e.g. \{"website": "Company website URL", "num_employees": "Employee count"\}\) | | `findPeople` | boolean | No | Whether to find people associated with the company | diff --git a/apps/docs/content/docs/integrations/smartlead.mdx b/apps/docs/content/docs/integrations/smartlead.mdx index 4489b89fad6..648f73cc62d 100644 --- a/apps/docs/content/docs/integrations/smartlead.mdx +++ b/apps/docs/content/docs/integrations/smartlead.mdx @@ -2,7 +2,7 @@ title: Smartlead description: Manage Smartlead cold email campaigns, sequences, and leads integration: - type: "smartlead" + type: "smartlead_v2" color: "#000000" --- @@ -33,7 +33,6 @@ Retrieves all Smartlead campaigns for the authenticated account. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `clientId` | number | No | Only return campaigns for this client \(agency accounts\) | | `includeTags` | boolean | No | Include campaign tags in the response | @@ -148,7 +147,6 @@ Retrieves a single Smartlead campaign by ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -262,7 +260,6 @@ Creates a Smartlead campaign. The campaign starts in DRAFTED status; add sequenc | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `name` | string | Yes | Campaign name | | `clientId` | number | No | Client to own the campaign \(agency accounts\) | @@ -377,7 +374,6 @@ Starts, pauses, or stops a Smartlead campaign. START requires the campaign to al | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `status` | string | Yes | Target status: START, PAUSED, STOPPED | @@ -492,7 +488,6 @@ Sets the sending window, timezone, and throughput limits for a Smartlead campaig | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `timezone` | string | Yes | IANA timezone for the sending window, e.g. America/Los_Angeles | | `daysOfTheWeek` | array | Yes | Sending days as ISO weekday numbers, where 1 is Monday and 7 is Sunday | @@ -613,7 +608,6 @@ Updates tracking, stop-on-activity, and sending settings for a Smartlead campaig | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `trackSettings` | array | No | Tracking to disable. Allowed values: DONT_TRACK_EMAIL_OPEN, DONT_TRACK_LINK_CLICK, DONT_TRACK_REPLY_TO_AN_EMAIL | | `stopLeadSettings` | string | No | Lead activity that stops the sequence: REPLY_TO_AN_EMAIL, CLICK_ON_A_LINK, OPEN_AN_EMAIL | @@ -733,7 +727,6 @@ Retrieves lifetime performance totals for a Smartlead campaign — sends, opens, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -847,7 +840,6 @@ Retrieves Smartlead campaign performance totals for a date range. Smartlead reje | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `startDate` | string | Yes | Range start date in YYYY-MM-DD format | | `endDate` | string | Yes | Range end date in YYYY-MM-DD format | @@ -963,7 +955,6 @@ Retrieves the email sequence steps for a Smartlead campaign, including subjects, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -1077,7 +1068,6 @@ Replaces the email sequence for a Smartlead campaign. Send every step in one cal | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `sequences` | array | Yes | Ordered sequence steps. Each entry accepts seq_number, delay_in_days, subject, and email_body \(HTML\). Personalize with \{\{first_name\}\} or \{\{company_name\}\}. | @@ -1192,7 +1182,6 @@ Retrieves per-email statistics rows for a Smartlead campaign, filterable by sequ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `offset` | number | No | Pagination offset \(default 0\) | | `limit` | number | No | Rows to return \(default 100\) | @@ -1312,7 +1301,6 @@ Adds leads to a Smartlead campaign, up to 400 per call. Returns per-reason count | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leads` | array | Yes | Leads to add \(max 400\). Each entry requires email and accepts first_name, last_name, phone_number, company_name, website, location, linkedin_profile, company_url, and custom_fields. | | `ignoreGlobalBlockList` | boolean | No | Add leads even if they are on the global block list | @@ -1431,7 +1419,6 @@ Retrieves the leads in a Smartlead campaign with their per-campaign status. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `offset` | number | No | Pagination offset \(default 0\) | | `limit` | number | No | Leads to return per page \(default 100\) | @@ -1547,7 +1534,6 @@ Looks up a Smartlead lead by email address and returns the lead record plus ever | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `email` | string | Yes | Lead email address to look up | #### Output @@ -1661,7 +1647,6 @@ Updates a lead in a Smartlead campaign. Smartlead requires the email field even | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | | `email` | string | Yes | Lead email address — required by Smartlead even when unchanged | @@ -1786,7 +1771,6 @@ Sets the category of a lead in a Smartlead campaign, such as Interested or Not I | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | | `categoryId` | number | Yes | Lead category ID to apply | @@ -1903,7 +1887,6 @@ Pauses a lead in a Smartlead campaign so it stops receiving sequence emails. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | @@ -2018,7 +2001,6 @@ Resumes a paused lead in a Smartlead campaign, optionally after a delay. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | | `resumeLeadWithDelayDays` | number | No | Days to wait before the next email; 0 resumes immediately | @@ -2134,7 +2116,6 @@ Retrieves the lead categories configured on the Smartlead account, with the cate | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | #### Output @@ -2247,7 +2228,6 @@ Retrieves the sent-and-received message history for a lead in a Smartlead campai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | @@ -2362,7 +2342,6 @@ Retrieves the webhooks registered on a Smartlead campaign. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -2476,7 +2455,6 @@ Creates a webhook on a Smartlead campaign, or updates an existing one when a web | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `name` | string | Yes | Webhook name | | `webhookUrl` | string | Yes | HTTPS URL Smartlead should post events to | @@ -2595,7 +2573,6 @@ Deletes a webhook from a Smartlead campaign. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `webhookId` | number | Yes | ID of the webhook to delete, from List Campaign Webhooks | @@ -2710,7 +2687,6 @@ Retrieves webhook delivery counts for a Smartlead campaign over a time window, f | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `fromTime` | string | Yes | Start of the window as an ISO 8601 timestamp | | `toTime` | string | Yes | End of the window as an ISO 8601 timestamp | @@ -2826,7 +2802,6 @@ Copies a Smartlead campaign, including its sequences and settings. The copy is n | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -2940,7 +2915,6 @@ Permanently deletes a Smartlead campaign along with its sequences, leads, and we | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -3054,7 +3028,6 @@ Exports every lead in a Smartlead campaign as CSV, including engagement counts a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -3168,7 +3141,6 @@ Retrieves the sending email accounts attached to a Smartlead campaign. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -3282,7 +3254,6 @@ Attaches sending email accounts to a Smartlead campaign. A campaign needs at lea | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `emailAccountIds` | array | Yes | IDs of the email accounts to attach, from List Email Accounts | @@ -3397,7 +3368,6 @@ Detaches sending email accounts from a Smartlead campaign. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `emailAccountIds` | array | Yes | IDs of the email accounts to detach | @@ -3512,7 +3482,6 @@ Retrieves the sending email accounts on the Smartlead account, including their I | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `offset` | number | No | Pagination offset \(default 0\) | | `limit` | number | No | Accounts to return per page \(default 100\) | | `clientId` | number | No | Only return accounts for this client \(agency accounts\) | @@ -3628,7 +3597,6 @@ Retrieves per-lead engagement statistics for a Smartlead campaign. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `limit` | number | No | Rows to return \(default 100\) | | `offset` | number | No | Rows to skip \(default 0\) | @@ -3744,7 +3712,6 @@ Retrieves per-mailbox sending statistics for a Smartlead campaign, for spotting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | #### Output @@ -3858,7 +3825,6 @@ Retrieves top-level Smartlead campaign counts for a date range, including positi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `startDate` | string | Yes | Range start date in YYYY-MM-DD format | | `endDate` | string | Yes | Range end date in YYYY-MM-DD format | @@ -3974,7 +3940,6 @@ Retrieves recent lead activity across all Smartlead campaigns — opens, clicks, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `offset` | number | No | Pagination offset \(default 0\) | | `limit` | number | No | Rows to return per page | @@ -4089,7 +4054,6 @@ Looks up a Smartlead lead by its ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | #### Output @@ -4203,7 +4167,6 @@ Unsubscribes a lead from a single Smartlead campaign, leaving it active in other | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | @@ -4318,7 +4281,6 @@ Unsubscribes a lead across every Smartlead campaign and adds it to the account-w | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | #### Output @@ -4432,7 +4394,6 @@ Marks a lead as completed in a Smartlead campaign so it stops receiving further | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `campaignLeadMapId` | number | Yes | The campaign_lead_map_id from List Campaign Leads — this endpoint takes the map ID, NOT lead.id | @@ -4547,7 +4508,6 @@ Removes a lead from a Smartlead campaign. The lead record itself remains on the | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `campaignId` | number | Yes | Smartlead campaign ID | | `leadId` | number | Yes | Smartlead lead ID — the nested lead.id from List Campaign Leads, NOT campaign_lead_map_id | @@ -4662,7 +4622,6 @@ Retrieves replies from the Smartlead master inbox across all campaigns, optional | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `unreadOnly` | boolean | No | Return only unread replies | | `offset` | number | No | Pagination offset \(default 0\) | | `limit` | number | No | Replies to return per page | @@ -4778,7 +4737,6 @@ Retrieves the lead lists on the Smartlead account with their lead counts. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `offset` | number | No | Pagination offset \(default 0\) | | `limit` | number | No | Lists to return per page | @@ -4893,7 +4851,6 @@ Retrieves a single Smartlead lead list by ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `leadListId` | number | Yes | Lead list ID | #### Output @@ -5007,7 +4964,6 @@ Creates a lead list on the Smartlead account. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `listName` | string | Yes | Name for the new lead list | #### Output @@ -5121,7 +5077,6 @@ Renames a Smartlead lead list. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `leadListId` | number | Yes | Lead list ID to update | | `listName` | string | Yes | New name for the lead list | @@ -5236,7 +5191,6 @@ Deletes a Smartlead lead list. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | | `leadListId` | number | Yes | Lead list ID to delete | #### Output @@ -5350,7 +5304,6 @@ Retrieves the clients on a Smartlead agency account, including the client IDs us | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Smartlead API key | #### Output diff --git a/apps/docs/content/docs/integrations/sportmonks.mdx b/apps/docs/content/docs/integrations/sportmonks.mdx index b1dbdc09be3..ae46b0ad55f 100644 --- a/apps/docs/content/docs/integrations/sportmonks.mdx +++ b/apps/docs/content/docs/integrations/sportmonks.mdx @@ -2,7 +2,7 @@ title: Sportmonks description: Access Sportmonks football, motorsport, odds, and reference data integration: - type: "sportmonks" + type: "sportmonks_v2" color: "#171534" --- @@ -38,7 +38,6 @@ Retrieve lineup-level expected goals (xG) values per player from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;player;team;type\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -71,7 +70,6 @@ Retrieve fixture-level expected goals (xG) values per team from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;participant;type\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -103,7 +101,6 @@ Retrieve all textual commentaries available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;player\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -136,7 +133,6 @@ Retrieve all football fixtures available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -181,7 +177,6 @@ Retrieve all football players available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. nationality;position\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -224,7 +219,6 @@ Retrieve all teams with their rivals information from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. team;rival\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -252,7 +246,6 @@ Retrieve all football teams available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;venue\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -289,7 +282,6 @@ Retrieve all transfer rumours available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -328,7 +320,6 @@ Retrieve all transfers available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply \(e.g. transferTypes:219,220\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -365,7 +356,6 @@ Retrieve the knockout-stage tournament bracket (stages and progression edges) fo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response | @@ -387,7 +377,6 @@ Retrieve a single football coach by their ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `coachId` | string | Yes | The unique id of the coach | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams;statistics\) | | `filters` | string | No | Filters to apply | @@ -426,7 +415,6 @@ Retrieve all football coaches available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply \(e.g. coachCountries:462\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -467,7 +455,6 @@ Retrieve all coaches for a country ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;nationality\) | | `filters` | string | No | Filters to apply | @@ -509,7 +496,6 @@ Retrieve textual commentary for a fixture by fixture ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;relatedPlayer\) | @@ -539,7 +525,6 @@ Retrieve all current leagues for a team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason\) | | `filters` | string | No | Filters to apply | @@ -576,7 +561,6 @@ Retrieve the premium expected lineups for a player ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `playerId` | string | Yes | The unique id of the player | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fixture\) | | `filters` | string | No | Filters to apply | @@ -614,7 +598,6 @@ Retrieve the premium expected lineups for a team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fixture\) | | `filters` | string | No | Filters to apply | @@ -652,7 +635,6 @@ Retrieve all squad entries for a team (based on current seasons) by team ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;position\) | | `filters` | string | No | Filters to apply | @@ -684,7 +666,6 @@ Retrieve a single football fixture by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores;events;lineups;statistics\) | | `filters` | string | No | Filters to apply \(e.g. eventTypes:14\) | @@ -727,7 +708,6 @@ Retrieve all football fixtures on a specific date (YYYY-MM-DD) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `date` | string | Yes | The date to fetch fixtures for, in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores;league\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501,271\) | @@ -773,7 +753,6 @@ Retrieve football fixtures between two dates (YYYY-MM-DD) from Sportmonks. Max r | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `startDate` | string | Yes | Start date in YYYY-MM-DD format | | `endDate` | string | Yes | End date in YYYY-MM-DD format \(max 100 days after start\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores\) | @@ -820,7 +799,6 @@ Retrieve fixtures for a team within a date range (YYYY-MM-DD) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `startDate` | string | Yes | Start date in YYYY-MM-DD format | | `endDate` | string | Yes | End date in YYYY-MM-DD format | | `teamId` | string | Yes | The unique id of the team | @@ -868,7 +846,6 @@ Retrieve multiple football fixtures by a comma-separated list of IDs (max 50) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `ids` | string | Yes | Comma-separated fixture IDs \(e.g. 18535517,18535518\). Maximum of 50 IDs | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -911,7 +888,6 @@ Retrieve the standing table for a round ID grouped by group where applicable fro | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `roundId` | string | Yes | The unique id of the round | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply \(e.g. standingGroups:246697\) | @@ -934,7 +910,6 @@ Retrieve the head-to-head fixtures between two teams from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `team1` | string | Yes | The id of the first team | | `team2` | string | Yes | The id of the second team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores\) | @@ -981,7 +956,6 @@ Retrieve all fixtures that are currently being played (in-play) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores;events\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -1023,7 +997,6 @@ Retrieve all coaches that have received updates in the past two hours | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;nationality\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -1064,7 +1037,6 @@ Retrieve all fixtures that have received updates within the last 10 seconds | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -1106,7 +1078,6 @@ Retrieve all livescores that have received updates within the last 10 seconds | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -1148,7 +1119,6 @@ Retrieve all players that have received updates in the past two hours | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. nationality;position\) | | `filters` | string | No | Filters to apply | @@ -1188,7 +1158,6 @@ Retrieve the latest Team of the Week (TOTW) for a league ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `leagueId` | string | Yes | The unique id of the league | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;team;player;round\) | @@ -1218,7 +1187,6 @@ Retrieve the latest transfers available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply \(e.g. transferTypes:219,220\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -1255,7 +1223,6 @@ Retrieve a single football league by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `leagueId` | string | Yes | The unique id of the league | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason;seasons\) | | `filters` | string | No | Filters to apply | @@ -1289,7 +1256,6 @@ Retrieve all football leagues available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -1325,7 +1291,6 @@ Retrieve all leagues for a country ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason\) | | `filters` | string | No | Filters to apply | @@ -1362,7 +1327,6 @@ Retrieve all leagues with fixtures on a given date (YYYY-MM-DD) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `date` | string | Yes | The fixture date in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason\) | | `filters` | string | No | Filters to apply | @@ -1399,7 +1363,6 @@ Retrieve all current and historical leagues for a team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason\) | | `filters` | string | No | Filters to apply | @@ -1436,7 +1399,6 @@ Retrieve all leagues that have fixtures currently being played from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -1472,7 +1434,6 @@ Retrieve all live (in-play) prediction probabilities from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;fixture\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -1502,7 +1463,6 @@ Retrieve all live (in-play) prediction probabilities for a fixture ID from Sport | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;fixture\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -1533,7 +1493,6 @@ Retrieve the live standing table for a league ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `leagueId` | string | Yes | The unique id of the league | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply \(e.g. standingGroups:246697\) | @@ -1568,7 +1527,6 @@ Retrieve fixtures starting within 15 minutes and currently in progress from Spor | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores;events\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -1610,7 +1568,6 @@ Retrieve all available match facts within your Sportmonks subscription (beta) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;sport;fixture\) | | `filters` | string | No | Filters to apply \(e.g. matchFactTypes:76088\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -1645,7 +1602,6 @@ Retrieve match facts within a date range (YYYY-MM-DD) from Sportmonks (beta) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `startDate` | string | Yes | Start date in YYYY-MM-DD format | | `endDate` | string | Yes | End date in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;sport;fixture\) | @@ -1682,7 +1638,6 @@ Retrieve match facts for a fixture ID from Sportmonks (beta) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;sport;fixture\) | | `filters` | string | No | Filters to apply \(e.g. matchFactTypes:76088\) | @@ -1718,7 +1673,6 @@ Retrieve match facts for a league ID from Sportmonks (beta) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `leagueId` | string | Yes | The unique id of the league | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;sport;fixture\) | | `filters` | string | No | Filters to apply \(e.g. matchFactTypes:76088\) | @@ -1754,7 +1708,6 @@ Retrieve all past fixtures that were available for a TV station ID from Sportmon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `tvStationId` | string | Yes | The unique id of the TV station | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -1800,7 +1753,6 @@ Retrieve a single football player by their ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `playerId` | string | Yes | The unique id of the player | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;position;teams.team;statistics\) | | `filters` | string | No | Filters to apply | @@ -1841,7 +1793,6 @@ Retrieve all players for a country ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. nationality;position\) | | `filters` | string | No | Filters to apply | @@ -1885,7 +1836,6 @@ Retrieve all post-match news articles available within your Sportmonks subscript | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;league\) | | `filters` | string | No | Filters to apply \(e.g. newsitemLeagues:8\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -1915,7 +1865,6 @@ Retrieve all post-match news articles for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;league\) | | `filters` | string | No | Filters to apply \(e.g. newsitemLeagues:8\) | @@ -1946,7 +1895,6 @@ Retrieve the predictions model performance for a league ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `leagueId` | string | Yes | The unique id of the league | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;league\) | | `filters` | string | No | Filters to apply \(e.g. predictabilityTypes:245\) | @@ -1976,7 +1924,6 @@ Retrieve all pre-match news articles available within your Sportmonks subscripti | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;league\) | | `filters` | string | No | Filters to apply \(e.g. newsitemLeagues:8\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2006,7 +1953,6 @@ Retrieve all pre-match news articles for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;league\) | | `filters` | string | No | Filters to apply \(e.g. newsitemLeagues:8\) | @@ -2037,7 +1983,6 @@ Retrieve all pre-match news articles for upcoming fixtures from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;league\) | | `filters` | string | No | Filters to apply \(e.g. newsitemLeagues:8\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2067,7 +2012,6 @@ Retrieve all prediction probabilities available within your Sportmonks subscript | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;fixture\) | | `filters` | string | No | Filters to apply \(e.g. predictionTypes:236\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2096,7 +2040,6 @@ Retrieve prediction probabilities for a fixture by fixture ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;fixture\) | | `filters` | string | No | Filters to apply \(e.g. predictionTypes:236\) | @@ -2126,7 +2069,6 @@ Retrieve a single football referee by their ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `refereeId` | string | Yes | The unique id of the referee | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;statistics\) | | `filters` | string | No | Filters to apply | @@ -2164,7 +2106,6 @@ Retrieve all football referees available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;statistics\) | | `filters` | string | No | Filters to apply \(e.g. refereeCountries:44\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2204,7 +2145,6 @@ Retrieve all referees for a country ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;nationality\) | | `filters` | string | No | Filters to apply | @@ -2245,7 +2185,6 @@ Retrieve all referees for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;nationality\) | | `filters` | string | No | Filters to apply | @@ -2286,7 +2225,6 @@ Retrieve rival teams for a team by team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. team;rival\) | @@ -2311,7 +2249,6 @@ Retrieve a single football round by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `roundId` | string | Yes | The unique id of the round | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;stage;fixtures\) | | `filters` | string | No | Filters to apply | @@ -2345,7 +2282,6 @@ Retrieve all available statistics for a round ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `roundId` | string | Yes | The unique id of the round | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant\) | | `filters` | string | No | Filters to apply \(e.g. seasonstatisticTypes:52,88\) | @@ -2376,7 +2312,6 @@ Retrieve all football rounds available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;stage\) | | `filters` | string | No | Filters to apply \(e.g. roundSeasons:19735\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2412,7 +2347,6 @@ Retrieve all rounds for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;stage\) | | `filters` | string | No | Filters to apply | @@ -2446,7 +2380,6 @@ Retrieve the full schedule (stages, rounds and fixtures) for a season by season | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | ##### Output @@ -2467,7 +2400,6 @@ Retrieve the full season schedule for a specific team by season ID and team ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `teamId` | string | Yes | The unique id of the team | @@ -2489,7 +2421,6 @@ Retrieve the full schedule (stages, rounds and fixtures) for a team by team ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | ##### Output @@ -2510,7 +2441,6 @@ Retrieve a single football season by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;stages;fixtures\) | | `filters` | string | No | Filters to apply | @@ -2546,7 +2476,6 @@ Retrieve all football seasons available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;stages\) | | `filters` | string | No | Filters to apply \(e.g. seasonLeagues:501\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2584,7 +2513,6 @@ Retrieve all seasons for a team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;stages\) | | `filters` | string | No | Filters to apply | @@ -2620,7 +2548,6 @@ Retrieve a single football stage by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `stageId` | string | Yes | The unique id of the stage | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;rounds\) | | `filters` | string | No | Filters to apply | @@ -2655,7 +2582,6 @@ Retrieve all available statistics for a stage ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `stageId` | string | Yes | The unique id of the stage | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant\) | | `filters` | string | No | Filters to apply \(e.g. seasonstatisticTypes:52,88\) | @@ -2686,7 +2612,6 @@ Retrieve all football stages available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;rounds\) | | `filters` | string | No | Filters to apply \(e.g. stageSeasons:19735\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2723,7 +2648,6 @@ Retrieve all stages for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;rounds\) | | `filters` | string | No | Filters to apply | @@ -2758,7 +2682,6 @@ Retrieve point corrections (awarded or deducted) for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;stage\) | | `filters` | string | No | Filters to apply | @@ -2791,7 +2714,6 @@ Retrieve all standings available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;league;season\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -2828,7 +2750,6 @@ Retrieve the full standing table for a round ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `roundId` | string | Yes | The unique id of the round | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply \(e.g. standingGroups:246697\) | @@ -2863,7 +2784,6 @@ Retrieve the full league standings table for a season by season ID from Sportmon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details;form\) | | `filters` | string | No | Filters to apply \(e.g. standingStages:77453568\) | @@ -2898,7 +2818,6 @@ Retrieve a single fixture state by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `stateId` | string | Yes | The unique id of the state | ##### Output @@ -2924,7 +2843,6 @@ Retrieve all fixture states (e.g. Not Started, 1st Half, Full Time) from Sportmo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | | `order` | string | No | Order direction \(asc or desc\) | @@ -2952,7 +2870,6 @@ Retrieve a single football team by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;venue;coaches;players.player\) | | `filters` | string | No | Filters to apply | @@ -2987,7 +2904,6 @@ Retrieve all team rankings available within your Sportmonks subscription (beta) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. team\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -3016,7 +2932,6 @@ Retrieve team rankings for a given date (YYYY-MM-DD) from Sportmonks (beta) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `date` | string | Yes | The ranking date in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. team\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -3046,7 +2961,6 @@ Retrieve team rankings for a team ID from Sportmonks (beta) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. team\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -3076,7 +2990,6 @@ Retrieve the current domestic squad for a team by team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;position\) | | `filters` | string | No | Filters to apply | @@ -3108,7 +3021,6 @@ Retrieve the (historical) squad for a team in a specific season from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;position\) | @@ -3141,7 +3053,6 @@ Retrieve all teams for a country ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;venue\) | | `filters` | string | No | Filters to apply | @@ -3179,7 +3090,6 @@ Retrieve all teams for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;venue\) | | `filters` | string | No | Filters to apply | @@ -3217,7 +3127,6 @@ Retrieve the topscorers (goals, assists, cards) for a season by season ID from S | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;participant;type\) | | `filters` | string | No | Filters to apply \(e.g. seasontopscorerTypes:208\) | @@ -3252,7 +3161,6 @@ Retrieve topscorers for a stage by stage ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `stageId` | string | Yes | The unique id of the stage | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;participant;type\) | | `filters` | string | No | Filters to apply \(e.g. stageTopscorerTypes:208\) | @@ -3287,7 +3195,6 @@ Retrieve all available Team of the Week (TOTW) entries from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;team;player;round\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -3319,7 +3226,6 @@ Retrieve the Team of the Week (TOTW) for a round ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `roundId` | string | Yes | The unique id of the round | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixture;team;player;round\) | @@ -3349,7 +3255,6 @@ Retrieve a single transfer by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `transferId` | string | Yes | The unique id of the transfer | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply | @@ -3384,7 +3289,6 @@ Retrieve a single transfer rumour by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `rumourId` | string | Yes | The unique id of the transfer rumour | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply | @@ -3421,7 +3325,6 @@ Retrieve transfer rumours within a date range (YYYY-MM-DD) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `startDate` | string | Yes | Start date in YYYY-MM-DD format | | `endDate` | string | Yes | End date in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | @@ -3462,7 +3365,6 @@ Retrieve transfer rumours for a player ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `playerId` | string | Yes | The unique id of the player | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply | @@ -3502,7 +3404,6 @@ Retrieve transfer rumours for a team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply | @@ -3542,7 +3443,6 @@ Retrieve transfers within a date range (YYYY-MM-DD) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `startDate` | string | Yes | Start date in YYYY-MM-DD format | | `endDate` | string | Yes | End date in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | @@ -3581,7 +3481,6 @@ Retrieve transfers for a player by player ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `playerId` | string | Yes | The unique id of the player | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fromTeam;toTeam;type\) | | `filters` | string | No | Filters to apply | @@ -3619,7 +3518,6 @@ Retrieve transfers for a team by team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. player;fromTeam;toTeam\) | | `filters` | string | No | Filters to apply \(e.g. transferTypes:219,220\) | @@ -3657,7 +3555,6 @@ Retrieve a single TV station by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `tvStationId` | string | Yes | The unique id of the TV station | | `include` | string | No | Semicolon-separated relations to enrich the response | | `filters` | string | No | Filters to apply | @@ -3686,7 +3583,6 @@ Retrieve all TV stations available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -3717,7 +3613,6 @@ Retrieve broadcasting TV stations for a fixture by fixture ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. fixtures;countries\) | | `filters` | string | No | Filters to apply | @@ -3749,7 +3644,6 @@ Retrieve all upcoming fixtures for a market ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `marketId` | string | Yes | The unique id of the market | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;odds\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -3795,7 +3689,6 @@ Retrieve all upcoming fixtures available for a TV station ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `tvStationId` | string | Yes | The unique id of the TV station | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -3841,7 +3734,6 @@ Retrieve all value bets available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;fixture\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -3869,7 +3761,6 @@ Retrieve value bet predictions for a fixture by fixture ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. type;fixture\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -3898,7 +3789,6 @@ Retrieve a single football venue by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `venueId` | string | Yes | The unique id of the venue | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city;fixtures\) | | `filters` | string | No | Filters to apply | @@ -3934,7 +3824,6 @@ Retrieve all football venues available within your Sportmonks subscription | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city\) | | `filters` | string | No | Filters to apply \(e.g. venueCountries:98\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -3972,7 +3861,6 @@ Retrieve all venues for a season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city\) | | `filters` | string | No | Filters to apply | @@ -4008,7 +3896,6 @@ Search for football coaches by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The coach name to search for \(e.g. Gerrard\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply | @@ -4050,7 +3937,6 @@ Search for football fixtures by name (participants) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The fixture name to search for \(e.g. Celtic\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;scores\) | | `filters` | string | No | Filters to apply \(e.g. fixtureLeagues:501\) | @@ -4096,7 +3982,6 @@ Search for football leagues by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The league name to search for \(e.g. Premier\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;currentSeason\) | | `filters` | string | No | Filters to apply | @@ -4133,7 +4018,6 @@ Search for football players by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The player name to search for \(e.g. Tavernier\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;position;teams.team\) | | `filters` | string | No | Filters to apply | @@ -4177,7 +4061,6 @@ Search for football referees by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The referee name to search for | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country\) | | `filters` | string | No | Filters to apply | @@ -4218,7 +4101,6 @@ Search for football rounds by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The round name to search for \(e.g. 5\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season\) | | `filters` | string | No | Filters to apply | @@ -4255,7 +4137,6 @@ Search for football seasons by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The season name to search for \(e.g. 2023/2024\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league\) | | `filters` | string | No | Filters to apply | @@ -4294,7 +4175,6 @@ Search for football stages by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The stage name to search for \(e.g. Group\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season\) | | `filters` | string | No | Filters to apply | @@ -4332,7 +4212,6 @@ Search for football teams by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The team name to search for \(e.g. Celtic\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;venue\) | | `filters` | string | No | Filters to apply | @@ -4370,7 +4249,6 @@ Search for football venues by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The venue name to search for \(e.g. Celtic Park\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city\) | | `filters` | string | No | Filters to apply | @@ -4411,7 +4289,6 @@ Retrieve all motorsport fixtures (sessions) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;results\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -4456,7 +4333,6 @@ Retrieve the current motorsport leagues for a team by team ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team \(constructor\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | @@ -4494,7 +4370,6 @@ Retrieve a single motorsport driver by their ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `driverId` | string | Yes | The unique id of the driver | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply | @@ -4535,7 +4410,6 @@ Retrieve all driver championship standings from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;season\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -4572,7 +4446,6 @@ Retrieve the drivers championship standings for a season by season ID from Sport | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;season\) | | `filters` | string | No | Filters to apply | @@ -4610,7 +4483,6 @@ Retrieve all motorsport drivers from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -4653,7 +4525,6 @@ Retrieve all motorsport drivers for a country by country ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply | @@ -4697,7 +4568,6 @@ Retrieve all motorsport drivers for a season by season ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply | @@ -4741,7 +4611,6 @@ Retrieve a single motorsport fixture (session) by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;results;latestLaps;pitstops\) | | `filters` | string | No | Filters to apply | @@ -4784,7 +4653,6 @@ Retrieve motorsport fixtures (sessions) on a specific date (YYYY-MM-DD) from Spo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `date` | string | Yes | The date to fetch fixtures for, in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;venue\) | | `filters` | string | No | Filters to apply | @@ -4830,7 +4698,6 @@ Retrieve motorsport fixtures (sessions) between two dates (YYYY-MM-DD, max 100 d | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `startDate` | string | Yes | The start date of the range, in YYYY-MM-DD format | | `endDate` | string | Yes | The end date of the range, in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;venue\) | @@ -4877,7 +4744,6 @@ Retrieve multiple motorsport fixtures (sessions) by their IDs (max 50) from Spor | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureIds` | string | Yes | Comma-separated list of fixture ids \(max 50, e.g. 19408487,19408480\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;results\) | | `filters` | string | No | Filters to apply | @@ -4923,7 +4789,6 @@ Retrieve all laps for a motorsport fixture (session) by fixture ID from Sportmon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply | @@ -4952,7 +4817,6 @@ Retrieve all laps for a motorsport fixture and driver from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `driverId` | string | Yes | The unique id of the driver | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | @@ -4982,7 +4846,6 @@ Retrieve all laps for a motorsport fixture and lap number from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `lapNumber` | string | Yes | The lap number to retrieve | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | @@ -5012,7 +4875,6 @@ Retrieve the latest laps for a motorsport fixture (session) by fixture ID from S | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply | @@ -5041,7 +4903,6 @@ Retrieve the latest pitstops for a motorsport fixture (session) by fixture ID fr | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply | @@ -5070,7 +4931,6 @@ Retrieve the latest tyre stints for a motorsport fixture (session) by fixture ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply | @@ -5099,7 +4959,6 @@ Retrieve the most recently updated motorsport drivers from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5142,7 +5001,6 @@ Retrieve the most recently updated motorsport fixtures (sessions) from Sportmonk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;results\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5187,7 +5045,6 @@ Retrieve a single motorsport league by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `leagueId` | string | Yes | The unique id of the league | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | @@ -5222,7 +5079,6 @@ Retrieve all motorsport leagues from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5259,7 +5115,6 @@ Retrieve all motorsport leagues for a country by country ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | @@ -5297,7 +5152,6 @@ Retrieve all motorsport leagues with fixtures on a specific date (YYYY-MM-DD) fr | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `date` | string | Yes | The date to fetch leagues for, in YYYY-MM-DD format | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | @@ -5335,7 +5189,6 @@ Retrieve all motorsport leagues that currently have live fixtures from Sportmonk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5372,7 +5225,6 @@ Retrieve all current and historical motorsport leagues for a team by team ID fro | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team \(constructor\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | @@ -5410,7 +5262,6 @@ Retrieve all live motorsport fixtures (sessions) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participants;results\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5455,7 +5306,6 @@ Retrieve all pitstops for a motorsport fixture (session) by fixture ID from Spor | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply | @@ -5484,7 +5334,6 @@ Retrieve all pitstops for a motorsport fixture and driver from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `driverId` | string | Yes | The unique id of the driver | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | @@ -5514,7 +5363,6 @@ Retrieve all pitstops for a motorsport fixture and lap number from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `lapNumber` | string | Yes | The lap number to retrieve | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | @@ -5544,7 +5392,6 @@ Retrieve race results (stages with fixtures, lineups and lineup details) for a s | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `driverId` | string | Yes | The unique id of the driver | | `include` | string | No | Semicolon-separated relations to enrich the response | @@ -5584,7 +5431,6 @@ Retrieve race results (stages with fixtures, lineups and lineup details) for a s | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `teamId` | string | Yes | The unique id of the team \(constructor\) | | `include` | string | No | Semicolon-separated relations to enrich the response | @@ -5624,7 +5470,6 @@ Retrieve the full schedule (stages with nested fixtures and venues) for a season | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response | | `filters` | string | No | Filters to apply | @@ -5663,7 +5508,6 @@ Retrieve a single motorsport season by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;stages\) | | `filters` | string | No | Filters to apply | @@ -5698,7 +5542,6 @@ Retrieve all motorsport seasons from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;stages\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5735,7 +5578,6 @@ Retrieve a single motorsport stage (race weekend) by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `stageId` | string | Yes | The unique id of the stage \(race weekend\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;fixtures\) | | `filters` | string | No | Filters to apply | @@ -5771,7 +5613,6 @@ Retrieve all motorsport stages (race weekends) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;fixtures\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5809,7 +5650,6 @@ Retrieve all motorsport stages (race weekends) for a season by season ID from Sp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;fixtures\) | | `filters` | string | No | Filters to apply | @@ -5848,7 +5688,6 @@ Retrieve a single motorsport fixture state by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `stateId` | string | Yes | The unique id of the state | | `include` | string | No | Semicolon-separated relations to enrich the response | | `filters` | string | No | Filters to apply | @@ -5876,7 +5715,6 @@ Retrieve all possible motorsport fixture states from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -5906,7 +5744,6 @@ Retrieve all tyre stints for a motorsport fixture (session) by fixture ID from S | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | | `filters` | string | No | Filters to apply | @@ -5935,7 +5772,6 @@ Retrieve all tyre stints for a motorsport fixture and driver from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `driverId` | string | Yes | The unique id of the driver | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | @@ -5965,7 +5801,6 @@ Retrieve all tyre stints for a motorsport fixture and stint number from Sportmon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture \(session\) | | `stintNumber` | string | Yes | The stint number to retrieve | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;details\) | @@ -5995,7 +5830,6 @@ Retrieve a single motorsport team (constructor) by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `teamId` | string | Yes | The unique id of the team \(constructor\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;drivers\) | | `filters` | string | No | Filters to apply | @@ -6030,7 +5864,6 @@ Retrieve all team (constructor) championship standings from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;season\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -6067,7 +5900,6 @@ Retrieve the constructors championship standings for a season by season ID from | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. participant;season\) | | `filters` | string | No | Filters to apply | @@ -6105,7 +5937,6 @@ Retrieve all motorsport teams (constructors) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;drivers\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -6142,7 +5973,6 @@ Retrieve all motorsport teams (constructors) for a country by country ID from Sp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;drivers\) | | `filters` | string | No | Filters to apply | @@ -6180,7 +6010,6 @@ Retrieve all motorsport teams (constructors) for a season by season ID from Spor | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;drivers\) | | `filters` | string | No | Filters to apply | @@ -6218,7 +6047,6 @@ Retrieve a single motorsport venue (racing track) by its ID from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `venueId` | string | Yes | The unique id of the venue \(track\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city\) | | `filters` | string | No | Filters to apply | @@ -6254,7 +6082,6 @@ Retrieve all motorsport venues (racing tracks) from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -6292,7 +6119,6 @@ Retrieve all motorsport venues (racing tracks) for a season by season ID from Sp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `seasonId` | string | Yes | The unique id of the season | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city\) | | `filters` | string | No | Filters to apply | @@ -6331,7 +6157,6 @@ Search for motorsport drivers by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The driver name to search for \(e.g. Verstappen\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;teams\) | | `filters` | string | No | Filters to apply | @@ -6375,7 +6200,6 @@ Search for motorsport leagues by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The league name to search for \(e.g. Formula\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;seasons\) | | `filters` | string | No | Filters to apply | @@ -6413,7 +6237,6 @@ Search for motorsport stages (race weekends) by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The stage name to search for \(e.g. Monaco\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. league;season;fixtures\) | | `filters` | string | No | Filters to apply | @@ -6452,7 +6275,6 @@ Search for motorsport teams (constructors) by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The team name to search for \(e.g. Bull\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;drivers\) | | `filters` | string | No | Filters to apply | @@ -6490,7 +6312,6 @@ Search for motorsport venues (racing tracks) by name from Sportmonks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The venue name to search for \(e.g. Hungaroring\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;city\) | | `filters` | string | No | Filters to apply | @@ -6531,7 +6352,6 @@ Retrieve all available historical (premium) pre-match odd values from the Sportm | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. odd\) | | `filters` | string | No | Filters to apply \(e.g. winningOdds\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -6564,7 +6384,6 @@ Retrieve all available live (in-play) odds from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12, bookmakers:2,14, IdAfter:oddID\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -6609,7 +6428,6 @@ Retrieve all available pre-match odds from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12, bookmakers:2,14, winningOdds, IdAfter:oddID\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -6653,7 +6471,6 @@ Retrieve all available premium (historical) pre-match odds from the Sportmonks O | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12, bookmakers:2,14, IdAfter:oddID\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -6697,7 +6514,6 @@ Retrieve a single bookmaker by its ID from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `bookmakerId` | string | Yes | The unique id of the bookmaker | ##### Output @@ -6721,7 +6537,6 @@ Retrieve bookmakers' own event ids mapped to a Sportmonks fixture via the Sportm | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -6749,7 +6564,6 @@ Retrieve all bookmakers from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `filters` | string | No | Filters to apply \(e.g. IdAfter:bookmakerID\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -6776,7 +6590,6 @@ Retrieve all bookmakers available for a fixture from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -6803,7 +6616,6 @@ Retrieve live (in-play) odds for a fixture by fixture ID from the Sportmonks Odd | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12 or bookmakers:2,14 or winningOdds\) | @@ -6849,7 +6661,6 @@ Retrieve live (in-play) odds for a fixture from a specific bookmaker via the Spo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `bookmakerId` | string | Yes | The unique id of the bookmaker | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | @@ -6893,7 +6704,6 @@ Retrieve live (in-play) odds for a fixture on a specific market via the Sportmon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `marketId` | string | Yes | The unique id of the market | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | @@ -6937,7 +6747,6 @@ Retrieve in-play odds updated in the last 10 seconds from the Sportmonks Odds AP | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12 or bookmakers:2,14\) | @@ -6979,7 +6788,6 @@ Retrieve pre-match odds updated in the last 10 seconds from the Sportmonks Odds | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12 or bookmakers:2,14 or winningOdds\) | @@ -7020,7 +6828,6 @@ Retrieve a single betting market by its ID from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `marketId` | string | Yes | The unique id of the market | ##### Output @@ -7044,7 +6851,6 @@ Retrieve all betting markets from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `filters` | string | No | Filters to apply \(e.g. IdAfter:marketID\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -7071,7 +6877,6 @@ Retrieve pre-match odds for a fixture by fixture ID from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12 or bookmakers:2,14 or winningOdds\) | @@ -7116,7 +6921,6 @@ Retrieve pre-match odds for a fixture from a specific bookmaker via the Sportmon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `bookmakerId` | string | Yes | The unique id of the bookmaker | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | @@ -7159,7 +6963,6 @@ Retrieve pre-match odds for a fixture on a specific market via the Sportmonks Od | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `marketId` | string | Yes | The unique id of the market | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | @@ -7202,7 +7005,6 @@ Retrieve premium (historical) pre-match odds for a fixture from the Sportmonks O | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | | `filters` | string | No | Filters to apply \(e.g. markets:1,12 or bookmakers:2,14\) | @@ -7244,7 +7046,6 @@ Retrieve premium pre-match odds for a fixture from a specific bookmaker via the | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `bookmakerId` | string | Yes | The unique id of the bookmaker | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | @@ -7287,7 +7088,6 @@ Retrieve premium pre-match odds for a fixture on a specific market via the Sport | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fixtureId` | string | Yes | The unique id of the fixture | | `marketId` | string | Yes | The unique id of the market | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | @@ -7330,7 +7130,6 @@ Retrieve historical (premium) odds updated between two UNIX timestamps (max 5 mi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fromTimestamp` | string | Yes | Start of the range as a UNIX timestamp \(e.g. 1767225600\) | | `toTimestamp` | string | Yes | End of the range as a UNIX timestamp \(max 5 minutes after the start\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. odd\) | @@ -7365,7 +7164,6 @@ Retrieve premium odds updated between two UNIX timestamps (max 5 minutes) from t | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `fromTimestamp` | string | Yes | Start of the range as a UNIX timestamp \(e.g. 1767225600\) | | `toTimestamp` | string | Yes | End of the range as a UNIX timestamp \(max 5 minutes after the start\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. market;bookmaker\) | @@ -7411,7 +7209,6 @@ Search for bookmakers by name from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The bookmaker name to search for \(e.g. bet365\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -7438,7 +7235,6 @@ Search for betting markets by name from the Sportmonks Odds API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The market name to search for \(e.g. Over/Under\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -7467,7 +7263,6 @@ Retrieve all cities from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. region\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -7499,7 +7294,6 @@ Retrieve a single city by its ID from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `cityId` | string | Yes | The unique id of the city | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. region\) | @@ -7528,7 +7322,6 @@ Retrieve a single continent by its ID from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `continentId` | string | Yes | The unique id of the continent | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. countries\) | @@ -7553,7 +7346,6 @@ Retrieve all continents from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. countries\) | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | @@ -7580,7 +7372,6 @@ Retrieve all countries from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. continent;regions\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -7617,7 +7408,6 @@ Retrieve a single country by its ID from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `countryId` | string | Yes | The unique id of the country | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. continent;regions\) | @@ -7651,7 +7441,6 @@ Retrieve all available filters grouped per entity from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | ##### Output @@ -7671,7 +7460,6 @@ Retrieve your Sportmonks API usage aggregated per 5 minutes | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | | `order` | string | No | Order direction \(asc or desc\) | @@ -7701,7 +7489,6 @@ Retrieve a single region by its ID from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `regionId` | string | Yes | The unique id of the region | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;cities\) | @@ -7726,7 +7513,6 @@ Retrieve all regions from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;cities\) | | `filters` | string | No | Filters to apply | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | @@ -7754,7 +7540,6 @@ Retrieve all supported time zones (IANA names) from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | ##### Output @@ -7774,7 +7559,6 @@ Retrieve a single type by its ID from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `typeId` | string | Yes | The unique id of the type | ##### Output @@ -7802,7 +7586,6 @@ Retrieve the available types grouped per entity from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | ##### Output @@ -7822,7 +7605,6 @@ Retrieve all types (reference data describing events, statistics, positions, etc | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `per_page` | string | No | Number of results per page \(max 50, default 25\) | | `page` | string | No | Page number to retrieve | | `order` | string | No | Order direction \(asc or desc\) | @@ -7852,7 +7634,6 @@ Search for cities by name from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The city name to search for \(e.g. London\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. region\) | | `filters` | string | No | Filters to apply | @@ -7885,7 +7666,6 @@ Search for countries by name from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The country name to search for \(e.g. Brazil\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. continent;regions\) | | `filters` | string | No | Filters to apply | @@ -7923,7 +7703,6 @@ Search for regions by name from the Sportmonks Core API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Sportmonks API token | | `query` | string | Yes | The region name to search for \(e.g. Utrecht\) | | `include` | string | No | Semicolon-separated relations to enrich the response \(e.g. country;cities\) | | `filters` | string | No | Filters to apply | diff --git a/apps/docs/content/docs/integrations/sqs.mdx b/apps/docs/content/docs/integrations/sqs.mdx index 020a3f757bb..3088d1f1c00 100644 --- a/apps/docs/content/docs/integrations/sqs.mdx +++ b/apps/docs/content/docs/integrations/sqs.mdx @@ -2,7 +2,7 @@ title: Amazon SQS description: Connect to Amazon SQS integration: - type: "sqs" + type: "sqs_v2" color: "linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [Amazon SQS](https://aws.amazon.com/sqs/) to send, receive, and delete messages, extend visibility timeouts, and manage queues, attributes, and tags. Batch message actions accept up to 10 entries. Dead-letter actions list source queues and start, inspect, or cancel message move tasks. +Use [Amazon SQS](https://aws.amazon.com/sqs/) to send, receive, and delete messages, extend visibility timeouts, and manage queues, attributes, and tags. Batch message actions accept up to 10 entries. Dead-letter actions list source queues and start, inspect, or cancel message move tasks. Connect with a saved [AWS credential](/integrations/aws-credentials). A workflow can long-poll for work, process each message, and delete it after success. Receiving a message does not remove it: if processing fails and it is not deleted, it becomes available again after the visibility timeout. {/* MANUAL-CONTENT-END */} @@ -32,8 +32,6 @@ Send a message to an Amazon SQS queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `data` | json | Yes | Message body to send as JSON object \(e.g., \{ "action": "process", "payload": \{...\} \}\) | | `delaySeconds` | number | No | Seconds to delay delivery of this message, 0-900. Not supported per-message on FIFO queues | @@ -64,8 +62,6 @@ Send up to 10 messages to an Amazon SQS queue in a single request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `entries` | array | Yes | Up to 10 entries, each \{ "id": "unique-id", "data": \{ ... \}, "delaySeconds"?, "messageGroupId"?, "messageDeduplicationId"?, "messageAttributes"? \} | @@ -101,8 +97,6 @@ Receive up to 10 messages from an Amazon SQS queue, with optional long polling | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `maxNumberOfMessages` | number | No | Maximum number of messages to return, 1-10 \(default 1\) | | `waitTimeSeconds` | number | No | Long-poll duration in seconds, 0-20. Waits for a message to arrive before returning \(default 0, short poll\) | @@ -138,8 +132,6 @@ Delete a received message from an Amazon SQS queue using its receipt handle | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `receiptHandle` | string | Yes | Receipt handle returned by sqs_receive_message for the message to delete | @@ -162,8 +154,6 @@ Delete up to 10 received messages from an Amazon SQS queue in a single request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `entries` | array | Yes | Up to 10 entries, each \{ "id": "unique-id", "receiptHandle": "..." \}. Receipt handles come from sqs_receive_message | @@ -195,8 +185,6 @@ Change how long a received Amazon SQS message stays hidden from other consumers | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `receiptHandle` | string | Yes | Receipt handle returned by sqs_receive_message for the message to update | | `visibilityTimeout` | number | Yes | New visibility timeout in seconds, 0-43200 \(12 hours\). 0 makes the message immediately visible again | @@ -220,8 +208,6 @@ Change the visibility timeout of up to 10 received Amazon SQS messages at once | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `entries` | array | Yes | Up to 10 entries, each \{ "id": "unique-id", "receiptHandle": "...", "visibilityTimeout": 0-43200 \}. Receipt handles come from sqs_receive_message | @@ -253,8 +239,6 @@ List Amazon SQS queue URLs in a region, optionally filtered by name prefix | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueNamePrefix` | string | No | Return only queues whose name begins with this string \(case-sensitive\) | | `maxResults` | number | No | Maximum queues to return, 1-1000. Must be set to receive a nextToken \(default returns up to 1000\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -280,8 +264,6 @@ Resolve an Amazon SQS queue name to its queue URL | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueName` | string | Yes | Queue name, up to 80 characters of letters, digits, hyphens and underscores. A FIFO queue name ends in .fifo | | `queueOwnerAwsAccountId` | string | No | 12-digit AWS account ID of the queue owner, when the queue belongs to another account | @@ -304,8 +286,6 @@ Read configuration and message-count attributes of an Amazon SQS queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `attributeNames` | array | No | Attributes to return, e.g. \["All"\], \["ApproximateNumberOfMessages"\], \["QueueArn"\], \["VisibilityTimeout"\], \["RedrivePolicy"\]. Omitting this returns no attributes | @@ -328,8 +308,6 @@ Update configuration attributes of an existing Amazon SQS queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `attributes` | json | Yes | Attributes to set as string values, e.g. \{ "VisibilityTimeout": "60", "MessageRetentionPeriod": "345600", "RedrivePolicy": "\{...\}" \}. FifoQueue can only be set at creation | @@ -352,8 +330,6 @@ Create a standard or FIFO Amazon SQS queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueName` | string | Yes | Queue name, up to 80 characters of letters, digits, hyphens and underscores. A FIFO queue name must end in .fifo | | `attributes` | json | No | Queue attributes as string values, e.g. \{ "FifoQueue": "true", "VisibilityTimeout": "30", "DelaySeconds": "0", "RedrivePolicy": "\{...\}" \} | | `tags` | json | No | Cost-allocation tags to apply to the new queue, as \{ "key": "value" \} pairs | @@ -378,8 +354,6 @@ Delete an Amazon SQS queue and every message still in it | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | #### Output @@ -401,8 +375,6 @@ Delete every message in an Amazon SQS queue while keeping the queue itself | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | #### Output @@ -424,8 +396,6 @@ List the Amazon SQS queues that use a given queue as their dead-letter queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | URL of the dead-letter queue whose source queues should be listed | | `maxResults` | number | No | Maximum source queues to return, 1-1000. Must be set to receive a nextToken \(default returns up to 1000\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -451,8 +421,6 @@ List the cost-allocation tags attached to an Amazon SQS queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | #### Output @@ -474,8 +442,6 @@ Add or overwrite cost-allocation tags on an Amazon SQS queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `tags` | json | Yes | Tags to apply as \{ "key": "value" \} pairs. An existing key is overwritten. AWS recommends no more than 50 tags per queue | @@ -498,8 +464,6 @@ Remove cost-allocation tags from an Amazon SQS queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue) | | `tagKeys` | array | Yes | Tag keys to remove, e.g. \["env", "team"\] | @@ -522,8 +486,6 @@ Start redriving messages out of an Amazon SQS dead-letter queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `sourceArn` | string | Yes | ARN of the dead-letter queue to move messages out of \(e.g., arn:aws:sqs:us-east-1:123456789012:my-dlq\) | | `destinationArn` | string | No | ARN of the queue to move messages into. Omit to redrive each message to its original source queue | | `maxNumberOfMessagesPerSecond` | number | No | Throttle the move to at most this many messages per second, up to 500. Omit to move as fast as possible | @@ -548,8 +510,6 @@ List the most recent message move tasks for an Amazon SQS source queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `sourceArn` | string | Yes | ARN of the queue whose move tasks should be listed \(e.g., arn:aws:sqs:us-east-1:123456789012:my-dlq\) | | `maxResults` | number | No | Maximum move tasks to return, 1-10 \(default 1\) | @@ -582,8 +542,6 @@ Cancel an in-progress Amazon SQS message move task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `taskHandle` | string | Yes | Task handle returned by sqs_start_message_move_task or sqs_list_message_move_tasks. Only a RUNNING task can be cancelled | #### Output diff --git a/apps/docs/content/docs/integrations/square.mdx b/apps/docs/content/docs/integrations/square.mdx index e4a3ca773cd..8c74f46f439 100644 --- a/apps/docs/content/docs/integrations/square.mdx +++ b/apps/docs/content/docs/integrations/square.mdx @@ -2,7 +2,7 @@ title: Square description: Process payments and manage Square commerce data integration: - type: "square" + type: "square_v2" color: "#000000" --- @@ -12,12 +12,12 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} Use [Square](https://squareup.com/) to take, retrieve, list, cancel, complete, or refund payments; manage customer profiles; create, retrieve, search, or pay for orders; and create, publish, cancel, or delete invoices. -The actions also manage catalog objects and images, read inventory counts, and look up locations. Configure a Square access token and the target environment. Payment and refund actions change live commerce records; use the correct environment and the action's idempotency fields before running them. +The actions also manage catalog objects and images, read inventory counts, and look up locations. Connect with a saved Square credential holding a production access token. Payment and refund actions change live commerce records; use the action's idempotency fields before running them. {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] -Take and refund payments, manage customers, build catalog items and images, create and search orders, and issue invoices. Authenticate with a Square access token (personal access token). +Take and refund payments, manage customers, build catalog items and images, create and search orders, and issue invoices. ## Actions @@ -31,7 +31,6 @@ Take a payment using a payment source such as a card nonce or a card on file | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `sourceId` | string | Yes | ID of the payment source \(card nonce, card-on-file ID, or wallet token\) | | `amount` | number | Yes | Amount in the smallest currency denomination \(e.g. 1000 = $10.00\) | | `currency` | string | Yes | Three-letter ISO 4217 currency code \(e.g. USD\) | @@ -99,7 +98,6 @@ Retrieve details for a single payment by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `paymentId` | string | Yes | ID of the payment to retrieve | #### Output @@ -158,7 +156,6 @@ List payments taken by the account, optionally filtered by location and time ran | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `locationId` | string | No | Filter payments by location ID | | `beginTime` | string | No | RFC 3339 timestamp for the beginning of the reporting period | | `endTime` | string | No | RFC 3339 timestamp for the end of the reporting period | @@ -220,7 +217,6 @@ Cancel (void) an authorized payment that has not been captured | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `paymentId` | string | Yes | ID of the payment to cancel | #### Output @@ -279,7 +275,6 @@ Capture (complete) a payment that was authorized with delayed capture | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `paymentId` | string | Yes | ID of the payment to complete | | `versionToken` | string | No | Optional version token for optimistic concurrency control | @@ -339,7 +334,6 @@ Refund all or part of a completed payment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `paymentId` | string | Yes | ID of the payment to refund | | `amount` | number | Yes | Amount to refund in the smallest currency denomination \(e.g. 100 = $1.00\) | | `currency` | string | Yes | Three-letter ISO 4217 currency code \(e.g. USD\) | @@ -380,7 +374,6 @@ Retrieve a single payment refund by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `refundId` | string | Yes | ID of the refund to retrieve | #### Output @@ -417,7 +410,6 @@ List payment refunds, optionally filtered by location, status, and time range | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `locationId` | string | No | Filter refunds by location ID | | `status` | string | No | Filter by refund status \(PENDING, COMPLETED, REJECTED, or FAILED\) | | `beginTime` | string | No | RFC 3339 timestamp for the beginning of the reporting period | @@ -458,7 +450,6 @@ Create a new customer profile in the Square customer directory | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `givenName` | string | No | First name of the customer | | `familyName` | string | No | Last name of the customer | | `companyName` | string | No | Business name of the customer | @@ -522,7 +513,6 @@ Retrieve a single customer profile by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `customerId` | string | Yes | ID of the customer to retrieve | #### Output @@ -576,7 +566,6 @@ List customer profiles in the Square customer directory | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `limit` | number | No | Maximum number of results to return per page \(max 100\) | | `cursor` | string | No | Pagination cursor from a previous response | | `sortField` | string | No | Field to sort by \(DEFAULT or CREATED_AT\) | @@ -631,7 +620,6 @@ Search customer profiles using filters such as email, phone, or creation date | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `query` | json | No | Square customer query object with optional filter and sort \(e.g. \{"filter":\{"email_address":\{"exact":"a@b.com"\}\}\}\) | | `limit` | number | No | Maximum number of results to return per page | | `cursor` | string | No | Pagination cursor from a previous response | @@ -685,7 +673,6 @@ Update fields on an existing customer profile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `customerId` | string | Yes | ID of the customer to update | | `givenName` | string | No | First name of the customer | | `familyName` | string | No | Last name of the customer | @@ -749,7 +736,6 @@ Delete a customer profile from the Square customer directory | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `customerId` | string | Yes | ID of the customer to delete | #### Output @@ -771,7 +757,6 @@ List all locations associated with the Square account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | #### Output @@ -819,7 +804,6 @@ Retrieve a single location by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `locationId` | string | Yes | ID of the location to retrieve \(use "main" for the main location\) | #### Output @@ -869,7 +853,6 @@ Create an order with line items, taxes, discounts, and fulfillments | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `order` | json | Yes | Square order object including location_id and line_items \(e.g. \{"location_id":"L1","line_items":\[\{"name":"Coffee","quantity":"1","base_price_money":\{"amount":250,"currency":"USD"\}\}\]\}\) | | `idempotencyKey` | string | No | Unique key to make the request idempotent \(auto-generated if omitted\) | @@ -924,7 +907,6 @@ Retrieve a single order by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `orderId` | string | Yes | ID of the order to retrieve | #### Output @@ -978,7 +960,6 @@ Search orders across one or more locations using filters and sorting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `locationIds` | array | Yes | Array of location IDs to search within | | `query` | json | No | Square order query object with optional filter and sort \(e.g. \{"filter":\{"state_filter":\{"states":\["OPEN"\]\}\}\}\) | | `limit` | number | No | Maximum number of results to return per page | @@ -1034,7 +1015,6 @@ Pay for an order using one or more already-approved payments | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `orderId` | string | Yes | ID of the order to pay for | | `paymentIds` | array | No | IDs of approved payments to apply to the order | | `orderVersion` | number | No | Version of the order being paid \(for optimistic concurrency\) | @@ -1091,7 +1071,6 @@ Create a draft invoice for an existing order and customer | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `invoice` | json | Yes | Square invoice object including location_id, order_id, primary_recipient, and payment_requests \(e.g. \{"location_id":"L1","order_id":"O1","primary_recipient":\{"customer_id":"C1"\},"payment_requests":\[\{"request_type":"BALANCE","due_date":"2026-07-01"\}\]\}\) | | `idempotencyKey` | string | No | Unique key to make the request idempotent \(auto-generated if omitted\) | @@ -1136,7 +1115,6 @@ Retrieve a single invoice by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `invoiceId` | string | Yes | ID of the invoice to retrieve | #### Output @@ -1180,7 +1158,6 @@ List invoices for a specific location | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `locationId` | string | Yes | ID of the location to list invoices for | | `limit` | number | No | Maximum number of results to return per page | | `cursor` | string | No | Pagination cursor from a previous response | @@ -1225,7 +1202,6 @@ Search invoices across one or more locations | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `locationId` | string | Yes | ID of the location to search within \(Square allows one location per search\) | | `limit` | number | No | Maximum number of results to return per page | | `cursor` | string | No | Pagination cursor from a previous response | @@ -1270,7 +1246,6 @@ Publish a draft invoice so it is sent to the customer and becomes payable | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `invoiceId` | string | Yes | ID of the invoice to publish | | `version` | number | Yes | Current version of the invoice \(use the version returned by Create Invoice\) | | `idempotencyKey` | string | No | Unique key to make the request idempotent \(auto-generated if omitted\) | @@ -1316,7 +1291,6 @@ Cancel a published invoice that is unpaid or partially paid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `invoiceId` | string | Yes | ID of the invoice to cancel | | `version` | number | Yes | Current version of the invoice | @@ -1361,7 +1335,6 @@ Delete a draft invoice | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `invoiceId` | string | Yes | ID of the draft invoice to delete | | `version` | number | No | Current version of the invoice \(required if the invoice has been updated\) | @@ -1384,7 +1357,6 @@ Create or update a catalog object such as an item, variation, or category | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `object` | json | Yes | Square catalog object to create or update. Use ID "#name" for new objects \(e.g. \{"type":"ITEM","id":"#Coffee","item_data":\{"name":"Coffee"\}\}\) | | `idempotencyKey` | string | No | Unique key to make the request idempotent \(auto-generated if omitted\) | @@ -1420,7 +1392,6 @@ Retrieve a single catalog object by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `objectId` | string | Yes | ID of the catalog object to retrieve | | `includeRelatedObjects` | boolean | No | Whether to include related objects such as an item variations | @@ -1456,7 +1427,6 @@ List catalog objects, optionally filtered by type | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `types` | string | No | Comma-separated catalog object types to return \(e.g. ITEM,CATEGORY\). Defaults to all top-level types | | `cursor` | string | No | Pagination cursor from a previous response | @@ -1491,7 +1461,6 @@ Search catalog objects by type and query filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `objectTypes` | array | No | Array of catalog object types to search \(e.g. \["ITEM","CATEGORY"\]\) | | `query` | json | No | Square catalog query object \(e.g. \{"text_query":\{"keywords":\["coffee"\]\}\} or \{"prefix_query":\{...\}\}\) | | `limit` | number | No | Maximum number of results to return per page | @@ -1528,7 +1497,6 @@ Upload an image and attach it to the catalog, optionally to a specific item | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `file` | file | Yes | The image file to upload \(UserFile object\) | | `fileName` | string | No | Optional filename override for the image | | `objectId` | string | No | ID of the catalog object \(e.g. an item\) to attach the image to | @@ -1567,7 +1535,6 @@ Delete a catalog object and its children (e.g. an item and its variations) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `objectId` | string | Yes | ID of the catalog object to delete | #### Output @@ -1590,7 +1557,6 @@ Retrieve current inventory counts for catalog items across locations | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Square access token \(personal access token\) | | `catalogObjectIds` | array | No | IDs of the catalog item variations to retrieve counts for | | `locationIds` | array | No | IDs of the locations to retrieve counts for \(defaults to all locations\) | | `states` | array | No | Inventory states to filter by \(e.g. IN_STOCK, SOLD, IN_TRANSIT\) | diff --git a/apps/docs/content/docs/integrations/ssm.mdx b/apps/docs/content/docs/integrations/ssm.mdx index 0db4eaf06af..1513d8b48b1 100644 --- a/apps/docs/content/docs/integrations/ssm.mdx +++ b/apps/docs/content/docs/integrations/ssm.mdx @@ -2,7 +2,7 @@ title: AWS Systems Manager description: Run commands, manage parameters, and audit managed nodes integration: - type: "ssm" + type: "ssm_v2" color: "#E7157B" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS Systems Manager](https://aws.amazon.com/systems-manager/) to run commands on managed nodes, read and write Parameter Store values, inspect inventory and compliance, and manage Automation runbooks. +Use [AWS Systems Manager](https://aws.amazon.com/systems-manager/) to run commands on managed nodes, read and write Parameter Store values, inspect inventory and compliance, and manage Automation runbooks. Connect with a saved [AWS credential](/integrations/aws-credentials). The following notes explain how secret values appear in workflow inputs, outputs, and run logs. @@ -40,8 +40,6 @@ Run an SSM document on managed nodes with AWS Systems Manager Run Command | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `documentName` | string | Yes | Name of the SSM document to run \(e.g., AWS-RunShellScript\) | | `instanceIds` | json | No | Managed node IDs to target, as an array of strings \(e.g., \["i-0123456789abcdef0"\]\). Provide instanceIds or targets | | `targets` | json | No | Tag or resource-group targets, as an array of \{Key, Values\} objects. Provide instanceIds or targets | @@ -94,8 +92,6 @@ List Run Command executions in an AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `commandId` | string | No | Return only the command with this ID | | `instanceId` | string | No | Return only commands sent to this managed node | | `filters` | json | No | Filters, as an array of \{key, value\} objects. Valid keys: InvokedAfter, InvokedBefore, Status, ExecutionStage, DocumentName | @@ -123,8 +119,6 @@ List the per-node invocations of Run Command executions | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `commandId` | string | No | Return only invocations of this command | | `instanceId` | string | No | Return only invocations on this managed node | | `filters` | json | No | Filters, as an array of \{key, value\} objects. Valid keys: InvokedAfter, InvokedBefore, Status, DocumentName | @@ -153,8 +147,6 @@ Read the output and status of a Run Command execution on one managed node | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `commandId` | string | Yes | ID of the command, as returned by ssm_send_command | | `instanceId` | string | Yes | Managed node the command ran on \(e.g., i-0123456789abcdef0\) | | `pluginName` | string | No | Name of the document plugin to read output for; required for documents with more than one plugin | @@ -193,8 +185,6 @@ Cancel an in-flight Run Command execution | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `commandId` | string | Yes | ID of the command to cancel, as returned by ssm_send_command | | `instanceIds` | array | No | Managed node IDs to cancel on \(e.g., \["i-0123456789abcdef0"\]\); omit to cancel on every targeted node | @@ -218,8 +208,6 @@ Read one parameter from AWS Systems Manager Parameter Store | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Name of the parameter, optionally with a :version or :label suffix | | `withDecryption` | boolean | No | Return the decrypted value of a SecureString parameter; ignored for String and StringList parameters | @@ -250,8 +238,6 @@ Read up to ten parameters from AWS Systems Manager Parameter Store by name | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `names` | json | Yes | Parameter names to read, as an array of at most 10 strings | | `withDecryption` | boolean | No | Return decrypted values for SecureString parameters; ignored for String and StringList parameters | @@ -276,8 +262,6 @@ Read parameters under a Parameter Store hierarchy path | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `path` | string | Yes | Hierarchy path to read, starting with a slash \(e.g., /prod/app\) | | `recursive` | boolean | No | Include parameters in nested paths below the given path | | `withDecryption` | boolean | No | Return decrypted values for SecureString parameters; ignored for String and StringList parameters | @@ -306,8 +290,6 @@ Create or update a parameter in AWS Systems Manager Parameter Store | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Name of the parameter, optionally using a slash-separated hierarchy | | `value` | string | Yes | Value to store | | `type` | string | No | Parameter type \(String, StringList, or SecureString\); required when creating a new parameter | @@ -341,8 +323,6 @@ Delete a parameter from AWS Systems Manager Parameter Store | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Name of the parameter to delete | #### Output @@ -365,8 +345,6 @@ List Parameter Store parameter metadata without reading any values | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `parameterFilters` | json | No | Filters, as an array of \{Key, Option, Values\} objects. Valid keys: Name, Type, KeyId, Path, Tier, DataType, or tag:<key> | | `shared` | boolean | No | Return parameters shared with this account instead of parameters it owns | | `maxResults` | number | No | Maximum number of parameters to return \(1-50\) | @@ -393,8 +371,6 @@ List managed nodes registered with AWS Systems Manager and their agent status | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `filters` | json | No | Filters, as an array of \{Key, Values\} objects. Valid keys: InstanceIds, AgentVersion, PingStatus, PlatformTypes, ActivationIds, IamRole, ResourceType, AssociationStatus, SourceIds, SourceTypes, tag-key, or tag:<key> | | `maxResults` | number | No | Maximum number of nodes to return \(5-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -420,8 +396,6 @@ List the patches reported for one managed node | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceId` | string | Yes | Managed node to report patches for \(e.g., i-0123456789abcdef0\) | | `filters` | json | No | Filters, as an array of \{Key, Values\} objects. Valid keys: Classification, KBId, Severity, State | | `maxResults` | number | No | Maximum number of patches to return \(10-100\) | @@ -448,8 +422,6 @@ Read patch compliance summaries for a set of managed nodes | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `instanceIds` | json | Yes | Managed node IDs to summarize, as an array of at most 50 strings | | `maxResults` | number | No | Maximum number of patch states to return \(10-100\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -475,8 +447,6 @@ List individual compliance findings reported to AWS Systems Manager | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `resourceIds` | json | No | Resource to report on, as an array holding a single managed node ID | | `resourceTypes` | json | No | Resource type to report on, as an array holding a single value; currently only ManagedInstance is supported | | `filters` | json | No | Filters, as an array of \{Key, Values, Type\} objects. Type is one of EQUAL, NOT_EQUAL, BEGIN_WITH, LESS_THAN, GREATER_THAN | @@ -504,8 +474,6 @@ Read compliant and non-compliant counts per compliance type | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `filters` | json | No | Filters, as an array of \{Key, Values, Type\} objects. Type is one of EQUAL, NOT_EQUAL, BEGIN_WITH, LESS_THAN, GREATER_THAN | | `maxResults` | number | No | Maximum number of summaries to return \(1-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -531,8 +499,6 @@ Start an AWS Systems Manager Automation runbook execution | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `documentName` | string | Yes | Name of the Automation runbook to run \(e.g., AWS-RestartEC2Instance\) | | `documentVersion` | string | No | Runbook version to run \($LATEST, $DEFAULT, or a version number\) | | `parameters` | json | No | Runbook parameters, as an object mapping each parameter name to an array of string values | @@ -562,8 +528,6 @@ List Automation runbook executions in an AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `filters` | json | No | Filters, as an array of \{Key, Values\} objects. Valid keys: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter, AutomationType, TagKey, TargetResourceGroup, AutomationSubtype, OpsItemId | | `maxResults` | number | No | Maximum number of executions to return \(1-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -589,8 +553,6 @@ Read the status, outputs, and step results of one Automation execution | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `automationExecutionId` | string | Yes | ID of the execution, as returned by ssm_start_automation_execution | #### Output @@ -631,8 +593,6 @@ Stop a running AWS Systems Manager Automation execution | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `automationExecutionId` | string | Yes | ID of the execution to stop, as returned by ssm_start_automation_execution | | `stopType` | string | No | How to stop the execution: Cancel to stop it immediately, or Complete to let the current step finish | @@ -656,8 +616,6 @@ List SSM documents and runbooks available to an AWS account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `filters` | json | No | Filters, as an array of \{Key, Values\} objects. Valid keys: Name, Owner, DocumentType, PlatformTypes, TargetType, or tag:<key> | | `maxResults` | number | No | Maximum number of documents to return \(1-50\) | | `nextToken` | string | No | Pagination token from a previous request | @@ -683,8 +641,6 @@ Read the content of an SSM document or Automation runbook | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `name` | string | Yes | Name of the document to read, as returned by ssm_list_documents | | `documentVersion` | string | No | Document version to read \($LATEST, $DEFAULT, or a version number\) | | `versionName` | string | No | User-defined version name to read | diff --git a/apps/docs/content/docs/integrations/sts.mdx b/apps/docs/content/docs/integrations/sts.mdx index 3d3be97dae7..d758e051a3f 100644 --- a/apps/docs/content/docs/integrations/sts.mdx +++ b/apps/docs/content/docs/integrations/sts.mdx @@ -2,7 +2,7 @@ title: AWS STS description: Connect to AWS Security Token Service integration: - type: "sts" + type: "sts_v2" color: "linear-gradient(45deg, #BD0816 0%, #FF5252 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS STS](https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html) to request temporary credentials, assume roles, verify the calling identity, and identify the AWS account associated with an access key. +Use [AWS STS](https://docs.aws.amazon.com/STS/latest/APIReference/welcome.html) to request temporary credentials, assume roles, verify the calling identity, and identify the AWS account associated with an access key. Connect with a saved [AWS credential](/integrations/aws-credentials). {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] @@ -30,8 +30,6 @@ Assume an IAM role and receive temporary security credentials | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `roleArn` | string | Yes | ARN of the IAM role to assume | | `roleSessionName` | string | Yes | Identifier for the assumed role session | | `durationSeconds` | number | No | Duration of the session in seconds \(900-43200, default 3600\) | @@ -144,8 +142,6 @@ Get details about the IAM user or role whose credentials are used to call the AP | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | #### Output @@ -168,8 +164,6 @@ Get temporary security credentials for an IAM user, optionally with MFA | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `durationSeconds` | number | No | Duration of the session in seconds \(900-129600, default 43200\) | | `serialNumber` | string | No | MFA device serial number or ARN | | `tokenCode` | string | No | MFA token code \(6 digits\) | @@ -196,8 +190,6 @@ Get the AWS account ID associated with an access key | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `accessKeyId` | string | Yes | AWS access key ID | -| `secretAccessKey` | string | Yes | AWS secret access key | | `targetAccessKeyId` | string | Yes | The access key ID to look up | #### Output diff --git a/apps/docs/content/docs/integrations/tailscale.mdx b/apps/docs/content/docs/integrations/tailscale.mdx index 0d7e6496d1d..553ba29dc62 100644 --- a/apps/docs/content/docs/integrations/tailscale.mdx +++ b/apps/docs/content/docs/integrations/tailscale.mdx @@ -2,7 +2,7 @@ title: Tailscale description: Manage devices and network settings in your Tailscale tailnet integration: - type: "tailscale" + type: "tailscale_v2" color: "#2E2D2D" --- @@ -14,11 +14,9 @@ Use [Tailscale](https://tailscale.com) to manage devices, users, device posture, ## Authentication -Enter a Tailscale **API access token** in **API Access Token**. The block sends it using Bearer authentication. Create a personal token in the [Keys page of the admin console](https://login.tailscale.com/admin/settings/keys); personal tokens expire after 1–90 days and inherit the user's permissions. +Save a Tailscale **API access token** as a Tailscale credential and select it in the block; Sim sends it using Bearer authentication. Create a personal token in the [Keys page of the admin console](https://login.tailscale.com/admin/settings/keys); personal tokens expire after 1–90 days and inherit the user's permissions. Replace the credential's token before it expires. -An access token generated by a Tailscale OAuth client or federated identity also works. Generate that token using Tailscale's documented [trust credential flow](https://tailscale.com/docs/reference/trust-credentials), then supply the access token to the block. The block does not exchange client secrets or refresh expired tokens. For scheduled workflows, supply a fresh access token from your credential management workflow before it expires. - -Device enrollment keys (`tskey-auth-`) and OAuth client secrets (`tskey-client-`) cannot authenticate these API requests. When using scoped OAuth access tokens, grant the scopes required by the selected endpoint in the [API reference](https://tailscale.com/api). Creating a tailnet-owned auth key with OAuth also requires device tags owned by that credential. +Don't save an access token minted by a Tailscale OAuth client: it expires after about an hour, and Sim does not refresh it. Device enrollment keys (`tskey-auth-`) and OAuth client secrets (`tskey-client-`) cannot authenticate these API requests. ## Tailnet identifier [#tailnet-identifier] @@ -55,7 +53,6 @@ List devices in the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `fields` | string | No | Device fields to return: default or all | | `filters` | string | No | URL query filters for top-level device fields, e.g. isEphemeral=true&tags=tag:server | @@ -128,7 +125,6 @@ Get details of a specific device | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `fields` | string | No | Device fields to return: default or all | @@ -198,7 +194,6 @@ Rename a device or reset its name to the OS hostname | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `name` | string | No | New device name or FQDN; empty resets it to the OS hostname | @@ -222,7 +217,6 @@ Remove a device from the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | #### Output @@ -244,7 +238,6 @@ Authorize or deauthorize a device on the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `authorized` | boolean | Yes | Whether to authorize or deauthorize the device | @@ -268,7 +261,6 @@ Replace the tags assigned to a device | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `tags` | string | Yes | Comma-separated device tags; use \[\] to clear tags | @@ -292,7 +284,6 @@ Get the advertised and approved subnet routes for a device | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | #### Output @@ -314,7 +305,6 @@ Replace the enabled subnet routes for a device | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `routes` | string | Yes | Comma-separated enabled CIDR routes; use \[\] to disable all routes | @@ -337,7 +327,6 @@ Enable or disable device key expiry | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `keyExpiryDisabled` | boolean | Yes | Whether to disable device key expiry | @@ -361,7 +350,6 @@ Immediately expire a device node key so the device must reauthenticate | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | #### Output @@ -383,7 +371,6 @@ Get device posture attributes and their expiry times | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | #### Output @@ -405,7 +392,6 @@ Create or update a custom device posture attribute with an optional expiry | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `attributeKey` | string | Yes | Custom posture attribute name, prefixed with custom: | | `attributeValue` | string | Yes | JSON scalar attribute value: a quoted string, integer, or boolean | @@ -431,7 +417,6 @@ Remove a custom posture attribute from a device | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `deviceId` | string | Yes | Device nodeId \(preferred\) or legacy device ID | | `attributeKey` | string | Yes | Custom posture attribute name, prefixed with custom: | @@ -455,7 +440,6 @@ Get the global DNS nameservers configured for the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | #### Output @@ -476,7 +460,6 @@ Replace the global DNS nameservers for the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `dns` | string | Yes | Comma-separated DNS nameserver IP addresses; \[\] clears the nameservers | @@ -499,7 +482,6 @@ Get the MagicDNS preference for the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | #### Output @@ -520,7 +502,6 @@ Enable or disable MagicDNS for the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `magicDNS` | boolean | Yes | Whether MagicDNS is enabled | @@ -542,7 +523,6 @@ Get the DNS search domains configured for the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | #### Output @@ -563,7 +543,6 @@ Replace the DNS search domains for the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `searchPaths` | string | Yes | Comma-separated DNS search domains; \[\] clears the search paths | @@ -585,7 +564,6 @@ Get split DNS resolvers | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | #### Output @@ -606,7 +584,6 @@ Update selected split DNS resolvers | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `splitDns` | string | Yes | JSON map of domains to nameserver arrays; null deletes a domain when updating | @@ -628,7 +605,6 @@ Replace all split DNS resolvers | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `splitDns` | string | Yes | JSON map of domains to nameserver arrays; null deletes a domain when updating | @@ -650,7 +626,6 @@ Get tailnet DNS configuration | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | #### Output @@ -679,7 +654,6 @@ Replace the full tailnet DNS configuration | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `dnsConfiguration` | string | Yes | Complete DNS configuration JSON: nameservers, splitDNS, searchPaths, preferences | @@ -709,7 +683,6 @@ List users in the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `userType` | string | No | User relationship: member \(default\), shared, or all | | `role` | string | No | User role: owner, member, admin, it-admin, network-admin, billing-admin, or auditor | @@ -745,7 +718,6 @@ Get details of a specific user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `userId` | string | Yes | Tailscale user ID | #### Output @@ -777,7 +749,6 @@ Change a tailnet user’s role | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `userId` | string | Yes | Tailscale user ID | | `role` | string | Yes | User role: owner, member, admin, it-admin, network-admin, billing-admin, or auditor | @@ -801,7 +772,6 @@ Approve a pending user to join the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `userId` | string | Yes | Tailscale user ID | #### Output @@ -823,7 +793,6 @@ Suspend a user’s access to the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `userId` | string | Yes | Tailscale user ID | #### Output @@ -845,7 +814,6 @@ Restore a suspended user’s access to the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `userId` | string | Yes | Tailscale user ID | #### Output @@ -867,7 +835,6 @@ Delete a user from the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `userId` | string | Yes | Tailscale user ID | #### Output @@ -889,7 +856,6 @@ Create a device enrollment auth key | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `reusable` | boolean | No | Whether the auth key can register multiple devices \(default false\) | | `ephemeral` | boolean | No | Whether devices registered with the key are ephemeral \(default false\) | @@ -937,7 +903,6 @@ List active auth keys, API access tokens, and trust credentials in the tailnet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `all` | boolean | No | Include all tailnet keys \(default true\); false restricts keys according to the access token owner | @@ -981,7 +946,6 @@ Get a key’s type, owner, scopes, expiry, and device enrollment capabilities | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `keyId` | string | Yes | Tailscale key ID | @@ -1023,7 +987,6 @@ Revoke an auth key, API access token, or trust credential | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `keyId` | string | Yes | Tailscale key ID | @@ -1047,7 +1010,6 @@ Get the tailnet policy file | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `details` | boolean | No | Include the original HuJSON policy and its warnings and parsing errors | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | #### Output @@ -1071,7 +1033,6 @@ Validate a policy file or run ACL tests without changing the tailnet policy | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `acl` | string | Yes | Policy file in JSON or HuJSON, or a JSON array of ACL tests for validation | @@ -1098,7 +1059,6 @@ Replace the tailnet policy file | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `acl` | string | Yes | Complete tailnet policy file in JSON or HuJSON | | `ifMatch` | string | No | ETag from Get ACL, or ts-default to replace only an untouched default policy | @@ -1122,7 +1082,6 @@ Get tailnet settings | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | #### Output @@ -1156,7 +1115,6 @@ Update selected tailnet settings | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Tailscale API access token or OAuth access token \(not an auth key or OAuth client secret\) | | `tailnet` | string | Yes | Tailnet ID, legacy name, or "-" for the token’s default tailnet | | `settings` | string | Yes | JSON object of settings to update; omitted settings remain unchanged | diff --git a/apps/docs/content/docs/integrations/tavily.mdx b/apps/docs/content/docs/integrations/tavily.mdx index cc85ce655d0..154a1f997af 100644 --- a/apps/docs/content/docs/integrations/tavily.mdx +++ b/apps/docs/content/docs/integrations/tavily.mdx @@ -2,7 +2,7 @@ title: Tavily description: Search and extract information integration: - type: "tavily" + type: "tavily_v2" color: "#FFFFFF" --- @@ -15,7 +15,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" ## Use the block [#usage-instructions] -Search the web, extract content from URLs, crawl sites, and map their URLs. Requires an API key. +Search the web, extract content from URLs, crawl sites, and map their URLs. ## Actions @@ -46,7 +46,6 @@ Perform AI-powered web searches using Tavily's search API. Returns structured re | `exclude_domains` | string | No | Comma-separated list of domains to blacklist \(e.g., "pinterest.com,reddit.com"\) | | `country` | string | No | Boost results from specified country \(general topic only\) | | `auto_parameters` | boolean | No | Automatic parameter configuration based on query intent | -| `apiKey` | string | Yes | Tavily API Key | #### Output @@ -84,7 +83,6 @@ Extract raw content from multiple web pages simultaneously using Tavily's extrac | `format` | string | No | Output format: markdown or text \(default: markdown\) | | `include_images` | boolean | No | Incorporate images in extraction output | | `include_favicon` | boolean | No | Add favicon URL for each result | -| `apiKey` | string | Yes | Tavily API Key | #### Output @@ -126,7 +124,6 @@ Systematically crawl and extract content from websites using Tavily's crawl API. | `extract_depth` | string | No | Extraction depth: basic \(1 credit/5 pages\) or advanced \(2 credits/5 pages\) | | `format` | string | No | Output format: markdown or text \(default: markdown\) | | `include_favicon` | boolean | No | Add favicon URL for each result | -| `apiKey` | string | Yes | Tavily API Key | #### Output @@ -162,7 +159,6 @@ Discover and visualize website structure using Tavily's map API. Maps out all ac | `exclude_paths` | string | No | Comma-separated regex patterns to exclude specific URL paths | | `exclude_domains` | string | No | Comma-separated regex patterns to exclude domains | | `allow_external` | boolean | No | Include external domain links in results \(default: true\) | -| `apiKey` | string | Yes | Tavily API Key | #### Output diff --git a/apps/docs/content/docs/integrations/textract.mdx b/apps/docs/content/docs/integrations/textract.mdx index f00beb21805..c2fce26bce1 100644 --- a/apps/docs/content/docs/integrations/textract.mdx +++ b/apps/docs/content/docs/integrations/textract.mdx @@ -2,7 +2,7 @@ title: AWS Textract description: Extract text, tables, and forms from documents integration: - type: "textract_v2" + type: "textract_v3" color: "linear-gradient(135deg, #055F4E 0%, #56C0A7 100%)" --- @@ -10,7 +10,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} -Use [AWS Textract](https://aws.amazon.com/textract/) to extract text, handwriting, tables, forms, key-value pairs, and supported document-analysis features. Expense and identity-document actions return their corresponding structured results. +Use [AWS Textract](https://aws.amazon.com/textract/) to extract text, handwriting, tables, forms, key-value pairs, and supported document-analysis features. Expense and identity-document actions return their corresponding structured results. Connect with a saved [AWS credential](/integrations/aws-credentials). Single-page parsing supports JPEG, PNG, and single-page PDF supplied as a file or URL. Multi-page parsing supports PDF and TIFF stored in S3; provide the document's `s3://bucket/key` URI. Choose the document mode supported by the selected action. {/* MANUAL-CONTENT-END */} @@ -31,8 +31,6 @@ Parse documents using AWS Textract OCR and document analysis | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | AWS Access Key ID | -| `secretAccessKey` | string | Yes | AWS Secret Access Key | | `region` | string | Yes | AWS region for Textract service \(e.g., us-east-1\) | | `processingMode` | string | No | Document type: single-page or multi-page. Defaults to single-page. | | `file` | file | No | Document to be processed \(JPEG, PNG, or single-page PDF\). | @@ -89,8 +87,6 @@ Extract structured invoice and receipt fields using AWS Textract AnalyzeExpense | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | AWS Access Key ID | -| `secretAccessKey` | string | Yes | AWS Secret Access Key | | `region` | string | Yes | AWS region for Textract service \(e.g., us-east-1\) | | `processingMode` | string | No | Document type: single-page or multi-page. Defaults to single-page. | | `file` | file | No | Invoice or receipt to be processed \(JPEG, PNG, or single-page PDF\). | @@ -124,8 +120,6 @@ Extract identity document fields using AWS Textract AnalyzeID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `accessKeyId` | string | Yes | AWS Access Key ID | -| `secretAccessKey` | string | Yes | AWS Secret Access Key | | `region` | string | Yes | AWS region for Textract service \(e.g., us-east-1\) | | `file` | file | No | Front of the identity document \(JPEG, PNG, or PDF\). | | `filePath` | string | No | URL to the front of the identity document, if not uploaded directly. | diff --git a/apps/docs/content/docs/integrations/trigger_dev.mdx b/apps/docs/content/docs/integrations/trigger_dev.mdx index 0d71dec6a5a..0f46aad2caf 100644 --- a/apps/docs/content/docs/integrations/trigger_dev.mdx +++ b/apps/docs/content/docs/integrations/trigger_dev.mdx @@ -2,7 +2,7 @@ title: Trigger.dev description: Trigger tasks and manage runs and schedules integration: - type: "trigger_dev" + type: "trigger_dev_v2" color: "#000000" --- @@ -33,7 +33,6 @@ Trigger a Trigger.dev task by its identifier with an optional JSON payload. Retu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `taskIdentifier` | string | Yes | Identifier of the task to trigger \(e.g., "send-welcome-email"\) | | `payload` | json | No | JSON payload passed to the task run. Example: \{"userId": "user_123"\} | | `idempotencyKey` | string | No | Idempotency key that ensures the task is only triggered once per key | @@ -62,7 +61,6 @@ Batch trigger a Trigger.dev task with up to 1,000 payloads. All items in the bat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `taskIdentifier` | string | Yes | Identifier of the task to batch trigger \(e.g., "send-welcome-email"\) | | `items` | json | Yes | JSON array of batch items \(max 1,000\). Each item is an object with a "payload" and optional "options" \(queue, concurrencyKey, idempotencyKey, ttl, delay, tags, machine\). Example: \[\{"payload": \{"userId": "user_1"\}\}, \{"payload": \{"userId": "user_2"\}, "options": \{"delay": "1h"\}\}\] | @@ -85,7 +83,6 @@ Retrieve a Trigger.dev batch by its ID, including its status, run IDs, and succe | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `batchId` | string | Yes | ID of the batch to retrieve \(starts with batch_\) | #### Output @@ -119,7 +116,6 @@ Retrieve the execution results of every run in a Trigger.dev batch, including ou | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `batchId` | string | Yes | ID of the batch to retrieve results for \(starts with batch_\) | #### Output @@ -141,7 +137,6 @@ Retrieve a Trigger.dev run by its ID, including status, payload, output, attempt | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to retrieve \(starts with run_\) | #### Output @@ -222,7 +217,6 @@ Retrieve the result of a Trigger.dev run: whether it succeeded, its output, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to retrieve the result for \(starts with run_\) | #### Output @@ -303,7 +297,6 @@ Retrieve the log and span events of a Trigger.dev run, including messages, level | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to retrieve events for \(starts with run_\) | #### Output @@ -340,7 +333,6 @@ Retrieve the OpenTelemetry trace of a Trigger.dev run as a tree of spans with ti | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to retrieve the trace for \(starts with run_\) | #### Output @@ -362,7 +354,6 @@ List Trigger.dev runs in the environment of the API key, with optional filters f | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `status` | string | No | Comma-separated run statuses to filter by: PENDING_VERSION, DELAYED, QUEUED, EXECUTING, REATTEMPTING, FROZEN, COMPLETED, CANCELED, FAILED, CRASHED, INTERRUPTED, SYSTEM_FAILURE | | `taskIdentifier` | string | No | Comma-separated task identifiers to filter by | | `version` | string | No | Comma-separated worker versions to filter by \(e.g., "20240101.1"\) | @@ -397,7 +388,6 @@ Cancel an in-progress Trigger.dev run. Has no effect if the run is already compl | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to cancel \(starts with run_\) | #### Output @@ -418,7 +408,6 @@ Replay a Trigger.dev run, creating a new run with the same payload and options a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to replay \(starts with run_\) | #### Output @@ -439,7 +428,6 @@ Reschedule a delayed Trigger.dev run with a new delay. Only valid while the run | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the delayed run to reschedule \(starts with run_\) | | `delay` | string | Yes | New delay for the run, as a duration \("30m", "1h", "2d"\) or an ISO 8601 date to delay until | @@ -521,7 +509,6 @@ Add tags to an existing Trigger.dev run. Runs can have up to 10 tags. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to tag \(starts with run_\) | | `tags` | string | Yes | Comma-separated tags to add to the run \(max 10 total, each under 128 characters\) | @@ -543,7 +530,6 @@ Replace the metadata of a Trigger.dev run with a new JSON object. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `runId` | string | Yes | ID of the run to update \(starts with run_\) | | `metadata` | json | Yes | JSON object to set as the run metadata. Example: \{"stage": "approved"\} | @@ -565,7 +551,6 @@ Create an imperative cron schedule that triggers a Trigger.dev task on a recurri | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `task` | string | Yes | Identifier of the task to schedule \(e.g., "daily-report"\) | | `cron` | string | Yes | Cron expression defining when the task runs \(e.g., "0 0 * * *"\) | | `timezone` | string | No | IANA timezone the cron expression is evaluated in \(e.g., "America/New_York"\). Defaults to UTC | @@ -650,7 +635,6 @@ Retrieve a Trigger.dev schedule by its ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `scheduleId` | string | Yes | ID of the schedule to retrieve \(starts with sched_\) | #### Output @@ -731,7 +715,6 @@ List Trigger.dev schedules in the project, with page-based pagination. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `page` | number | No | Page number to return \(default 1\) | | `perPage` | number | No | Number of schedules per page | @@ -771,7 +754,6 @@ Update an imperative Trigger.dev schedule by its ID, replacing its task, cron ex | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `scheduleId` | string | Yes | ID of the schedule to update \(starts with sched_\) | | `task` | string | Yes | Identifier of the task the schedule triggers \(e.g., "daily-report"\) | | `cron` | string | Yes | Cron expression defining when the task runs \(e.g., "0 0 * * *"\) | @@ -856,7 +838,6 @@ Delete an imperative Trigger.dev schedule by its ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `scheduleId` | string | Yes | ID of the schedule to delete \(starts with sched_\) | #### Output @@ -878,7 +859,6 @@ Activate an imperative Trigger.dev schedule so it resumes triggering its task. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `scheduleId` | string | Yes | ID of the schedule to activate \(starts with sched_\) | #### Output @@ -959,7 +939,6 @@ Deactivate an imperative Trigger.dev schedule so it stops triggering its task. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `scheduleId` | string | Yes | ID of the schedule to deactivate \(starts with sched_\) | #### Output @@ -1040,7 +1019,6 @@ List the environment variables of a Trigger.dev project environment. Values are | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `projectRef` | string | Yes | External ref of the project, from the project settings \(starts with proj_\) | | `environment` | string | Yes | Environment to list variables for: dev, staging, or prod | @@ -1064,7 +1042,6 @@ Create an environment variable in a Trigger.dev project environment. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `projectRef` | string | Yes | External ref of the project, from the project settings \(starts with proj_\) | | `environment` | string | Yes | Environment to create the variable in: dev, staging, or prod | | `name` | string | Yes | Name of the environment variable \(e.g., "SLACK_API_KEY"\) | @@ -1089,7 +1066,6 @@ Retrieve an environment variable from a Trigger.dev project environment. The val | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `projectRef` | string | Yes | External ref of the project, from the project settings \(starts with proj_\) | | `environment` | string | Yes | Environment to read the variable from: dev, staging, or prod | | `name` | string | Yes | Name of the environment variable \(e.g., "SLACK_API_KEY"\) | @@ -1113,7 +1089,6 @@ Update the value of an environment variable in a Trigger.dev project environment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `projectRef` | string | Yes | External ref of the project, from the project settings \(starts with proj_\) | | `environment` | string | Yes | Environment the variable belongs to: dev, staging, or prod | | `name` | string | Yes | Name of the environment variable to update \(e.g., "SLACK_API_KEY"\) | @@ -1138,7 +1113,6 @@ Delete an environment variable from a Trigger.dev project environment. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `projectRef` | string | Yes | External ref of the project, from the project settings \(starts with proj_\) | | `environment` | string | Yes | Environment the variable belongs to: dev, staging, or prod | | `name` | string | Yes | Name of the environment variable to delete \(e.g., "SLACK_API_KEY"\) | @@ -1162,7 +1136,6 @@ Upload multiple environment variables to a Trigger.dev project environment in on | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `projectRef` | string | Yes | External ref of the project, from the project settings \(starts with proj_\) | | `environment` | string | Yes | Environment to upload the variables to: dev, staging, or prod | | `variables` | json | Yes | JSON array of environment variables to upload. Example: \[\{"name": "SLACK_API_KEY", "value": "slack_123"\}\] | @@ -1187,7 +1160,6 @@ Retrieve a Trigger.dev queue by ID, task identifier, or custom queue name, inclu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `queueName` | string | Yes | Queue ID \(starts with queue_\), task identifier, or custom queue name, depending on the queue type | | `queueType` | string | No | How to interpret the queue name: "id" \(default\) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name | @@ -1269,7 +1241,6 @@ List the queues in the environment of the API key, including running and queued | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `page` | number | No | Page number to return \(default 1\) | | `perPage` | number | No | Number of queues per page | @@ -1307,7 +1278,6 @@ Pause a Trigger.dev queue so no new runs start. Runs that are currently executin | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `queueName` | string | Yes | Queue ID \(starts with queue_\), task identifier, or custom queue name, depending on the queue type | | `queueType` | string | No | How to interpret the queue name: "id" \(default\) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name | @@ -1389,7 +1359,6 @@ Resume a paused Trigger.dev queue so new runs can start again. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `queueName` | string | Yes | Queue ID \(starts with queue_\), task identifier, or custom queue name, depending on the queue type | | `queueType` | string | No | How to interpret the queue name: "id" \(default\) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name | @@ -1471,7 +1440,6 @@ Override the concurrency limit of a Trigger.dev queue with a new value. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `queueName` | string | Yes | Queue ID \(starts with queue_\), task identifier, or custom queue name, depending on the queue type | | `queueType` | string | No | How to interpret the queue name: "id" \(default\) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name | | `concurrencyLimit` | number | Yes | New concurrency limit for the queue \(0 to 100000\) | @@ -1554,7 +1522,6 @@ Reset the concurrency limit of a Trigger.dev queue back to its base value, remov | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `queueName` | string | Yes | Queue ID \(starts with queue_\), task identifier, or custom queue name, depending on the queue type | | `queueType` | string | No | How to interpret the queue name: "id" \(default\) for a queue ID, "task" for a task identifier, or "custom" for a custom queue name | @@ -1636,7 +1603,6 @@ List Trigger.dev deployments in the environment of the API key, with optional st | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `status` | string | No | Deployment status to filter by: PENDING, BUILDING, DEPLOYING, DEPLOYED, FAILED, CANCELED, or TIMED_OUT | | `period` | string | No | Only return deployments created in the given period \(e.g., "1h", "7d"\) | | `from` | string | No | Only return deployments created on or after this ISO 8601 timestamp | @@ -1664,7 +1630,6 @@ Retrieve a Trigger.dev deployment by its ID, including its status, version, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `deploymentId` | string | Yes | ID of the deployment to retrieve | #### Output @@ -1745,7 +1710,6 @@ Retrieve the latest Trigger.dev deployment in the environment of the API key. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | #### Output @@ -1825,7 +1789,6 @@ Promote a Trigger.dev deployment version so new runs execute on it (e.g., to rol | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `version` | string | Yes | Deployment version to promote \(e.g., "20250228.1"\) | #### Output @@ -1848,7 +1811,6 @@ Execute a TRQL (SQL-like) query against Trigger.dev run data for reporting and a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `query` | string | Yes | TRQL query to execute \(e.g., "SELECT run_id, status, triggered_at FROM runs WHERE status = 'Failed' LIMIT 10"\) | | `scope` | string | No | Scope of data to query: environment \(default\), project, or organization | | `period` | string | No | Time period shorthand \(e.g., "1h", "7d", "30d"\). Cannot be combined with from/to | @@ -1875,7 +1837,6 @@ Retrieve the TRQL query schema: the tables and columns available for Execute Que | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | #### Output @@ -1905,7 +1866,6 @@ Create a Trigger.dev waitpoint token that a task can wait on until it is complet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `timeout` | string | No | How long before the token times out, as a duration \("30s", "1m", "2h", "3d"\) or an ISO 8601 date | | `idempotencyKey` | string | No | Idempotency key; passing the same key before it expires returns the original token | | `idempotencyKeyTTL` | string | No | How long the idempotency key is valid, as a duration \("30s", "1m", "2h", "3d"\) | @@ -1931,7 +1891,6 @@ Complete a Trigger.dev waitpoint token, resuming any task waiting on it and pass | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `waitpointId` | string | Yes | ID of the waitpoint token to complete \(starts with waitpoint_\) | | `data` | json | No | JSON data passed back to the waiting run as the token result. Example: \{"status": "approved"\} | @@ -1953,7 +1912,6 @@ Retrieve a Trigger.dev waitpoint token by its ID, including its status, timeout, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `waitpointId` | string | Yes | ID of the waitpoint token to retrieve \(starts with waitpoint_\) | #### Output @@ -2034,7 +1992,6 @@ List Trigger.dev waitpoint tokens in the environment of the API key, with option | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `status` | string | No | Waitpoint status to filter by: WAITING, COMPLETED, or TIMED_OUT | | `idempotencyKey` | string | No | Idempotency key to filter by | | `tags` | string | No | Comma-separated tags to filter by | @@ -2066,7 +2023,6 @@ List the IANA timezones supported by Trigger.dev schedules, for use as the timez | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | Trigger.dev secret API key \(starts with tr_\) | | `excludeUtc` | string | No | Set to "true" to exclude UTC from the returned timezones | #### Output diff --git a/apps/docs/content/docs/integrations/uptimerobot.mdx b/apps/docs/content/docs/integrations/uptimerobot.mdx index 91e1d289e45..8d6c9df01dd 100644 --- a/apps/docs/content/docs/integrations/uptimerobot.mdx +++ b/apps/docs/content/docs/integrations/uptimerobot.mdx @@ -2,7 +2,7 @@ title: UptimeRobot description: Monitor uptime, manage incidents, maintenance windows, and status pages integration: - type: "uptimerobot" + type: "uptimerobot_v2" color: "#111921" --- @@ -31,7 +31,6 @@ List monitors in your UptimeRobot account, with optional filters and pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `limit` | number | No | Number of monitors per page \(1-200, default 50\) | | `status` | string | No | Comma-separated statuses to filter by \(PAUSED, STARTED, UP, LOOKS_DOWN, DOWN\) | | `name` | string | No | Partial friendly-name filter | @@ -96,7 +95,6 @@ Get the details of a single UptimeRobot monitor by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `monitorId` | number | Yes | ID of the monitor to retrieve | #### Output @@ -154,7 +152,6 @@ Create a new monitor in UptimeRobot | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `friendlyName` | string | Yes | Friendly name of the monitor | | `type` | string | Yes | Monitor type: HTTP, KEYWORD, PING, PORT, HEARTBEAT, DNS, API, or UDP | | `url` | string | No | URL or host to monitor \(not required for Heartbeat monitors\) | @@ -235,7 +232,6 @@ Update an existing UptimeRobot monitor. Only the provided fields are changed. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `monitorId` | number | Yes | ID of the monitor to update | | `friendlyName` | string | No | New friendly name | | `url` | string | No | New URL or host to monitor | @@ -314,7 +310,6 @@ Permanently delete an UptimeRobot monitor by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `monitorId` | number | Yes | ID of the monitor to delete | #### Output @@ -336,7 +331,6 @@ Pause an UptimeRobot monitor so it stops running checks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `monitorId` | number | Yes | ID of the monitor to pause | #### Output @@ -394,7 +388,6 @@ Resume a paused UptimeRobot monitor so it starts running checks again | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `monitorId` | number | Yes | ID of the monitor to start | #### Output @@ -452,7 +445,6 @@ List incidents across your UptimeRobot account (last 24 hours by default), with | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `monitorId` | number | No | Filter incidents by monitor ID | | `monitorName` | string | No | Filter incidents by monitor name | | `startedAfter` | string | No | Only include incidents started after this ISO 8601 timestamp | @@ -490,7 +482,6 @@ Get the details of a single UptimeRobot incident by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `incidentId` | string | Yes | ID of the incident to retrieve | #### Output @@ -522,7 +513,6 @@ List maintenance windows in your UptimeRobot account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `cursor` | string | No | Pagination cursor returned by a previous request | #### Output @@ -556,7 +546,6 @@ Get the details of a single UptimeRobot maintenance window by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `maintenanceWindowId` | number | Yes | ID of the maintenance window to retrieve | #### Output @@ -589,7 +578,6 @@ Create a new maintenance window to suppress alerts during planned downtime | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `name` | string | Yes | Name of the maintenance window | | `interval` | string | Yes | Recurrence interval: once, daily, weekly, or monthly | | `date` | string | Yes | Start date in YYYY-MM-DD format | @@ -629,7 +617,6 @@ Update an existing maintenance window. Only the provided fields are changed. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `maintenanceWindowId` | number | Yes | ID of the maintenance window to update | | `name` | string | No | New name of the maintenance window | | `interval` | string | No | Recurrence interval: once, daily, weekly, or monthly | @@ -670,7 +657,6 @@ Permanently delete an UptimeRobot maintenance window by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `maintenanceWindowId` | number | Yes | ID of the maintenance window to delete | #### Output @@ -692,7 +678,6 @@ List the personal alert contacts in your UptimeRobot account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `cursor` | number | No | Pagination cursor returned by a previous request | #### Output @@ -722,7 +707,6 @@ Get the details of a single UptimeRobot alert contact by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `alertContactId` | number | Yes | ID of the alert contact to retrieve | #### Output @@ -751,7 +735,6 @@ Create an email alert contact in UptimeRobot. The contact must be confirmed via | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `value` | string | Yes | Email address for the alert contact | | `friendlyName` | string | No | Display name for the alert contact | | `enableNotificationsFor` | number | No | Which monitor events to notify for: 0, 1, 2, or 3 | @@ -782,7 +765,6 @@ Permanently delete an UptimeRobot alert contact by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `alertContactId` | number | Yes | ID of the alert contact to delete | #### Output @@ -804,7 +786,6 @@ List the public status pages in your UptimeRobot account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `cursor` | number | No | Pagination cursor returned by a previous request | #### Output @@ -842,7 +823,6 @@ Get the details of a single UptimeRobot public status page by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `pspId` | number | Yes | ID of the status page to retrieve | #### Output @@ -879,7 +859,6 @@ Create a public status page in UptimeRobot, optionally with a logo and icon imag | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `friendlyName` | string | Yes | Name of the public status page | | `monitorIds` | string | No | Comma-separated monitor IDs to display on the page | | `status` | string | No | Status of the page: ENABLED \(published\) or PAUSED \(unpublished\) | @@ -924,7 +903,6 @@ Update a public status page in UptimeRobot. Only the provided fields are changed | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `pspId` | number | Yes | ID of the status page to update | | `friendlyName` | string | No | New name of the public status page | | `monitorIds` | string | No | Comma-separated monitor IDs to display on the page | @@ -970,7 +948,6 @@ Permanently delete an UptimeRobot public status page by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | | `pspId` | number | Yes | ID of the status page to delete | #### Output @@ -992,7 +969,6 @@ Get details about the authenticated UptimeRobot account, including plan and limi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | UptimeRobot API key | #### Output diff --git a/apps/docs/content/docs/integrations/youcom.mdx b/apps/docs/content/docs/integrations/youcom.mdx index cabdc84d4f2..b591747eab7 100644 --- a/apps/docs/content/docs/integrations/youcom.mdx +++ b/apps/docs/content/docs/integrations/youcom.mdx @@ -2,7 +2,7 @@ title: You.com description: Search, read, and research the web with You.com integration: - type: "youcom" + type: "youcom_v2" color: "#FFFFFF" --- @@ -12,7 +12,7 @@ import { ReferenceDetails } from "@/components/ui/reference-details" {/* MANUAL-CONTENT-START:intro */} Use [You.com](https://you.com/) to search the web and news, retrieve page content, get cited answers, or run deep and financial research. Search supports date, country, language, and domain filters; research can return structured fields or run in the background for later status checks. -Image search requires early-access permission. Account Balance reports remaining API credits. Create a key on the [You.com platform](https://you.com/platform) and provide it to the selected operation. +Image search requires early-access permission. Account Balance reports remaining API credits. Create a key on the [You.com platform](https://you.com/platform) and add it as a You.com credential. {/* MANUAL-CONTENT-END */} ## Use the block [#usage-instructions] @@ -46,7 +46,6 @@ Search the web and news with You.com, returning LLM-ready results with optional | `extractionSource` | string | No | Where full_page content comes from: blend \(cache, then live crawl\), cache, or fetch. Defaults to blend | | `extractionFormats` | string | No | Comma-separated full_page formats: markdown, html, or both. Defaults to markdown | | `crawlTimeout` | number | No | Seconds to wait for page content when crawling, from 1 to 60. Defaults to 10 | -| `apiKey` | string | Yes | You.com API key | #### Output @@ -99,7 +98,6 @@ Fetch the HTML, Markdown, and page metadata of one or more web pages with You.co | `formats` | string | No | Comma-separated formats to return: markdown, html, metadata \(JSON-LD and OpenGraph site info\) | | `crawlTimeout` | number | No | Seconds to wait for page content, from 1 to 60. Defaults to 10 | | `maxAge` | number | No | Maximum age in seconds of cached content before the page is re-fetched. Defaults to no limit | -| `apiKey` | string | Yes | You.com API key | #### Output @@ -133,7 +131,6 @@ Get a synthesized answer to a question with numbered citations and the web resul | `includeDomains` | string | No | Comma-separated domains to restrict results to \(up to 500\). Cannot be combined with exclude or boost domains | | `excludeDomains` | string | No | Comma-separated domains to remove from results \(up to 500\) | | `boostDomains` | string | No | Comma-separated domains to rank higher without filtering others \(up to 500\) | -| `apiKey` | string | Yes | You.com API key | #### Output @@ -172,7 +169,6 @@ Run multi-step web research on a question and get a thorough, cited answer, or s | `boostDomains` | string | No | Comma-separated domains to rank higher without filtering others \(up to 500\) | | `freshness` | string | No | Source recency: day, week, month, year, or a range like 2025-01-01to2025-12-31 | | `country` | string | No | Two-letter country code that focuses web results \(e.g., US, GB, DE\) | -| `apiKey` | string | Yes | You.com API key | #### Output @@ -203,7 +199,6 @@ Get the status of a background research task and, once completed, its cited answ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `taskId` | string | Yes | ID of the background research task | -| `apiKey` | string | Yes | You.com API key | #### Output @@ -245,7 +240,6 @@ Research a financial question across earnings reports, SEC filings, analyst cove | --------- | ---- | -------- | ----------- | | `input` | string | Yes | Financial research question \(up to 40,000 characters\) | | `researchEffort` | string | No | Depth of research: deep \(<120s\) or exhaustive \(<300s\). Defaults to deep | -| `apiKey` | string | Yes | You.com API key | #### Output @@ -273,7 +267,6 @@ Find image URLs for a query with You.com. Beta, and limited to You.com early-acc | --------- | ---- | -------- | ----------- | | `query` | string | Yes | Image search query. Supports site:, filetype: \(e.g., filetype:png\), and OR | | `count` | number | No | Maximum number of images to return, from 1 to 100. Defaults to 10 | -| `apiKey` | string | Yes | You.com API key | #### Output @@ -300,7 +293,6 @@ Get the remaining You.com API credit balance for the account or organization tha | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `apiKey` | string | Yes | You.com API key | #### Output diff --git a/apps/docs/content/docs/integrations/youtube.mdx b/apps/docs/content/docs/integrations/youtube.mdx index f3e0c31663e..b555729f028 100644 --- a/apps/docs/content/docs/integrations/youtube.mdx +++ b/apps/docs/content/docs/integrations/youtube.mdx @@ -2,7 +2,7 @@ title: YouTube description: Interact with YouTube videos, channels, and playlists integration: - type: "youtube" + type: "youtube_v2" color: "#FF0000" --- @@ -33,7 +33,6 @@ Get detailed information about a YouTube channel including statistics, branding, | --------- | ---- | -------- | ----------- | | `channelId` | string | No | YouTube channel ID starting with "UC" \(24-character string, use either channelId or username\) | | `username` | string | No | YouTube channel username \(use either channelId or username\) | -| `apiKey` | string | Yes | YouTube API Key | #### Output @@ -68,7 +67,6 @@ Get all public playlists from a specific YouTube channel. | `channelId` | string | Yes | YouTube channel ID starting with "UC" \(24-character string\) to get playlists from | | `maxResults` | number | No | Maximum number of playlists to return \(1-50\) | | `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | -| `apiKey` | string | Yes | YouTube API Key | #### Output @@ -101,7 +99,6 @@ Search for videos from a specific YouTube channel with sorting options. For comp | `maxResults` | number | No | Maximum number of videos to return \(1-50\) | | `order` | string | No | Sort order: "date" \(newest first, default\), "rating", "relevance", "title", "viewCount" | | `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | -| `apiKey` | string | Yes | YouTube API Key | #### Output @@ -133,7 +130,6 @@ Get top-level comments from a YouTube video with author details and engagement. | `maxResults` | number | No | Maximum number of comments to return \(1-100\) | | `order` | string | No | Order of comments: "time" \(newest first\) or "relevance" \(most relevant first\) | | `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | -| `apiKey` | string | Yes | YouTube API Key | #### Output @@ -168,7 +164,6 @@ Get videos from a YouTube playlist. Can be used with a channel uploads playlist | `playlistId` | string | Yes | YouTube playlist ID starting with "PL" or "UU" \(34-character string\). Use uploadsPlaylistId from channel_info to get all channel videos. | | `maxResults` | number | No | Maximum number of videos to return \(1-50\) | | `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | -| `apiKey` | string | Yes | YouTube API Key | #### Output @@ -202,7 +197,6 @@ Search for videos on YouTube using the YouTube Data API. Supports advanced filte | `query` | string | Yes | Search query for YouTube videos | | `maxResults` | number | No | Maximum number of videos to return \(1-50\) | | `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | -| `apiKey` | string | Yes | YouTube API Key | | `channelId` | string | No | Filter results to a specific YouTube channel ID starting with "UC" \(24-character string\) | | `publishedAfter` | string | No | Only return videos published after this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) | | `publishedBefore` | string | No | Only return videos published before this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) | @@ -248,7 +242,6 @@ Get the most popular/trending videos on YouTube. Can filter by region and video | `videoCategoryId` | string | No | Filter by video category ID \(e.g., "10" for Music, "20" for Gaming, "17" for Sports\) | | `maxResults` | number | No | Maximum number of trending videos to return \(1-50\) | | `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | -| `apiKey` | string | Yes | YouTube API Key | #### Output @@ -283,7 +276,6 @@ Get a list of video categories available on YouTube. Use this to discover valid | --------- | ---- | -------- | ----------- | | `regionCode` | string | No | ISO 3166-1 alpha-2 country code to get categories for \(e.g., "US", "GB", "JP"\). Defaults to US. | | `hl` | string | No | Language for category titles \(ISO 639-1 code, e.g., "en", "es", "fr"\). Defaults to English. | -| `apiKey` | string | Yes | YouTube API Key | #### Output @@ -308,7 +300,6 @@ Get detailed information about a specific YouTube video including statistics, co | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `videoId` | string | Yes | YouTube video ID \(11-character string, e.g., "dQw4w9WgXcQ"\) | -| `apiKey` | string | Yes | YouTube API Key | #### Output diff --git a/apps/docs/content/docs/integrations/zep.mdx b/apps/docs/content/docs/integrations/zep.mdx index 04aa27ff008..1e773e11029 100644 --- a/apps/docs/content/docs/integrations/zep.mdx +++ b/apps/docs/content/docs/integrations/zep.mdx @@ -2,7 +2,7 @@ title: Zep description: Long-term memory for AI agents integration: - type: "zep" + type: "zep_v2" color: "#E8E8E8" --- @@ -31,7 +31,6 @@ Start a new conversation thread in Zep | --------- | ---- | -------- | ----------- | | `threadId` | string | Yes | Unique identifier for the thread \(e.g., "thread_abc123"\) | | `userId` | string | Yes | User ID associated with the thread \(e.g., "user_123"\) | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -59,7 +58,6 @@ List all conversation threads | `pageNumber` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `orderBy` | string | No | Field to order results by \(created_at, updated_at, user_id, thread_id\) | | `asc` | boolean | No | Order direction: true for ascending, false for descending | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -89,7 +87,6 @@ Delete a conversation thread from Zep | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `threadId` | string | Yes | Thread ID to delete \(e.g., "thread_abc123"\) | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -112,7 +109,6 @@ Retrieve user context from a thread with summary or basic mode | `threadId` | string | Yes | Thread ID to get context from \(e.g., "thread_abc123"\) | | `mode` | string | No | Context mode: "summary" \(natural language\) or "basic" \(raw facts\) | | `minRating` | number | No | Minimum rating by which to filter relevant facts | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -136,7 +132,6 @@ Retrieve messages from a thread | `limit` | number | No | Maximum number of messages to return \(e.g., 10, 50, 100\) | | `cursor` | string | No | Cursor for pagination | | `lastn` | number | No | Number of most recent messages to return \(overrides limit and cursor\) | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -168,7 +163,6 @@ Add messages to an existing thread | --------- | ---- | -------- | ----------- | | `threadId` | string | Yes | Thread ID to add messages to \(e.g., "thread_abc123"\) | | `messages` | json | Yes | Array of message objects with role and content \(e.g., \[\{"role": "user", "content": "Hello"\}\]\) | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -195,7 +189,6 @@ Create a new user in Zep | `firstName` | string | No | User first name | | `lastName` | string | No | User last name | | `metadata` | json | No | Additional metadata as JSON object \(e.g., \{"key": "value"\}\) | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -222,7 +215,6 @@ Retrieve user information from Zep | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `userId` | string | Yes | User ID to retrieve \(e.g., "user_123"\) | -| `apiKey` | string | Yes | Your Zep API key | #### Output @@ -251,7 +243,6 @@ List all conversation threads for a specific user | --------- | ---- | -------- | ----------- | | `userId` | string | Yes | User ID to get threads for \(e.g., "user_123"\) | | `limit` | number | No | Maximum number of threads to return \(e.g., 10, 25, 50\) | -| `apiKey` | string | Yes | Your Zep API key | #### Output diff --git a/apps/docs/content/docs/platform/self-hosting/environment-variables.mdx b/apps/docs/content/docs/platform/self-hosting/environment-variables.mdx index 4a06caf31d4..16728f04a4b 100644 --- a/apps/docs/content/docs/platform/self-hosting/environment-variables.mdx +++ b/apps/docs/content/docs/platform/self-hosting/environment-variables.mdx @@ -160,6 +160,18 @@ Google, GitHub, and Microsoft sign-in, their callback URLs, and the `DISABLE_*_A OAuth integrations require a provider application and its credentials on a self-hosted deployment. API-key integrations use the keys supplied in their blocks. The full table, redirect-URI format, and setup steps are in [Integrations and OAuth](/platform/self-hosting/integrations-oauth). +### Keyless cloud credentials [#workload-identity] + +Saved AWS and Databricks credentials can trust Sim through OpenID Connect instead of storing keys. Leave these unset to offer only key- and secret-based credentials. + +| Variable | Description | +| --- | --- | +| `WORKLOAD_IDENTITY_SIGNING_KEY` | PKCS#8 PEM RSA private key that signs Sim's workload-identity tokens: `openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:2048` | +| `WORKLOAD_IDENTITY_ISSUER` | Issuer URL clouds trust. Defaults to `/oidc/workload` and must be reachable from the public internet. Never change it once trust policies reference it. | +| `WORKLOAD_IDENTITY_PREVIOUS_KEY` | During rotation, the retiring key (private or public PEM), still published so tokens it signed keep verifying | + +See [AWS credentials](/integrations/aws-credentials#self-hosted-deployments). + ## Access control Who may sign up and sign in — the allowlists, blocklists, `DISABLE_REGISTRATION`, `DISABLE_INVITATIONS`, `DISABLE_PUBLIC_API`, and `DISABLE_AUTH` — is documented in [Authentication](/platform/self-hosting/authentication). diff --git a/apps/docs/content/integration-navigation.json b/apps/docs/content/integration-navigation.json index 9980d200365..50bb58cefd0 100644 --- a/apps/docs/content/integration-navigation.json +++ b/apps/docs/content/integration-navigation.json @@ -15,6 +15,9 @@ "integration": "attio", "title": "API keys" }, + "aws-credentials": { + "title": "AWS credentials" + }, "box-service-account": { "integration": "box", "title": "Service accounts" @@ -27,6 +30,10 @@ "integration": "clickup", "title": "API tokens" }, + "databricks-credentials": { + "integration": "databricks", + "title": "Databricks connections" + }, "google-service-account": { "title": "Google service accounts" }, diff --git a/apps/docs/openapi-v2-workflows.json b/apps/docs/openapi-v2-workflows.json index f36b9bc5f69..404c5d208ce 100644 --- a/apps/docs/openapi-v2-workflows.json +++ b/apps/docs/openapi-v2-workflows.json @@ -19030,6 +19030,8 @@ "planetscale.deployRequests", "cloudwatch.logGroups", "cloudwatch.logStreams", + "cloudwatch.savedLogGroups", + "cloudwatch.savedLogStreams", "imap.mailboxes", "mcp.tools", "managedAgent.agents", @@ -19227,6 +19229,8 @@ "planetscale.deployRequests", "cloudwatch.logGroups", "cloudwatch.logStreams", + "cloudwatch.savedLogGroups", + "cloudwatch.savedLogStreams", "imap.mailboxes", "mcp.tools", "managedAgent.agents", diff --git a/apps/sim/app/api/credentials/workload-identity/route.ts b/apps/sim/app/api/credentials/workload-identity/route.ts new file mode 100644 index 00000000000..e9d22dd8a7a --- /dev/null +++ b/apps/sim/app/api/credentials/workload-identity/route.ts @@ -0,0 +1,20 @@ +import { prepareWorkloadIdentityContract } from '@/lib/api/contracts/credentials' +import { + defineInternalJsonRoute, + internalRateLimits, + internalSessionAuth, +} from '@/lib/api/server/routes' +import { internalCredentialErrorPolicy } from '@/lib/credentials/api/route-policies' +import { credentialOperations } from '@/lib/credentials/application/operations' +import { prepareWorkloadIdentity } from '@/lib/credentials/application/prepare-workload-identity' + +export const POST = defineInternalJsonRoute({ + contract: prepareWorkloadIdentityContract, + auth: internalSessionAuth, + operation: credentialOperations.prepareWorkloadIdentity, + rateLimit: internalRateLimits.user({ bucketName: 'credentials.workload_identity.prepare' }), + errorPolicy: internalCredentialErrorPolicy, + mapInput: ({ body }) => body, + useCase: prepareWorkloadIdentity, + present: (result) => result, +}) diff --git a/apps/sim/app/oidc/workload/.well-known/openid-configuration/route.ts b/apps/sim/app/oidc/workload/.well-known/openid-configuration/route.ts new file mode 100644 index 00000000000..0e312e42534 --- /dev/null +++ b/apps/sim/app/oidc/workload/.well-known/openid-configuration/route.ts @@ -0,0 +1,5 @@ +import { withRouteHandler } from '@/lib/core/utils/with-route-handler' +import { workloadIdentityDiscoveryResponse } from '@/lib/credentials/workload-identity/responses' + +/** OpenID Connect discovery for Sim's workload-identity issuer (keyless cloud credentials). */ +export const GET = withRouteHandler(workloadIdentityDiscoveryResponse) diff --git a/apps/sim/app/oidc/workload/jwks/route.ts b/apps/sim/app/oidc/workload/jwks/route.ts new file mode 100644 index 00000000000..b990886e686 --- /dev/null +++ b/apps/sim/app/oidc/workload/jwks/route.ts @@ -0,0 +1,5 @@ +import { withRouteHandler } from '@/lib/core/utils/with-route-handler' +import { workloadIdentityJwksResponse } from '@/lib/credentials/workload-identity/responses' + +/** Public signing keys for Sim's workload-identity issuer. */ +export const GET = withRouteHandler(workloadIdentityJwksResponse) diff --git a/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/aws-account-modal.tsx b/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/aws-account-modal.tsx new file mode 100644 index 00000000000..24632224bd0 --- /dev/null +++ b/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/aws-account-modal.tsx @@ -0,0 +1,309 @@ +'use client' + +import { type ComponentType, useState } from 'react' +import { + ChipModal, + ChipModalBody, + ChipModalError, + ChipModalField, + ChipModalFooter, + ChipModalHeader, + ChipTextarea, + SecretInput, +} from '@sim/emcn' +import { resourceScopeFromOwner, resourceScopeKey } from '@/lib/core/resource-scope' +import { AWS_SERVICE_ACCOUNT_PROVIDER_ID } from '@/lib/oauth/types' +import { + KeylessTrustFields, + keylessSubjectFields, + useKeylessSetup, + useSavedConnectionSubmit, +} from '@/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/keyless-connection' +import { withBrandIcon } from '@/blocks/brand-icon' + +interface AwsAccountModalProps { + open: boolean + onOpenChange: (open: boolean) => void + workspaceId?: string + organizationId?: string + serviceIcon: ComponentType<{ className?: string }> + credentialId?: string + initialDisplayName?: string + initialDescription?: string + onCreated?: (credentialId: string) => void +} + +type AwsAuthType = 'oidc_role' | 'access_keys' | 'assume_role' + +const ROLE_ARN_PLACEHOLDER = 'arn:aws:iam::123456789012:role/sim-workflows' +const ACCOUNT_ID_FROM_ROLE_ARN = /^arn:aws[\w-]*:iam::(\d{12}):role\// + +const AUTH_TYPE_HINTS: Record = { + oidc_role: 'No keys are stored. Sim signs a short-lived token that your role trusts.', + assume_role: 'Sim uses the keys only to assume the role, then works with temporary credentials.', + access_keys: 'Sim signs requests with these long-lived keys.', +} + +/** The trust policy a customer attaches to the role so it trusts exactly this credential. */ +function buildTrustPolicy(issuer: string, audience: string, subject: string, roleArn: string) { + const issuerHostPath = issuer.replace(/^https:\/\//, '') + const trimmedArn = roleArn.trim() + const accountId = ACCOUNT_ID_FROM_ROLE_ARN.exec(trimmedArn)?.[1] ?? '' + const partition = trimmedArn.startsWith('arn:aws-') ? trimmedArn.split(':')[1] : 'aws' + return JSON.stringify( + { + Version: '2012-10-17', + Statement: [ + { + Effect: 'Allow', + Principal: { + Federated: `arn:${partition}:iam::${accountId}:oidc-provider/${issuerHostPath}`, + }, + Action: 'sts:AssumeRoleWithWebIdentity', + Condition: { + StringEquals: { + [`${issuerHostPath}:aud`]: audience, + [`${issuerHostPath}:sub`]: subject, + }, + }, + }, + ], + }, + null, + 2 + ) +} + +/** Saved AWS identities share the standard credential create/reconnect lifecycle. */ +export function AwsAccountModal(props: AwsAccountModalProps) { + if (!props.open) return null + return ( + + ) +} + +function AwsAccountForm({ + open, + onOpenChange, + workspaceId, + organizationId, + serviceIcon: ServiceIcon, + credentialId, + initialDisplayName, + initialDescription, + onCreated, +}: AwsAccountModalProps) { + const keyless = useKeylessSetup({ provider: 'aws', workspaceId, organizationId, credentialId }) + const { submit, error, clearError, isPending } = useSavedConnectionSubmit({ + providerId: AWS_SERVICE_ACCOUNT_PROVIDER_ID, + workspaceId, + organizationId, + credentialId, + onCreated, + onClose: () => onOpenChange(false), + }) + const [selectedAuthType, setSelectedAuthType] = useState(null) + const [roleArn, setRoleArn] = useState('') + const [accessKeyId, setAccessKeyId] = useState('') + const [secretAccessKey, setSecretAccessKey] = useState('') + const [externalId, setExternalId] = useState('') + const [stsRegion, setStsRegion] = useState('') + const [displayName, setDisplayName] = useState(initialDisplayName ?? '') + const [description, setDescription] = useState(initialDescription ?? '') + + // Keyless is the default wherever this deployment supports it. + const authType: AwsAuthType = + selectedAuthType ?? (keyless.available ? 'oidc_role' : 'access_keys') + const needsKeys = authType === 'access_keys' || authType === 'assume_role' + const needsRole = authType === 'oidc_role' || authType === 'assume_role' + const disabled = + isPending || + (needsKeys && (!accessKeyId.trim() || !secretAccessKey)) || + (needsRole && !roleArn.trim()) || + (authType === 'oidc_role' && !keyless.ready) + + const edit = (setter: (value: string) => void) => (value: string) => { + setter(value) + clearError() + } + + const buildConfig = (): Record => { + if (authType === 'oidc_role') { + return { authType, roleArn: roleArn.trim(), ...keylessSubjectFields(keyless) } + } + const keys = { accessKeyId: accessKeyId.trim(), secretAccessKey } + if (authType === 'assume_role') { + return { + authType, + ...keys, + roleArn: roleArn.trim(), + ...(externalId.trim() ? { externalId: externalId.trim() } : {}), + } + } + return { authType, ...keys, ...(stsRegion.trim() ? { stsRegion: stsRegion.trim() } : {}) } + } + + const trustPolicy = + authType === 'oidc_role' && keyless.trust + ? buildTrustPolicy( + keyless.trust.issuer, + keyless.trust.audience, + keyless.trust.subject, + roleArn + ) + : null + const action = credentialId ? 'Reconnect' : 'Add' + const authOptions = [ + ...(keyless.available + ? [{ value: 'oidc_role', label: 'IAM role (keyless, via Sim OIDC)' }] + : []), + { value: 'access_keys', label: 'Access keys' }, + { value: 'assume_role', label: 'Access keys that assume an IAM role' }, + ] + + return ( + + onOpenChange(false)}> + {action} AWS credential + + + { + setSelectedAuthType(value as AwsAuthType) + clearError() + }} + options={authOptions} + placeholder='Choose how Sim signs in to AWS' + required + hint={AUTH_TYPE_HINTS[authType]} + /> + + {authType === 'oidc_role' && } + + {needsKeys && ( + <> + + + {(aria) => ( + + )} + + + )} + + {authType === 'access_keys' && ( + + )} + + {needsRole && ( + + )} + + {authType === 'assume_role' && ( + + )} + + {trustPolicy && ( + + {(aria) => ( + + )} + + )} + + + + {error} + + onOpenChange(false)} + secondaryActions={[ + { + label: 'Setup guide', + onClick: () => + window.open( + 'https://docs.sim.ai/integrations/aws-credentials', + '_blank', + 'noopener,noreferrer' + ), + }, + ]} + primaryAction={{ + label: isPending ? 'Verifying...' : `${action} credential`, + onClick: () => { + if (!disabled) void submit({ config: buildConfig(), displayName, description }) + }, + disabled, + }} + /> + + ) +} diff --git a/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/connect-service-account-modal.tsx b/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/connect-service-account-modal.tsx index b9d825364c3..d4c8f6af607 100644 --- a/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/connect-service-account-modal.tsx +++ b/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/connect-service-account-modal.tsx @@ -33,12 +33,16 @@ import { import { getServiceAccountCoverageSentence } from '@/lib/integrations/credential-display' import { ATLASSIAN_SERVICE_ACCOUNT_PROVIDER_ID, + AWS_SERVICE_ACCOUNT_PROVIDER_ID, + DATABRICKS_SERVICE_ACCOUNT_PROVIDER_ID, GOOGLE_SERVICE_ACCOUNT_PROVIDER_ID, OCI_API_KEY_SERVICE_ACCOUNT_PROVIDER_ID, ORACLE_DATABASE_SERVICE_ACCOUNT_PROVIDER_ID, SLACK_CUSTOM_BOT_PROVIDER_ID, } from '@/lib/oauth/types' +import { AwsAccountModal } from '@/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/aws-account-modal' import { ClientCredentialAccountModal } from '@/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/client-credential-account-modal' +import { DatabricksAccountModal } from '@/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/databricks-account-modal' import { OracleDatabaseAccountModal } from '@/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/oracle-database-account-modal' import { TokenServiceAccountModal } from '@/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/token-service-account-modal' import { ConnectSlackBotModal } from '@/app/workspace/[workspaceId]/integrations/components/connect-slack-bot-modal/connect-slack-bot-modal' @@ -56,6 +60,8 @@ export type ServiceAccountProviderId = | typeof SLACK_CUSTOM_BOT_PROVIDER_ID | typeof OCI_API_KEY_SERVICE_ACCOUNT_PROVIDER_ID | typeof ORACLE_DATABASE_SERVICE_ACCOUNT_PROVIDER_ID + | typeof AWS_SERVICE_ACCOUNT_PROVIDER_ID + | typeof DATABRICKS_SERVICE_ACCOUNT_PROVIDER_ID | TokenServiceAccountProviderId | ClientCredentialAccountProviderId @@ -177,6 +183,36 @@ export function ConnectServiceAccountModal({ onSubmitCredentials, submitPending, }: ConnectServiceAccountModalProps) { + if (serviceAccountProviderId === DATABRICKS_SERVICE_ACCOUNT_PROVIDER_ID) { + return ( + + ) + } + if (serviceAccountProviderId === AWS_SERVICE_ACCOUNT_PROVIDER_ID) { + return ( + + ) + } if (serviceAccountProviderId === ORACLE_DATABASE_SERVICE_ACCOUNT_PROVIDER_ID) { return ( void + workspaceId?: string + organizationId?: string + serviceIcon: ComponentType<{ className?: string }> + credentialId?: string + initialDisplayName?: string + initialDescription?: string + onCreated?: (credentialId: string) => void +} + +type DatabricksAuthType = 'oidc_federation' | 'service_principal' | 'personal_access_token' + +const AUTH_TYPE_HINTS: Record = { + oidc_federation: + 'No secret is stored. Sim signs a short-lived token your service principal trusts.', + service_principal: + 'Sim exchanges the OAuth secret for a short-lived workspace token on each run.', + personal_access_token: 'Sim sends this token on every request.', +} + +/** The account-level CLI command that makes the service principal trust this credential. */ +function buildFederationPolicyCommand(issuer: string, audience: string, subject: string) { + const policy = JSON.stringify({ oidc_policy: { issuer, audiences: [audience], subject } }) + return `databricks account service-principal-federation-policy create --json '${policy}'` +} + +/** Saved Databricks connections share the standard credential create/reconnect lifecycle. */ +export function DatabricksAccountModal(props: DatabricksAccountModalProps) { + if (!props.open) return null + return ( + + ) +} + +function DatabricksAccountForm({ + open, + onOpenChange, + workspaceId, + organizationId, + serviceIcon: ServiceIcon, + credentialId, + initialDisplayName, + initialDescription, + onCreated, +}: DatabricksAccountModalProps) { + const keyless = useKeylessSetup({ + provider: 'databricks', + workspaceId, + organizationId, + credentialId, + }) + const { submit, error, clearError, isPending } = useSavedConnectionSubmit({ + providerId: DATABRICKS_SERVICE_ACCOUNT_PROVIDER_ID, + workspaceId, + organizationId, + credentialId, + onCreated, + onClose: () => onOpenChange(false), + }) + const [selectedAuthType, setSelectedAuthType] = useState(null) + const [host, setHost] = useState('') + const [token, setToken] = useState('') + const [clientId, setClientId] = useState('') + const [clientSecret, setClientSecret] = useState('') + const [displayName, setDisplayName] = useState(initialDisplayName ?? '') + const [description, setDescription] = useState(initialDescription ?? '') + + // Keyless is the default wherever this deployment supports it. + const authType: DatabricksAuthType = + selectedAuthType ?? (keyless.available ? 'oidc_federation' : 'service_principal') + const usesServicePrincipal = authType === 'service_principal' || authType === 'oidc_federation' + const disabled = + isPending || + !host.trim() || + (authType === 'personal_access_token' && !token.trim()) || + (usesServicePrincipal && !clientId.trim()) || + (authType === 'service_principal' && !clientSecret) || + (authType === 'oidc_federation' && !keyless.ready) + + const edit = (setter: (value: string) => void) => (value: string) => { + setter(value) + clearError() + } + + const buildConfig = (): Record => { + const base = { authType, host: host.trim() } + if (authType === 'oidc_federation') { + return { ...base, clientId: clientId.trim(), ...keylessSubjectFields(keyless) } + } + if (authType === 'service_principal') { + return { ...base, clientId: clientId.trim(), clientSecret } + } + return { ...base, token: token.trim() } + } + + const federationCommand = + authType === 'oidc_federation' && keyless.trust + ? buildFederationPolicyCommand( + keyless.trust.issuer, + keyless.trust.audience, + keyless.trust.subject + ) + : null + const action = credentialId ? 'Reconnect' : 'Add' + const authOptions = [ + ...(keyless.available + ? [{ value: 'oidc_federation', label: 'Service principal (keyless, via Sim OIDC)' }] + : []), + { value: 'service_principal', label: 'Service principal OAuth secret' }, + { value: 'personal_access_token', label: 'Personal access token' }, + ] + + return ( + + onOpenChange(false)}> + {action} Databricks connection + + + { + setSelectedAuthType(value as DatabricksAuthType) + clearError() + }} + options={authOptions} + placeholder='Choose how Sim signs in to Databricks' + required + hint={AUTH_TYPE_HINTS[authType]} + /> + + + {authType === 'personal_access_token' && ( + + {(aria) => ( + + )} + + )} + + {usesServicePrincipal && ( + + )} + + {authType === 'service_principal' && ( + + {(aria) => ( + + )} + + )} + + {authType === 'oidc_federation' && } + + {federationCommand && ( + + {(aria) => ( + + )} + + )} + + + + {error} + + onOpenChange(false)} + secondaryActions={[ + { + label: 'Setup guide', + onClick: () => + window.open( + 'https://docs.sim.ai/integrations/databricks-credentials', + '_blank', + 'noopener,noreferrer' + ), + }, + ]} + primaryAction={{ + label: isPending ? 'Verifying...' : `${action} connection`, + onClick: () => { + if (!disabled) void submit({ config: buildConfig(), displayName, description }) + }, + disabled, + }} + /> + + ) +} diff --git a/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/keyless-connection.tsx b/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/keyless-connection.tsx new file mode 100644 index 00000000000..157deb5124f --- /dev/null +++ b/apps/sim/app/workspace/[workspaceId]/integrations/components/connect-service-account-modal/keyless-connection.tsx @@ -0,0 +1,211 @@ +'use client' + +import { useState } from 'react' +import { ChipModalError, ChipModalField } from '@sim/emcn' +import { generateShortId } from '@sim/utils/id' +import { isApiClientError } from '@/lib/api/client/errors' +import { resourceScopeFields, resourceScopeFromOwner } from '@/lib/core/resource-scope' +import type { WorkloadIdentityProvider } from '@/lib/credentials/workload-identity/audiences' +import { + useCreateScopedCredential, + useUpdateScopedCredential, + useWorkloadIdentitySetup, +} from '@/hooks/queries/scoped-credentials' + +/** + * Shared plumbing for connect dialogs whose credential is a JSON configuration + * that may be keyless (trusting Sim's workload-identity issuer): the AWS and + * Databricks dialogs differ only in their own fields and trust snippet. + */ + +export type TrustSubjectChoice = 'keep' | 'new' + +interface KeylessSetupInput { + provider: WorkloadIdentityProvider + workspaceId?: string + organizationId?: string + credentialId?: string +} + +/** + * Whether this dialog can offer a keyless mode, and the trust setup to show. + * + * Keyless subjects bind to a workspace, so organization credentials never + * offer it, and a deployment without a signing key reports it unavailable. On + * reconnect the configured trust is kept by default: issuing a new subject + * would break the role or federation policy the customer already set up. + */ +export function useKeylessSetup({ + provider, + workspaceId, + organizationId, + credentialId, +}: KeylessSetupInput) { + const [sessionKey] = useState(() => generateShortId()) + const [subjectChoice, setSubjectChoice] = useState( + credentialId ? 'keep' : 'new' + ) + const workspaceScoped = Boolean(workspaceId) && !organizationId + const setup = useWorkloadIdentitySetup({ + workspaceId, + provider, + sessionKey, + enabled: workspaceScoped, + }) + const trust = setup.data?.available ? setup.data : undefined + return { + /** Undefined while this deployment's support is still loading. */ + available: workspaceScoped ? setup.data?.available : false, + isReconnect: Boolean(credentialId), + subjectChoice, + setSubjectChoice, + /** The new subject to submit, or undefined when keeping the stored one. */ + trust: subjectChoice === 'new' ? trust : undefined, + /** Ready to submit a keyless configuration. */ + ready: subjectChoice === 'keep' ? Boolean(credentialId) : Boolean(trust), + error: setup.isError ? setup.error : null, + } +} + +export type KeylessSetup = ReturnType + +/** The subject fields of a keyless config: a new subject with its proof, or none to keep the stored one. */ +export function keylessSubjectFields(setup: KeylessSetup) { + return setup.trust ? { subject: setup.trust.subject, subjectProof: setup.trust.subjectProof } : {} +} + +interface KeylessTrustFieldsProps { + setup: KeylessSetup +} + +/** Reconnect choice plus the issuer, audience, and subject the customer configures. */ +export function KeylessTrustFields({ setup }: KeylessTrustFieldsProps) { + return ( + <> + {setup.isReconnect && ( + setup.setSubjectChoice(value as TrustSubjectChoice)} + options={[ + { value: 'keep', label: 'Keep the subject this credential already uses' }, + { value: 'new', label: 'Issue a new subject' }, + ]} + hint={ + setup.subjectChoice === 'keep' + ? 'Your existing trust configuration keeps working.' + : 'You must update your trust configuration to the new subject before saving.' + } + /> + )} + {setup.error && ( + + {isApiClientError(setup.error) && setup.error.message + ? setup.error.message + : 'Could not start a keyless connection.'} + + )} + {setup.trust && ( + <> + + + + + )} + + ) +} + +interface SavedConnectionSubmitInput { + providerId: string + workspaceId?: string + organizationId?: string + credentialId?: string + onCreated?: (credentialId: string) => void + onClose: () => void +} + +/** + * Creates or reconnects a service-account credential from its JSON + * configuration. Verification failures surface the server's own message — for + * these providers it names what to fix (the trust policy, the role, the host). + */ +export function useSavedConnectionSubmit({ + providerId, + workspaceId, + organizationId, + credentialId, + onCreated, + onClose, +}: SavedConnectionSubmitInput) { + const [error, setError] = useState(null) + const createCredential = useCreateScopedCredential() + const updateCredential = useUpdateScopedCredential() + + const submit = async (input: { + config: Record + displayName: string + description: string + }) => { + setError(null) + const fields = { + ...resourceScopeFields(resourceScopeFromOwner({ workspaceId, organizationId })), + serviceAccountJson: JSON.stringify(input.config), + displayName: input.displayName.trim() || undefined, + } + try { + let connectedId = credentialId + if (credentialId) { + await updateCredential.mutateAsync({ + ...fields, + credentialId, + description: input.description.trim() || null, + }) + } else { + const created = await createCredential.mutateAsync({ + ...fields, + description: input.description.trim() || undefined, + type: 'service_account', + providerId, + }) + connectedId = created.credential.id + } + if (connectedId) onCreated?.(connectedId) + onClose() + } catch (submitError) { + if (isApiClientError(submitError) && submitError.code === 'duplicate_display_name') { + setError('A credential with that name already exists. Choose a different display name.') + return + } + setError( + isApiClientError(submitError) && submitError.message + ? submitError.message + : 'Could not verify the credential. Check the details and try again.' + ) + } + } + + return { + submit, + error, + clearError: () => setError(null), + isPending: createCredential.isPending || updateCredential.isPending, + } +} diff --git a/apps/sim/blocks/blocks/affinity.ts b/apps/sim/blocks/blocks/affinity.ts index 9691e670530..6bc3c72ed38 100644 --- a/apps/sim/blocks/blocks/affinity.ts +++ b/apps/sim/blocks/blocks/affinity.ts @@ -1,7 +1,11 @@ import { AffinityIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' -import { parseOptionalBooleanInput, parseOptionalNumberInput } from '@/blocks/utils' +import { + parseOptionalBooleanInput, + parseOptionalNumberInput, + withSavedCredential, +} from '@/blocks/utils' /** Operations scoped to a company or person through the shared field endpoints. */ const FIELD_ENTITY_OPERATIONS = [ @@ -305,6 +309,8 @@ function affinityToolIds(): ReadonlySet { export const AffinityBlock: BlockConfig = { type: 'affinity', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'affinity_v2' }, name: 'Affinity', description: 'Read and write companies, people, lists, notes, and relationships in Affinity', longDescription: @@ -1765,3 +1771,17 @@ export const AffinityBlockMeta = { }, ], } as const satisfies BlockMeta + +export const AffinityV2Block: BlockConfig = { + ...AffinityBlock, + type: 'affinity_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + ...withSavedCredential(AffinityBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'affinity', + title: 'Affinity Credential', + }), +} diff --git a/apps/sim/blocks/blocks/agentmail.ts b/apps/sim/blocks/blocks/agentmail.ts index 26c9b5a99a6..db6048ac1d3 100644 --- a/apps/sim/blocks/blocks/agentmail.ts +++ b/apps/sim/blocks/blocks/agentmail.ts @@ -1,9 +1,12 @@ import { AgentMailIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' export const AgentMailBlock: BlockConfig = { type: 'agentmail', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'agentmail_v2' }, name: 'AgentMail', description: 'Manage email inboxes, threads, and messages with AgentMail', longDescription: @@ -807,3 +810,19 @@ export const AgentMailBlockMeta = { }, ], } as const satisfies BlockMeta + +export const AgentMailV2Block: BlockConfig = { + ...AgentMailBlock, + type: 'agentmail_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + longDescription: + 'Create and manage email inboxes, send and receive messages, reply to threads, manage drafts, and organize threads with labels.', + ...withSavedCredential(AgentMailBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'agentmail', + title: 'AgentMail Credential', + }), +} diff --git a/apps/sim/blocks/blocks/agentphone.ts b/apps/sim/blocks/blocks/agentphone.ts index 0aadd385071..2212123f5dc 100644 --- a/apps/sim/blocks/blocks/agentphone.ts +++ b/apps/sim/blocks/blocks/agentphone.ts @@ -2,6 +2,7 @@ import { toError } from '@sim/utils/errors' import { AgentPhoneIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' const CONVERSATION_OPS = [ 'get_conversation', @@ -26,6 +27,8 @@ const CURSOR_MESSAGE_OPS = ['get_number_messages', 'get_conversation_messages'] export const AgentPhoneBlock: BlockConfig = { type: 'agentphone', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'agentphone_v2' }, name: 'AgentPhone', description: 'Provision numbers, send SMS and iMessage, and place voice calls with AgentPhone', longDescription: @@ -933,3 +936,19 @@ export const AgentPhoneBlockMeta = { }, ], } as const satisfies BlockMeta + +export const AgentPhoneV2Block: BlockConfig = { + ...AgentPhoneBlock, + type: 'agentphone_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + longDescription: + 'Provision SMS- and voice-enabled numbers, send messages and tapback reactions, place outbound calls, manage conversations and contacts, and inspect usage.', + ...withSavedCredential(AgentPhoneBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'agentphone', + title: 'AgentPhone Credential', + }), +} diff --git a/apps/sim/blocks/blocks/ahrefs.ts b/apps/sim/blocks/blocks/ahrefs.ts index 9cad0561fda..7ed13eea720 100644 --- a/apps/sim/blocks/blocks/ahrefs.ts +++ b/apps/sim/blocks/blocks/ahrefs.ts @@ -1,6 +1,7 @@ import { AhrefsIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' const COUNTRY_OPTIONS = [ { label: 'United States', id: 'us' }, @@ -89,6 +90,8 @@ Return ONLY the date string in YYYY-MM-DD format - no explanations, no quotes, n export const AhrefsBlock: BlockConfig = { type: 'ahrefs', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'ahrefs_v2' }, name: 'Ahrefs', description: 'SEO analysis with Ahrefs', authMode: AuthMode.ApiKey, @@ -1558,3 +1561,19 @@ export const AhrefsBlockMeta = { }, ], } as const satisfies BlockMeta + +export const AhrefsV2Block: BlockConfig = { + ...AhrefsBlock, + type: 'ahrefs_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + longDescription: + 'Analyze domain ratings, backlinks, organic keywords, top pages, and more. API v3 is available on Lite and higher plans.', + ...withSavedCredential(AhrefsBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'ahrefs', + title: 'Ahrefs Credential', + }), +} diff --git a/apps/sim/blocks/blocks/apify.ts b/apps/sim/blocks/blocks/apify.ts index 6cdbaff28fb..8b3c9a74579 100644 --- a/apps/sim/blocks/blocks/apify.ts +++ b/apps/sim/blocks/blocks/apify.ts @@ -1,12 +1,15 @@ import { ApifyIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' const RUN_OPERATIONS = ['apify_run_actor_sync', 'apify_run_actor_async'] const RUN_OR_TASK_OPERATIONS = [...RUN_OPERATIONS, 'apify_run_task'] export const ApifyBlock: BlockConfig = { type: 'apify', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'apify_v2' }, name: 'Apify', description: 'Run Apify actors and retrieve results', authMode: AuthMode.ApiKey, @@ -373,3 +376,17 @@ export const ApifyBlockMeta = { }, ], } as const satisfies BlockMeta + +export const ApifyV2Block: BlockConfig = { + ...ApifyBlock, + type: 'apify_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + ...withSavedCredential(ApifyBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'apify', + title: 'Apify Credential', + }), +} diff --git a/apps/sim/blocks/blocks/apollo.ts b/apps/sim/blocks/blocks/apollo.ts index 0abf080bd29..df3cc143894 100644 --- a/apps/sim/blocks/blocks/apollo.ts +++ b/apps/sim/blocks/blocks/apollo.ts @@ -3,12 +3,15 @@ import { getErrorMessage } from '@sim/utils/errors' import { ApolloIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' /** Identifies a person by email when available, otherwise by given name. */ const PERSON_IDENTITY_FIELD = ['email', 'first_name'] as const export const ApolloBlock: BlockConfig = { type: 'apollo', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'apollo_v2' }, name: 'Apollo', description: 'Search, enrich, and manage contacts with Apollo.io', authMode: AuthMode.ApiKey, @@ -1585,3 +1588,17 @@ export const ApolloBlockMeta = { }, ], } as const satisfies BlockMeta + +export const ApolloV2Block: BlockConfig = { + ...ApolloBlock, + type: 'apollo_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + ...withSavedCredential(ApolloBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'apollo', + title: 'Apollo Credential', + }), +} diff --git a/apps/sim/blocks/blocks/appconfig.ts b/apps/sim/blocks/blocks/appconfig.ts index 4627d32bafc..9df239fa950 100644 --- a/apps/sim/blocks/blocks/appconfig.ts +++ b/apps/sim/blocks/blocks/appconfig.ts @@ -1,9 +1,12 @@ import { AppConfigIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' export const AppConfigBlock: BlockConfig = { type: 'appconfig', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'appconfig_v2' }, name: 'AWS AppConfig', description: 'Manage and retrieve configuration with AWS AppConfig', longDescription: @@ -810,3 +813,19 @@ export const AppConfigBlockMeta = { }, ], } as const satisfies BlockMeta + +export const AppConfigV2Block: BlockConfig = { + ...AppConfigBlock, + type: 'appconfig_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + longDescription: + 'Manage applications, environments, and configuration profiles, create and read hosted configuration versions, run and inspect deployments, and retrieve the latest deployed configuration at runtime.', + ...withSavedCredential(AppConfigBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'aws', + title: 'AWS Credential', + }), +} diff --git a/apps/sim/blocks/blocks/athena.ts b/apps/sim/blocks/blocks/athena.ts index 27f7eaac49d..923de16a681 100644 --- a/apps/sim/blocks/blocks/athena.ts +++ b/apps/sim/blocks/blocks/athena.ts @@ -1,6 +1,7 @@ import { AthenaIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' -import { IntegrationType } from '@/blocks/types' +import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' /** * Normalizes a switch value that may arrive as a boolean or as the strings 'true' / 'false'. @@ -14,6 +15,8 @@ function parseBoolean(value: unknown): boolean | undefined { export const AthenaBlock: BlockConfig = { type: 'athena', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'athena_v2' }, name: 'Athena', description: 'Run SQL queries on data in Amazon S3 using AWS Athena', longDescription: @@ -1395,3 +1398,19 @@ export const AthenaBlockMeta = { }, ], } as const satisfies BlockMeta + +export const AthenaV2Block: BlockConfig = { + ...AthenaBlock, + type: 'athena_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + longDescription: + 'Execute SQL queries against data in S3, check query status and runtime statistics, retrieve results, manage named queries and prepared statements, and inspect data catalogs, databases, tables, and workgroups.', + ...withSavedCredential(AthenaBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'aws', + title: 'AWS Credential', + }), +} diff --git a/apps/sim/blocks/blocks/brex.ts b/apps/sim/blocks/blocks/brex.ts index 7bc184888a7..51e119edd6e 100644 --- a/apps/sim/blocks/blocks/brex.ts +++ b/apps/sim/blocks/blocks/brex.ts @@ -1,7 +1,7 @@ import { BrexIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' -import { normalizeFileInput } from '@/blocks/utils' +import { normalizeFileInput, withSavedCredential } from '@/blocks/utils' /** Coerces a required money-amount field to a finite number, throwing on blank/non-numeric input rather than silently sending 0 or NaN to Brex. */ function toRequiredAmount(value: unknown, fieldLabel: string): number { @@ -59,6 +59,8 @@ const RECEIPT_FILE_FIELD = ['uploadReceiptFile', 'receiptFileReference'] as cons export const BrexBlock: BlockConfig = { type: 'brex', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'brex_v2' }, name: 'Brex', description: 'Manage expenses, receipts, transactions, and team data in Brex', authMode: AuthMode.ApiKey, @@ -1361,3 +1363,17 @@ export const BrexBlockMeta = { }, ], } as const satisfies BlockMeta + +export const BrexV2Block: BlockConfig = { + ...BrexBlock, + type: 'brex_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + ...withSavedCredential(BrexBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'brex', + title: 'Brex Credential', + }), +} diff --git a/apps/sim/blocks/blocks/brightdata.ts b/apps/sim/blocks/blocks/brightdata.ts index 7729399d634..ea9ee0d21d9 100644 --- a/apps/sim/blocks/blocks/brightdata.ts +++ b/apps/sim/blocks/blocks/brightdata.ts @@ -1,9 +1,12 @@ import { BrightDataIcon } from '@/components/icons' import type { BlockConfig, BlockMeta } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' export const BrightDataBlock: BlockConfig = { type: 'brightdata', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'brightdata_v2' }, name: 'Bright Data', description: 'Scrape websites, search engines, and extract structured data', authMode: AuthMode.ApiKey, @@ -564,3 +567,17 @@ export const BrightDataBlockMeta = { }, ], } as const satisfies BlockMeta + +export const BrightDataV2Block: BlockConfig = { + ...BrightDataBlock, + type: 'brightdata_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + ...withSavedCredential(BrightDataBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'brightdata', + title: 'Bright Data Credential', + }), +} diff --git a/apps/sim/blocks/blocks/browser_use.ts b/apps/sim/blocks/blocks/browser_use.ts index fbbb43463b1..0165d2e4968 100644 --- a/apps/sim/blocks/blocks/browser_use.ts +++ b/apps/sim/blocks/blocks/browser_use.ts @@ -1,8 +1,11 @@ import { BrowserUseIcon } from '@/components/icons' import { AuthMode, type BlockConfig, type BlockMeta, IntegrationType } from '@/blocks/types' +import { withSavedCredential } from '@/blocks/utils' export const BrowserUseBlock: BlockConfig = { type: 'browser_use', + hideFromToolbar: true, + sunset: { status: 'legacy', replacedBy: 'browser_use_v2' }, name: 'Browser Use', description: 'Run browser automation tasks', authMode: AuthMode.ApiKey, @@ -318,3 +321,17 @@ export const BrowserUseBlockMeta = { }, ], } as const satisfies BlockMeta + +export const BrowserUseV2Block: BlockConfig = { + ...BrowserUseBlock, + type: 'browser_use_v2', + authMode: AuthMode.OAuth, + hideFromToolbar: false, + sunset: undefined, + ...withSavedCredential(BrowserUseBlock, { + id: 'credential', + type: 'oauth-input', + serviceId: 'browser_use', + title: 'Browser Use Credential', + }), +} diff --git a/apps/sim/blocks/blocks/buffer.ts b/apps/sim/blocks/blocks/buffer.ts index b60c406504f..b1704172957 100644 --- a/apps/sim/blocks/blocks/buffer.ts +++ b/apps/sim/blocks/blocks/buffer.ts @@ -1,7 +1,7 @@ import { BufferIcon } from '@/components/icons' import type { BlockConfig, BlockMeta, SubBlockConfig } from '@/blocks/types' import { AuthMode, IntegrationType } from '@/blocks/types' -import { normalizeFileInput } from '@/blocks/utils' +import { normalizeFileInput, withSavedCredential } from '@/blocks/utils' import { getToolMetadata } from '@/tools/metadata' const POST_EDIT_OPS = ['create_post', 'edit_post'] @@ -39,6 +39,8 @@ function timestampWand(purpose: string): NonNullable