Ladeworks docs
Ladeworks moves data between your APIs and file servers without code. These pages show how, one step at a time, with screenshots from a Pro workspace.
Getting started
- What Ladeworks isLadeworks moves data between your APIs and file servers without code. Learn what integrations, endpoints, workflows and runs are, and who it is for.
- Sign upCreate a Ladeworks account with Google or email and password, name your workspace, and confirm your email. See what waits until you confirm.
- The welcome checklistThree steps to your first run in Ladeworks: connect an integration, build a workflow, then turn it on, run it once and check the results.
- A tour of the appFind your way around Ladeworks: the top bar, the Workflows home with its summary cards and table, Integrations, Settings and the Help menu.
Connect an integration
- Connecting an integrationAn integration is a saved, tested connection to an API or a file server. See the two kinds, the five setup steps and what happens when you finish.
- An API from a docs linkPaste a link to an API's docs and Ladeworks looks for its spec. See what happens when a spec is found or not found, the live check of endpoints, spec links and uploads, and setting up by hand.
- Sign-in methodsHow Ladeworks signs in to an API: API key, Bearer token, Basic, OAuth 2.0 (authorization code, client credentials and refresh token), no sign-in, and what From spec means.
- A file serverConnect an SFTP, FTPS or FTP server to Ladeworks: the details to ask for, the firewall addresses, the host key fingerprint, passwords and SSH keys, and pick up and drop off folders.
- The test stepStep 4 tests the connection for real. See what a pass and a fail look like for an API and for a file server, how to confirm a host key fingerprint, and what Continue anyway does.
- The integration pageEach integration has a page with Endpoints (or Folders), API changes and Settings tabs. See the status line, what Needs attention means and how to reconnect.
- The endpoint editorEdit an endpoint: its method and path, request fields, response fields, types, required, how many workflows use a field, pasting sample JSON, and what happens when you rename or remove a field.
- Integration settingsThe Settings tab of an integration: general, connection, authentication, advanced limits and headers, re-importing a spec and comparing changes, and deleting an integration.
- API changesLadeworks checks each API every week for changes. See the three severities, how to mark a change Reviewed or Dismissed, which workflows are affected and the note on the Workflows page.
Your first workflow
- Create a workflowAnswer five questions on the New workflow page and Ladeworks sets up the steps, with an estimate of the API calls a run will use.
- The builderTour the workflow builder: the header, the Active switch, Run now and Save, the summary and usage lines, and the Steps, Runs and Settings tabs.
- Add, move and change stepsHow the Steps tab works: step cards, the plus buttons and the Add a step panel, settings drawers, drag to reorder, the step counter and suggestions.
- Test and runCheck the mapping, test a workflow on its first 10 rows, turn it on and run it, and see the warning Ladeworks shows when a run may not fit your API calls.
- Reading a runRead run details: the counts, what each step did, skipped rows and their causes, requests and responses, Retry and Fix, rows that were already sent, and the Output card for files.
Shaping data
- Steps and API callsEvery step type in Ladeworks, what it does and what it costs in API calls, and which steps never use any.
- Pull from an endpointThe Pull step fetches records from an API page by page. Learn its settings, how paging ends, only records changed since the last run, and what it costs.
- Push to an endpointThe Push step sends each row to an API. Learn batching and its call savings, not sending records twice, update if exists, and what it costs.
- Read a CSVThe Read a CSV step reads rows from a file server folder or an uploaded file. Learn the settings, how columns are known while you build, and what happens with odd files.
- Write a CSVThe Write a CSV step saves rows to a file server folder or as a CSV to download. Learn the settings, file names, formula protection and what it costs.
- Filter rowsThe Filter rows step keeps the rows that match. Learn condition blocks, the field picker, Show values, comparing dates and when to use an expression.
- Map fieldsThe Map fields step renames fields, changes their values, translates codes and leaves fields out. Learn the field picker, transforms, expressions and unmapped fields.
- Remove duplicatesThe Remove duplicates step keeps one row for each key. Learn how to choose the key, combine fields, and what the run says.
- Split a list into rowsThe Split step turns each item of a list field into its own row. Learn records versus plain values, prefixes, empty lists and what the columns become.
- Get details for each rowThe Get details for each row step calls another endpoint once for each row and adds what it returns. Learn the settings, prefixes, clashes and cost.
- SuggestionsHow the builder suggests the step you probably want next, by rules over the shape of your data, and how to add or dismiss a suggestion.
Advanced workflows
- TriggersStart a workflow on a schedule, when a file lands in a folder, or when your own system calls a webhook. Limits, what counts as a new file, and what costs API calls.
- Outgoing webhooksHave Ladeworks send a signed POST to your own address when a run finishes, fails or ends early. What the call holds, how to check its signature and what happens when it fails.
- Conditions and flowLimit a step to some rows, stop a run early or as failed, pause between steps and hand rows to another workflow.
- Files from linksSome APIs answer with a link to a file instead of records. Read a file from a link downloads the file and reads its rows. File types, limits and how credentials are kept off the link.
- Reports that take timeFor APIs that build an export in the background. Ladeworks asks for the report, checks until it is ready, and carries on, without holding anything up while it waits.
- Send a messageTell people when a workflow has done something, by email, Slack or Discord, once for the whole run or for each row, optionally only for some rows.
- Example: API to an SFTP CSVA worked example. Pull orders from an API, split each order into its line items, tidy the columns and write a CSV to an SFTP folder on a schedule.
- Example: a file lands, then an APIA worked example. When a partner drops a CSV in a folder, read it, check it has rows, map it, push each row to an API in batches and send an email.
- Example: a list, then detailsA worked example. Pull a list of orders, get each order's full record from a second endpoint, and write the result as a CSV to download.
- Example: an async report exportA worked example. Ask an API for a sales report, wait until it is ready, read the file it links to, keep the busy days and save a CSV.
Monitoring and alerts
- Workflow statusesWhat Active, Paused and every Paused: reason status means in Ladeworks, what to do about each one, and which ones come back by themselves.
- Needs attentionFind workflows that need you: the Needs attention card and filter, the coral issue lines with fix links, and API change notes on the Workflows page.
- Your notificationsChoose which events you hear about, by email and Slack DM, which workflows you follow, and whether alerts come right away or in one daily summary.
- Team alerts and SlackSend failures and other alerts to a shared Slack or Discord channel, connect Slack under Connected apps, and test the channel.
- What alerts sayWhat a Ladeworks alert contains, how the same alert looks by email, in Slack and in Discord, and what the footer tells you.
Usage and billing
- What counts as an API callEvery request Ladeworks makes to one of your integrations is an API call. See what counts, what is free, and how to cut calls with batching.
- Cutting callsUse fewer API calls: send rows in batches and skip records you already sent. See where Ladeworks shows the saving.
- Usage and the spending capRead the API calls card on the Workflows page, choose a spending cap, and learn what happens when you reach it and how to raise it.
- The run checkRun now warns you before a run that may stop partway or go past your included calls. See what the dialog says and what each button does.
- Plan and billingRead your usage bars, change add-ons with prorated charges, update the card and billing email, and download invoices.
- Changing plansUpgrades are charged right away and apply at once. A downgrade is blocked until your usage fits the lower plan.
- CancelingCancel in the app: the plan stays active to the end of the paid period, workflows are paused not deleted, and old run history is cleaned up.
Team and security
- Roles and payload accessWhat an Owner, Admin, Editor and Viewer can do in a Ladeworks workspace, what the view-only builder looks like, and what payload access covers.
- Invite peopleInvite teammates to Ladeworks by email with a role. The link works for 7 days. Learn what the person sees when they accept, and why your email must be confirmed first.
- Change roles, remove people, transfer ownershipChange someone's role or payload access, remove them from a Ladeworks workspace, or make someone else the Owner.
- Your profileChange your name, email, time zone, theme and password in Ladeworks Profile. A new email only takes effect when you click the link we send to it.
- Two-factor sign-inTurn on two-factor sign-in for your Ladeworks account, save your recovery codes, and see how it works with passwords and with Google sign-in.
- Require two-factor for the workspaceThe Owner can require two-factor sign-in for everyone in a Ladeworks workspace. See what members experience, the Two-factor column, and how the Owner resets a member and what limits that.
- How Ladeworks keeps credentials safeHow API keys, tokens, passwords and SSH keys are stored in Ladeworks, why you only ever see a masked hint, and what Ladeworks does not claim.
- Leave or delete a workspace, delete your accountHow to leave a Ladeworks workspace, how the Owner deletes one, and what happens to your account and workspaces when you delete it.
Help
- The Help menuOpen the Help docs, send a message to Ladeworks support with Contact support, or send feedback. See what is sent with a message and what is never sent.
- Get help with thisAsk support about a failed run or an integration that needs attention with one click, and see what Ladeworks attaches to the message.
- Missing something?Report an API, a workflow step, a feature or something confusing from the Missing something panel. It is on every plan and you get an email when it is added.
Need a hand? Contact us.