Skip to main content
Basin logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 19
  • Triggers: 0
  • Slug: BASIN
  • Version: 20261101_00

Tools

Slug: BASIN_CREATE_FORMTool to create a new form in Basin. Use when you need to automate form setup with name, timezone, and project association; optionally configure redirect, notifications, or spam protection.

Input Parameters

string
required
Name of the form
string
required
IANA timezone used for form timestamps
boolean
Whether the form should submit via AJAX
integer
required
ID of the project under which this form is created
string
URL to redirect after submission
object
Email notification settings for a form.
object
Spam protection configuration for a form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_CREATE_FORM_WEBHOOKTool to create a new webhook for a specific form. Use when you need to programmatically add a webhook once you have the form ID and callback URL confirmed.

Input Parameters

string
required
Destination URL where Basin will POST the submission payload
string
required
Friendly label for this webhook (for your reference)
string
Payload format (e.g., ‘slack’). Omit for default JSON.
boolean
Whether the webhook is active upon creation
integer
required
ID of the form to attach the webhook to
boolean
If true, fire this webhook even when a submission is flagged as spam

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_CREATE_PROJECTTool to create a new Basin project. Use when you need a new organizational container for forms. Example: “Create a project named Marketing Leads.”

Input Parameters

string
required
Name of the new project; must be non-empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_DELETE_FORMTool to delete a form. Use when permanently removing a form after it’s no longer needed. Ensure the form_id is correct; this operation is irreversible.

Input Parameters

string
required
ID of the form to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_DELETE_PROJECTDeletes a Basin project by ID. The response includes the project ID and may include other deleted project details.

Input Parameters

integer
required
ID of the project to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_DELETE_SUBMISSIONTool to permanently delete a form submission by its ID. Use when you need to remove a submission after confirming its ID. This operation is irreversible.

Input Parameters

integer
required
ID of the submission to permanently delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_DELETE_WEBHOOKTool to delete a specific webhook. Use when you need to remove a webhook from a form after confirming its ID.

Input Parameters

integer
required
ID of the webhook to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_DOMAINSTool to retrieve a list of all custom domains associated with the Basin account. Custom domains allow you to send emails from your own domain through Basin forms. Supports pagination and filtering by domain name or ID.

Input Parameters

integer
Page number for pagination (starts at 0)
string
Filter domains by ID or name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_FORM_DETAILSRetrieves comprehensive details about a specific Basin form including configuration, notification settings, security options, branding, webhooks, and submission counts. Use this when you need complete information about a form’s setup and current state. Requires a form ID (obtain from Get Forms action if needed).

Input Parameters

string
required
The numeric ID of the form (as a string). Can be obtained from the ‘id’ field in the Get Forms action response. Example: ‘55229’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_FORMSRetrieves a list of all Basin forms with their configuration and metadata. Supports optional pagination via the ‘page’ parameter and filtering via the ‘query’ parameter (searches across form id, name, uuid, and project_id). Returns comprehensive form details including webhooks, submission counts, notification settings, and security configurations.

Input Parameters

integer
Page number for pagination (default: 1)
string
Filter forms by id, name, uuid, or project_id. Partial matches supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_FORM_WEBHOOKTool to retrieve details of a specific form webhook by its ID. Use when you need to view webhook configuration including URL, format, and trigger settings.

Input Parameters

string
required
ID of the form webhook to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_PROJECT_DETAILSTool to retrieve detailed information about a specific project. Use when you have a project ID and need its metadata (name, created_at, updated_at).

Input Parameters

string
required
Unique identifier of the project to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_PROJECTSRetrieves a list of Basin projects from your account. Returns project details including IDs, names, and timestamps. Use this to list all projects or filter by name/ID. The response includes pagination metadata to help navigate large result sets. Typical use: Get project IDs for use with other project-specific endpoints like forms or submissions.

Input Parameters

integer
Page number for pagination (default: 1). Use this to navigate through multiple pages of results.
string
Search filter to match projects by name or ID. Returns projects containing this text in their name or matching the ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_SUBMISSIONSRetrieve form submissions from Basin with optional filtering, sorting, and search capabilities. Can retrieve all submissions across forms or filter by specific form_id. Supports filtering by status (new/spam/trash/all), text search, date range, and sorting by date or email.

Input Parameters

