The Formcarry connector lets your AI agent act in each user's Formcarry account. Each user connects their own Formcarry access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 26 tools.
- Tools
- 26
- What they doRead · write · destructive
- 14 · 8 · 414 read8 write4 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Formcarry connection
In AgentKit > Connections, create a Formcarry connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'formcarry'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Formcarry:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'formcarry_email_servers_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "formcarry"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Formcarry:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="formcarry_email_servers_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Formcarry credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolformcarry_email_servers_listList the email servers set up in the dashboard for sending notifications: your own SMTP servers (email_server) and verified sending domains (premium_server).Read-onlyList Email Servers
List the email servers set up in the dashboard for sending notifications: your own SMTP servers (email_server) and verified sending domains (premium_server). Returns each server's id, type and details. Use the id as self_email_notification.sender.server_id in Create Form or Update Form.
Inputs
This tool takes no inputs.
formcarry_form_fields_listList the field names in the form's newest 2,000 submissions, most used first (up to 200 names).Read-onlyList Form Fields
List the field names in the form's newest 2,000 submissions, most used first (up to 200 names). Returns each field name with how many submissions carry it and when it was last seen. Use this to pick field names for the fields filter or group_by in submission tools.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
formcarry_form_getGet one form with its full configuration.Read-onlyGet Form
Get one form with its full configuration. Returns the form's id, name, endpoint URL, active state and storage, spam, notification, auto-response, after-submit and validation settings. Use this when you know the form ID. Use List Forms to find it.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
formcarry_forms_listList the forms the API key can access, newest first, each with its full configuration.Read-onlyList Forms
List the forms the API key can access, newest first, each with its full configuration. Returns data[] of forms with id, name, endpoint URL and settings, plus next_cursor. Use this to find a form ID. Use Get Form for one form.
Inputs
cursorstring- next_cursor from the previous page. Example: eyJpZCI6IjY2NTAifQ.
limitinteger- Forms per page, 1 to 100 (default 25). Example: 50.
team_idstring- Only forms of this team (one the key covers). Example: 64b000000000000000000001.
formcarry_me_getGet the API key used for this connection: its scopes and the teams and forms it can access.Read-onlyGet API Key Details
Get the API key used for this connection: its scopes and the teams and forms it can access. Returns the key's id, scopes and accessible teams and forms. Use this to check what the key may do before calling other tools.
Inputs
This tool takes no inputs.
formcarry_submission_deliveries_getGet what happened to up to 20 submissions after they arrived: every email, webhook, Zapier zap and integration each was sent to, with the latest outcome.Read-onlyGet Submission Deliveries
Get what happened to up to 20 submissions after they arrived: every email, webhook, Zapier zap and integration each was sent to, with the latest outcome. Returns one row per target and a rolled-up status per submission (null when older than 18 months). Use this to debug missing notifications. Use List Webhook Deliveries for one webhook's log.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
submission_idsstringrequired- 1 to 20 submission IDs of this form, comma-separated. Example: 6650f0e1d2c3b4a596877766,6650f0e1d2c3b4a596877767.
formcarry_submission_getGet one submission with its fields and uploaded files.Read-onlyGet Submission
Get one submission with its fields and uploaded files. Returns the submission's id, fields, files, status and created_at. Use this when you know the submission ID. Use List Submissions to find it.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
submission_idstringrequired- ID of the submission, from List Submissions or Search Submissions. Example: 6650f0e1d2c3b4a596877766.
formcarry_submissions_countCount one form's submissions matching the same filters as List Submissions, optionally grouped by day, week, month, country, spam, read or a field.Read-onlyCount Submissions
Count one form's submissions matching the same filters as List Submissions, optionally grouped by day, week, month, country, spam, read or a field. Returns the total or the 20 largest groups plus other, and exact (false when the count timed out). Use this to size a result before listing.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
countrystring- Only submissions from these countries: two-letter uppercase codes, comma-separated, up to 20. Example: US,CA.
created_afterstring- Only submissions created at or after this time (RFC 3339 or epoch milliseconds). Example: 2025-01-01T00:00:00Z.
created_beforestring- Only submissions created before this time (RFC 3339 or epoch milliseconds). Example: 2025-02-01T00:00:00Z.
group_bystring- Group the count by day, week, month, country, spam, read or field:<name>. Leave empty for one total. Example: week.
has_attachmentsstring- true for only submissions with uploaded files, false for only those without. Example: true.one of
truefalse qstring- Only submissions where any field contains this text (case-insensitive, 2 to 512 characters). Example: refund.
readstring- true for only submissions read in the dashboard, false for only unread ones. Example: false.one of
truefalse statusstring- Which submissions to include: inbox (default), spam or all. Example: inbox.one of
inboxspamall
formcarry_submissions_listList one form's submissions, newest first, filtered by status, read state, attachments, dates, country or text.Read-onlyList Submissions
List one form's submissions, newest first, filtered by status, read state, attachments, dates, country or text. Returns data[] of submissions with id, fields, files and created_at, plus next_cursor (null on the last page). Use this for one form. Use Search Submissions across forms. Use Count Submissions for totals.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
countrystring- Only submissions from these countries: two-letter uppercase codes, comma-separated, up to 20. Example: US,CA.
created_afterstring- Only submissions created at or after this time (RFC 3339 or epoch milliseconds). Example: 2025-01-01T00:00:00Z.
created_beforestring- Only submissions created before this time (RFC 3339 or epoch milliseconds). Example: 2025-02-01T00:00:00Z.
cursorstring- next_cursor from the previous page. Example: eyJpZCI6IjY2NTAifQ.
fieldsstring- Only return these submitted fields, comma-separated. Example: email,message.
has_attachmentsstring- true for only submissions with uploaded files, false for only those without. Example: true.one of
truefalse limitinteger- Submissions per page, 1 to 100 (default 25). Example: 50.
orderstring- newest (default) or oldest first. Example: oldest.one of
newestoldest qstring- Only submissions where any field contains this text (case-insensitive, 2 to 512 characters). Example: refund.
readstring- true for only submissions read in the dashboard, false for only unread ones. Example: false.one of
truefalse statusstring- Which submissions to include: inbox (default), spam or all. Example: inbox.one of
inboxspamall
formcarry_submissions_searchSearch submissions across the 25 most recently active forms (or the forms you name), with the same filters as List Submissions.Read-onlySearch Submissions
Search submissions across the 25 most recently active forms (or the forms you name), with the same filters as List Submissions. Returns matches grouped by form, and complete false when not every form or match was reached. Use this when you do not know the form. Use List Submissions to page through one form.
Inputs
countrystring- Only submissions from these countries: two-letter uppercase codes, comma-separated, up to 20. Example: US,CA.
created_afterstring- Only submissions created at or after this time (RFC 3339 or epoch milliseconds). Example: 2025-01-01T00:00:00Z.
created_beforestring- Only submissions created before this time (RFC 3339 or epoch milliseconds). Example: 2025-02-01T00:00:00Z.
fieldsstring- Only return these submitted fields, comma-separated. Example: email,message.
form_idsstring- Search only these form IDs, comma-separated. Example: Gx7kZ2pQrS,Hy8lA3qRsT.
has_attachmentsstring- true for only submissions with uploaded files, false for only those without. Example: true.one of
truefalse limitinteger- Matches to return in total, 1 to 100 (default 25); this search has no pages. Example: 50.
orderstring- newest (default) or oldest first. Example: newest.one of
newestoldest qstring- Only submissions where any field contains this text (case-insensitive, 2 to 512 characters). Example: refund.
readstring- true for only submissions read in the dashboard, false for only unread ones. Example: false.one of
truefalse statusstring- Which submissions to include: inbox (default), spam or all. Example: inbox.one of
inboxspamall team_idstring- Search this team only. Example: 64b000000000000000000001.
formcarry_webhook_deliveries_listList a webhook's delivery log, newest first, one entry per submission with its latest outcome.Read-onlyList Webhook Deliveries
List a webhook's delivery log, newest first, one entry per submission with its latest outcome. Kept 18 months. Returns deliveries with submission id, status, the HTTP status your endpoint returned, error text and occurred_at. Use Get Webhook Delivery for one submission. Use Redeliver Submission to retry.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
webhook_idstringrequired- ID of the webhook, from List Webhooks or Add Webhook. Example: 6650a1b2c3d4e5f6a7b8c9d0.
beforestring- Only deliveries before this time: pass the last occurred_at of the previous page. Example: 2025-01-15T10:00:00Z.
limitinteger- Deliveries per page, 1 to 100 (default 25). Example: 50.
statusstring- Only deliveries in this state: succeeded, failed, retrying, pending or skipped. Example: failed.one of
succeededfailedretryingpendingskipped
formcarry_webhook_delivery_getGet the latest outcome of one submission's delivery to a webhook.Read-onlyGet Webhook Delivery
Get the latest outcome of one submission's delivery to a webhook. Returns the delivery's status, the HTTP status your endpoint returned, error text and occurred_at. Use List Webhook Deliveries to browse the log.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
submission_idstringrequired- ID of the submission, from List Submissions or Search Submissions. Example: 6650f0e1d2c3b4a596877766.
webhook_idstringrequired- ID of the webhook, from List Webhooks or Add Webhook. Example: 6650a1b2c3d4e5f6a7b8c9d0.
formcarry_webhook_getGet one webhook of a form, without its secret.Read-onlyGet Webhook
Get one webhook of a form, without its secret. Returns the webhook's id, url, enabled, description and events. Use List Webhooks to find the webhook ID.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
webhook_idstringrequired- ID of the webhook, from List Webhooks or Add Webhook. Example: 6650a1b2c3d4e5f6a7b8c9d0.
formcarry_webhooks_listList a form's webhooks.Read-onlyList Webhooks
List a form's webhooks. Returns data[] with each webhook's id, url, enabled, description and events (the signing secret is not included). Use this to find a webhook ID.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
formcarry_form_createCreate a form, optionally with storage, spam, email notification, auto-response, after-submit and validation settings.WriteCreate Form
Create a form, optionally with storage, spam, email notification, auto-response, after-submit and validation settings. Returns the new form with its id and endpoint URL (https://formcarry.com/s/<id>) to post submissions to. Settings your plan does not include are refused and no form is created.
Inputs
namestringrequired- Form name, up to 128 characters. Example: Contact form.
activeboolean- Whether the form accepts submissions; inactive forms reject them. Example: true.
after_submitobject- What the visitor sees after submitting: type plus either a hosted thank-you page (page) or a redirect URL (redirect). Example: {"page": {"headline": "Thanks!"}}.
auto_responseobject- The email the person who submitted receives: enabled, subject, from_name, logo_url, logo_height and template. Example: {"enabled": true, "subject": "Thanks for reaching out"}.
folder_idstring- Folder to file the form in. Example: 64b000000000000000000010.
self_email_notificationobject- The email you get on every submission: enabled, recipients (list of addresses), include_spam, subject, logo_url, logo_height, template and sender (server_id from List Email Servers). Example: {"enabled": true, "recipients": ["me@company.com"]}.
spamobject- Spam settings: protection (formcarry's built-in filter) and captcha, with a provider (none, recaptcha, hcaptcha or turnstile) and that provider's secret_key. Example: {"protection": true, "captcha": {"provider": "turnstile", "secret_key": "0x4AAAA..."}}.
storageobject- Storage settings: store_submissions (false forwards by email and webhook without storing) and keep_for (30_days, 60_days, 90_days, 180_days, 365_days or forever). Example: {"store_submissions": true, "keep_for": "90_days"}.
team_idstring- Team that owns the form; needed only when the key covers several teams. Example: 64b000000000000000000001.
validationobject- Rules a submission must pass: enabled and rules (a list of field rules). Example: {"enabled": true, "rules": []}.
formcarry_form_recipient_addAdd one address to the list that gets an email on every submission, keeping the others.WriteAdd Notification Recipient
Add one address to the list that gets an email on every submission, keeping the others. Adding an existing address changes nothing. Returns the form's notification settings. The free plan allows one recipient. To replace the whole list, use Update Form.
- Idempotent
Inputs
emailstringrequired- Email address to add. Example: me@company.com.
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
formcarry_form_updateChange a form's name, active state or settings.WriteUpdate Form
Change a form's name, active state or settings. Only what you send changes: nested objects are merged, lists such as recipients and rules are replaced whole. Returns the updated form. Use Get Form first to read the current settings.
- Idempotent
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
activeboolean- Whether the form accepts submissions; inactive forms reject them. Example: true.
after_submitobject- What the visitor sees after submitting: type plus either a hosted thank-you page (page) or a redirect URL (redirect). Example: {"page": {"headline": "Thanks!"}}.
auto_responseobject- The email the person who submitted receives: enabled, subject, from_name, logo_url, logo_height and template. Example: {"enabled": true, "subject": "Thanks for reaching out"}.
folder_idstring- Folder to file the form in. Example: 64b000000000000000000010.
namestring- New form name, up to 128 characters. Example: Contact form (EN).
self_email_notificationobject- The email you get on every submission: enabled, recipients (list of addresses), include_spam, subject, logo_url, logo_height, template and sender (server_id from List Email Servers). Example: {"enabled": true, "recipients": ["me@company.com"]}.
spamobject- Spam settings: protection (formcarry's built-in filter) and captcha, with a provider (none, recaptcha, hcaptcha or turnstile) and that provider's secret_key. Example: {"protection": true, "captcha": {"provider": "turnstile", "secret_key": "0x4AAAA..."}}.
storageobject- Storage settings: store_submissions (false forwards by email and webhook without storing) and keep_for (30_days, 60_days, 90_days, 180_days, 365_days or forever). Example: {"store_submissions": true, "keep_for": "90_days"}.
validationobject- Rules a submission must pass: enabled and rules (a list of field rules). Example: {"enabled": true, "rules": []}.
formcarry_submission_restoreMove a spam submission back to the inbox.WriteRestore Submission
Move a spam submission back to the inbox. Returns the updated submission. Use Mark Submission as Spam for the reverse.
- Idempotent
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
submission_idstringrequired- ID of the submission, from List Submissions or Search Submissions. Example: 6650f0e1d2c3b4a596877766.
formcarry_submission_spam_markMove a submission to spam, so it is left out of lists unless status is spam or all.WriteMark Submission as Spam
Move a submission to spam, so it is left out of lists unless status is spam or all. Returns the updated submission. Use Restore Submission to move it back to the inbox.
- Idempotent
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
submission_idstringrequired- ID of the submission, from List Submissions or Search Submissions. Example: 6650f0e1d2c3b4a596877766.
formcarry_webhook_createAdd a webhook that receives every submission of the form as a signed JSON POST.WriteAdd Webhook
Add a webhook that receives every submission of the form as a signed JSON POST. Up to 10 per form, one per URL, on plans with webhooks. Returns the webhook with its signing secret, shown only in this response. Store the secret to verify deliveries.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
urlstringrequired- HTTPS URL that receives each submission as a JSON POST, up to 2048 characters. Example: https://example.com/hooks/formcarry.
descriptionstring- Label for your own reference, up to 128 characters. Example: CRM sync.
enabledboolean- Whether the webhook receives submissions; a disabled webhook keeps its settings. Example: true.
eventsarray- Events to send. Only submission.created exists today. Example: ["submission.created"].
formcarry_webhook_redeliverQueue one submission to be sent again to one webhook, freshly signed, even if the webhook is paused.WriteRedeliver Submission
Queue one submission to be sent again to one webhook, freshly signed, even if the webhook is paused. Returns 202 with confirmation that it was queued, not delivered. Use Get Webhook Delivery afterwards for the outcome. Your endpoint repeats whatever it does with the submission.
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
submission_idstringrequired- ID of the submission, from List Submissions or Search Submissions. Example: 6650f0e1d2c3b4a596877766.
webhook_idstringrequired- ID of the webhook, from List Webhooks or Add Webhook. Example: 6650a1b2c3d4e5f6a7b8c9d0.
formcarry_webhook_updateChange a webhook's URL, enabled state, description or events; the secret stays the same.WriteUpdate Webhook
Change a webhook's URL, enabled state, description or events; the secret stays the same. Returns the updated webhook. Only the fields you send change.
- Idempotent
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
webhook_idstringrequired- ID of the webhook, from List Webhooks or Add Webhook. Example: 6650a1b2c3d4e5f6a7b8c9d0.
descriptionstring- Label for your own reference, up to 128 characters. Example: CRM sync.
enabledboolean- Whether the webhook receives submissions; a disabled webhook keeps its settings. Example: true.
eventsarray- Events to send. Only submission.created exists today. Example: ["submission.created"].
urlstring- New endpoint URL. Example: https://example.com/hooks/formcarry-v2.
formcarry_form_deletePermanently delete a form.DestructiveDelete Form
Permanently delete a form. Its stored submissions, exports and integrations are kept. This cannot be undone. Returns a confirmation. Use Update Form with active false to stop submissions without deleting.
- Idempotent
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
formcarry_form_recipient_removeRemove one address from the list that gets an email on every submission, keeping the others.DestructiveRemove Notification Recipient
Remove one address from the list that gets an email on every submission, keeping the others. Returns the form's notification settings. Use Get Form to see the current recipients.
- Idempotent
Inputs
emailstringrequired- Email address to remove. Example: me@company.com.
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
formcarry_submission_deletePermanently delete a submission.DestructiveDelete Submission
Permanently delete a submission. Its uploaded files are not deleted. This cannot be undone. Returns a confirmation. Use Mark Submission as Spam to hide it from the inbox instead.
- Idempotent
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
submission_idstringrequired- ID of the submission, from List Submissions or Search Submissions. Example: 6650f0e1d2c3b4a596877766.
formcarry_webhook_deleteRemove a webhook so later submissions are not sent to it; deliveries already queued may still complete.DestructiveDelete Webhook
Remove a webhook so later submissions are not sent to it; deliveries already queued may still complete. Returns a confirmation. Use Update Webhook with enabled false to pause it instead.
- Idempotent
Inputs
form_idstringrequired- ID of the formcarry form, from List Forms or the form's endpoint URL (https://formcarry.com/s/<form_id>). Example: Gx7kZ2pQrS.
webhook_idstringrequired- ID of the webhook, from List Webhooks or Add Webhook. Example: 6650a1b2c3d4e5f6a7b8c9d0.
No tools match.