← Tools Reference

Basin

Basin integration (Productivity, Marketing). Imported from open-connector.

API key18 toolshttps://usebasin.com
GET
basin_list_projects
List projects available to the current Basin API key.

/api/v1/projects

2 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number to request from Basin.
querystringoptionalSearch query accepted by the Basin list endpoint.
GET
basin_get_project
Fetch a single Basin project by ID.

/api/v1/projects/{project_id}

1 parameter
ParamTypeRequiredDescription
project_idintegerrequiredBasin project ID.
POST
basin_create_project
Create a new Basin project.

/api/v1/projects/

1 parameter
ParamTypeRequiredDescription
namestringoptionalProject name.
PUT
basin_update_project
Update an existing Basin project by ID.

/api/v1/projects/{project_id}

2 parameters
ParamTypeRequiredDescription
project_idintegerrequiredBasin project ID.
namestringoptionalProject name.
DELETE
basin_delete_project
Delete a Basin project by ID.

/api/v1/projects/{project_id}

1 parameter
ParamTypeRequiredDescription
project_idintegerrequiredBasin project ID.
GET
basin_list_forms
List forms available to the current Basin API key.

/api/v1/forms

2 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number to request from Basin.
querystringoptionalSearch query accepted by the Basin list endpoint.
GET
basin_get_form
Fetch a single Basin form by ID.

/api/v1/forms/{form_id}

1 parameter
ParamTypeRequiredDescription
form_idstringrequiredBasin form ID.
POST
basin_create_form
Create a new Basin form.

/api/v1/forms/

27 parameters
ParamTypeRequiredDescription
namestringrequiredForm name.
timezonestringrequiredIANA timezone used for form timestamps.
project_idintegerrequiredBasin project ID.
redirect_urlstringoptionalURL to redirect users to after submission.
use_ajaxbooleanoptionalWhether the form should submit via AJAX.
notification_emailsstringoptionalComma-separated email addresses notified for each submission.
notification_cc_emailsstringoptionalComma-separated CC email addresses for submission notifications.
notification_bcc_emailsstringoptionalComma-separated BCC email addresses for submission notifications.
notification_subjectstringoptionalSubject for submission notification emails.
notification_from_namestringoptionalFrom name for submission notification emails.
autoreplybooleanoptionalWhether Basin should send auto-reply emails.
autoreply_bodystringoptionalBody text for auto-reply emails.
autoreply_subjectstringoptionalSubject for auto-reply emails.
autoreply_from_namestringoptionalFrom name for auto-reply emails.
autoreply_greetingstringoptionalGreeting text for auto-reply emails.
autoreply_namestringoptionalSender display name for auto-reply emails.
autoreply_titlestringoptionalTitle text for auto-reply emails.
autoreply_emailstringoptionalReply-to email address for auto-reply emails.
force_recaptchabooleanoptionalWhether Google reCAPTCHA is required.
force_hcaptchabooleanoptionalWhether hCaptcha is required.
force_turnstilebooleanoptionalWhether Cloudflare Turnstile is required.
honeypot_fieldstringoptionalHoneypot field name used for spam filtering.
retention_daysintegeroptionalNumber of days to retain form submissions.
allowed_domainsarrayoptionalDomains allowed to submit the form.
blocked_domainsarrayoptionalDomains blocked from submitting the form.
duplicate_filterbooleanoptionalWhether Basin should filter duplicate submissions.
smtp_email_validationbooleanoptionalWhether SMTP email validation is enabled.
PUT
basin_update_form
Update an existing Basin form by ID.

/api/v1/forms/{form_id}