string
Search submissions by text across all fields
string
ID of the form to get submissions from. Required if using a shared account API token.
string ("date_asc" | "date_desc" | "email_asc" | "email_desc")
Sort submissions by ‘date_asc’, ‘date_desc’, ‘email_asc’, or ‘email_desc’.
string ("new" | "spam" | "trash" | "all")
Filter submissions by status. One of ‘new’, ‘spam’, ‘trash’, or ‘all’.
string
Filter submissions by date range in format ‘YYYY-MM-DD+to+YYYY-MM-DD’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_GET_WEBHOOKSRetrieve webhooks for a specific form by form ID, with optional page and search parameters. Results are filtered by form ID from the returned page.

Input Parameters

integer
Page number for pagination, if multiple pages of webhooks exist
string
Optional search term to filter webhooks by name, id, url, or form_id
integer
required
ID of the form to retrieve webhooks for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_LIST_FORM_VIEWSLists legacy Form Builder (Form.io) views with configuration and metadata. Supports optional pagination and a query filter for form view ID, UUID, form ID, or form UUID.

Input Parameters

integer
Page number for pagination (default: 1)
string
Filter form views by id, uuid, form id, or form uuid. Partial matches supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_UPDATE_FORMTool to update an existing Basin form by ID. Use when you need to modify form settings including name, notifications, spam protection, redirects, or other configuration options.

Input Parameters

string
required
ID of the form to update
URL to logo image for the form
string
Name of the form
string
IANA timezone for the form
boolean
Whether the form should submit via AJAX
boolean
Whether to send auto-reply emails to submitters
integer
ID of custom domain to use for the form
integer
ID of the project this form belongs to
string
Custom domain email address
string
URL to redirect after form submission
string
Body text for auto-reply emails
string
Name to show as sender in auto-reply emails
boolean
Whether to require hCaptcha verification
string
Name of honeypot field to trap spam bots
integer
Number of days to retain form submissions
array
List of domains allowed to submit the form
string
Email address to send auto-replies from
string
Title for auto-reply emails
array
List of domains blocked from submitting the form
string
Custom HTML template for notification emails
boolean
Whether to require Google reCAPTCHA verification
boolean
Whether to require Cloudflare Turnstile verification
boolean
Whether to filter duplicate submissions
string
Heading text for redirect page
string
Message text for redirect page
string
Cloudflare Turnstile secret key
string
Subject line for auto-reply emails
string
Text color for submit button (hex code)
array
List of content patterns to block in submissions
string
Greeting text for auto-reply emails
boolean
Whether to send data receipt emails
string
Cloudflare Turnstile site key
string
From name for auto-reply emails
string
Comma-separated list of email addresses to notify on submission
boolean
Whether to use a custom template for notification emails
string
Custom subject line for notification emails
string
URL to redirect to when reCAPTCHA verification fails
string
Text for button on redirect page
boolean
Whether to hide the dashboard button on success page
boolean
Whether to validate email addresses via SMTP
string
Comma-separated list of CC email addresses for notifications
string
Name to show as sender in notification emails
string
Background color for submit button (hex code)
string
Comma-separated list of BCC email addresses for notifications
string
Comma-separated list of whitelisted source domains
string
Custom HTML template for auto-reply emails
string
Text color for redirect page button (hex code)
boolean
Whether to exclude the submitter from reply emails
boolean
Whether to use a custom template for auto-replies
integer
ID of confirmation mail template to use
integer
ID of notification mail template to use
integer
ID of auto-response mail template to use
string
Background color for redirect page button (hex code)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_UPDATE_PROJECTTool to update details of an existing project. Use when you need to change a project’s name after confirming the project ID. Example: “Update project 123 to ‘Rebrand Launch’”.

Input Parameters

string
required
New name for the project. Must be non-empty and cannot exceed 100 characters.
integer
required
ID of the project to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BASIN_UPDATE_WEBHOOKTool to update settings of an existing webhook for a form. Use after obtaining the webhook’s ID.

Input Parameters

string
Endpoint URL to receive webhook payloads
string
Human-readable name for this webhook
string
Payload format for this webhook. Valid values: ‘json’, ‘slack’, ‘form_url_encoded’
boolean
Whether this webhook is active after update
integer
ID of the form this webhook is attached to
integer
required
ID of the webhook to update
boolean
If true, send this webhook even on spam submissions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not