Skip to main content
For usage details, see the API Reference and CLI Reference.

TypeScript SDK (@zapier/zapier-sdk)

0.40.1

Several top-level method options were renamed so flexible resource references use suffix-less names (app instead of appKey, connection instead of connectionId, and so on). The values you pass are the same as before—slugs, implementation keys, versioned IDs, connection aliases, numeric IDs, and other supported forms. The goal is one obvious parameter per resource and less ambiguity between *Key and *Id now that parameters like connection already accept multiple identifier styles. Note: This is not a breaking change. The old parameter names still work; they are deprecated.
Old nameNew name
appKeyapp
appKeysapps
actionKeyaction
inputFieldKeyinputField
connectionIdconnection
connectionIdsconnections
tableIdtable
tableIdstables
recordIdrecord
recordIdsrecords
fieldKeysfields
accountIdaccount

CLI (@zapier/zapier-sdk-cli)

0.60.0

Added zapier-sdk login --headless for existing Zapier accounts on SSH, remote dev boxes, and browserless agent environments. It matches headless signup: the CLI prints a login URL, you open it where a browser is available, then paste the final loopback callback URL back into the terminal. When paired with --non-interactive, the login URL is printed to stdout while progress stays on stderr, so agents and scripts can capture the URL without mixing it with status copy. Note: This is not a breaking change. Browser-based zapier-sdk login and zapier-sdk signup --headless continue to work as before.

0.53.0

Added zapier-sdk signup for browser-based Zapier account setup and SDK credential provisioning. Use it when a user is new to Zapier; use zapier-sdk login when they already have an account. Both commands leave createZapierSdk() ready to authenticate through the CLI without passing credentials manually. signup supports the same approval setup as login with --use-approvals, plus --headless for remote machines that cannot open a browser. Note: This is not a breaking change. zapier-sdk login continues to work for existing accounts.

0.39.1

CLI flags and options were renamed to match TypeScript SDK 0.40.1—the same suffix-less resource naming, accepted values, and deprecation approach as in that release. Note: This is not a breaking change. The old flag names still work; they are deprecated.
Old flag / optionNew flag / option
--app-key--app
--app-keys--apps
--action-key--action
--input-field-key--input-field
--connection-id--connection
--connection-ids--connections
--table-id--table
--table-ids--tables
--record-id--record
--record-ids--records
--field-keys--fields
--account-id--account