28 parameters
ParamTypeRequiredDescription
form_idstringrequiredBasin form ID.
namestringoptionalForm name.
timezonestringoptionalIANA timezone used for form timestamps.
project_idintegeroptionalBasin project ID.
redirect_urlstringoptionalURL to redirect users to after submission.
use_ajaxbooleanoptionalWhether the form should submit via AJAX.
notification_emailsstringoptionalComma-separated email addresses notified for each submission.
notification_cc_emailsstringoptionalComma-separated CC email addresses for submission notifications.
notification_bcc_emailsstringoptionalComma-separated BCC email addresses for submission notifications.
notification_subjectstringoptionalSubject for submission notification emails.
notification_from_namestringoptionalFrom name for submission notification emails.
autoreplybooleanoptionalWhether Basin should send auto-reply emails.
autoreply_bodystringoptionalBody text for auto-reply emails.
autoreply_subjectstringoptionalSubject for auto-reply emails.
autoreply_from_namestringoptionalFrom name for auto-reply emails.
autoreply_greetingstringoptionalGreeting text for auto-reply emails.
autoreply_namestringoptionalSender display name for auto-reply emails.
autoreply_titlestringoptionalTitle text for auto-reply emails.
autoreply_emailstringoptionalReply-to email address for auto-reply emails.
force_recaptchabooleanoptionalWhether Google reCAPTCHA is required.
force_hcaptchabooleanoptionalWhether hCaptcha is required.
force_turnstilebooleanoptionalWhether Cloudflare Turnstile is required.
honeypot_fieldstringoptionalHoneypot field name used for spam filtering.
retention_daysintegeroptionalNumber of days to retain form submissions.
allowed_domainsarrayoptionalDomains allowed to submit the form.
blocked_domainsarrayoptionalDomains blocked from submitting the form.
duplicate_filterbooleanoptionalWhether Basin should filter duplicate submissions.
smtp_email_validationbooleanoptionalWhether SMTP email validation is enabled.
DELETE
basin_delete_form
Delete a Basin form by ID.

/api/v1/forms/{form_id}

1 parameter
ParamTypeRequiredDescription
form_idstringrequiredBasin form ID.
GET
basin_list_submissions
List Basin form submissions with optional filters.

/api/v1/submissions/

5 parameters
ParamTypeRequiredDescription
form_idstringoptionalBasin form ID used to filter submissions.
filter_bystringoptionalSubmission status filter accepted by Basin.
querystringoptionalSearch text for matching submissions.
order_bystringoptionalSubmission sort order accepted by Basin.
date_rangestringoptionalDate range in YYYY-MM-DD+to+YYYY-MM-DD format accepted by Basin.
GET
basin_get_submission
Fetch a single Basin submission by ID.

/api/v1/submissions/{submission_id}

1 parameter
ParamTypeRequiredDescription
submission_idintegerrequiredBasin submission ID.
DELETE
basin_delete_submission
Delete a Basin submission by ID.

/api/v1/submissions/{submission_id}

1 parameter
ParamTypeRequiredDescription
submission_idintegerrequiredBasin submission ID.
GET
basin_list_form_webhooks
List Basin form webhooks with optional filters.

/api/v1/form_webhooks

2 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number to request from Basin.
querystringoptionalSearch query accepted by the Basin list endpoint.
GET
basin_get_form_webhook
Fetch a single Basin form webhook by ID.

/api/v1/form_webhooks/{webhook_id}

1 parameter
ParamTypeRequiredDescription
webhook_idintegerrequiredBasin form webhook ID.
POST
basin_create_form_webhook
Create a new Basin form webhook.

/api/v1/form_webhooks/

6 parameters
ParamTypeRequiredDescription
form_idintegerrequiredBasin form ID to attach the webhook to.
namestringrequiredFriendly webhook name.
urlstringrequiredDestination URL where Basin posts submission payloads.
formatstringoptionalWebhook payload format accepted by Basin.
enabledbooleanoptionalWhether the webhook is enabled.
trigger_when_spambooleanoptionalWhether the webhook fires for spam submissions.
PUT
basin_update_form_webhook
Update an existing Basin form webhook by ID.

/api/v1/form_webhooks/{webhook_id}

7 parameters
ParamTypeRequiredDescription
webhook_idintegerrequiredBasin form webhook ID.
form_idintegeroptionalBasin form ID to attach the webhook to.
namestringoptionalFriendly webhook name.
urlstringoptionalDestination URL where Basin posts submission payloads.
formatstringoptionalWebhook payload format accepted by Basin.
enabledbooleanoptionalWhether the webhook is enabled.
trigger_when_spambooleanoptionalWhether the webhook fires for spam submissions.
DELETE
basin_delete_form_webhook
Delete a Basin form webhook by ID.

/api/v1/form_webhooks/{webhook_id}

1 parameter
ParamTypeRequiredDescription
webhook_idintegerrequiredBasin form webhook ID.