https://github.com/webflow/js-webflow-api
Node.js SDK for the Webflow Data API
https://github.com/webflow/js-webflow-api
api business-critical-yes cms ecommerce membership oauth2 sdk webflow
Last synced: about 2 months ago
JSON representation
Node.js SDK for the Webflow Data API
- Host: GitHub
- URL: https://github.com/webflow/js-webflow-api
- Owner: webflow
- Created: 2016-11-15T17:05:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T20:47:57.000Z (about 2 months ago)
- Last Synced: 2025-03-26T21:35:09.327Z (about 2 months ago)
- Topics: api, business-critical-yes, cms, ecommerce, membership, oauth2, sdk, webflow
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/webflow-api
- Size: 2.16 MB
- Stars: 307
- Watchers: 91
- Forks: 100
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Webflow JS SDK
[](https://www.npmjs.com/package/webflow-api)
[](https://github.com/fern-api/fern)
The Webflow JavaScript SDK provides convenient access to the [Webflow Data API](https://developers.webflow.com/reference/rest-introduction) from
applications written in JS.
The SDK contains typings and request builders for the Webflow Data API.
## Documentation
Explore the [API reference documentation](https://developers.webflow.com/reference/rest-introduction).
## Installation
Add this dependency to your project's package.json file:
Using npm:
```shell
$ npm install webflow-api
```
Using yarn
```shell
$ yarn add webflow-api
```
## Usage
Simply import `Webflow` and start making calls to our API.
```javascript
import { WebflowClient } from "webflow-api";
const webflow = new WebflowClient({ accessToken });
// Env. variables
// in format of string, e.g.: "639656400769508adc12fe42"
const site_id = process.env.SITE_ID;
const custom_domain_id_1 = process.env.CUSTOM_DOMAIN_ID_1;
const custom_domain_id_2 = process.env.CUSTOM_DOMAIN_ID_2;
// Sites
// List Sites
const sites = await webflow.sites.list();
// Get Site
const site = await webflow.sites.get("site_id");
// Get Custom Domains
const customDomains = await webflow.sites.getCustomDomain(site_id);
// Publish Site
const site = await webflow.sites.publish(site_id, {
customDomains: [custom_domain_id_1, custom_domain_id_2],
publishToWebflowSubdomain: true,
});
```
## OAuth
To implement OAuth, you'll need to [register a Webflow App in your Workspace](https://developers.webflow.com/reference/authorization)
### Step 1: Authorize URL
The first step in OAuth is to generate an Authorization URL. Use this URL
to fetch your Authorization Code. See the [docs](https://docs.developers.webflow.com/v1.0.0/docs/oauth#user-authorization)
for more details.
```javascript
import { WebflowClient } from "webflow-api";
const authorizeUrl = WebflowClient.authorizeURL({
state: "your_state",
scope: "sites:read",
clientId: "your_client_id",
redirectUri: "your_redirect_uri",
});
console.log(authorizeUrl);
```
### Step 2: Retrieve your access token
Use the `getAccessToken` function and pass in your `client_id`,
`client_secret`, and `authorization_code`.
```javascript
import { WebflowClient } from "webflow-api";
const accessToken = WebflowClient.getAccessToken({
clientId: "your_client_id",
clientSecret: "your_client_secret",
code: "your_authorization_code"
});
```
### Step 3: Instantiate the client
Instantiate the client using your `access_token`.
```javascript
import { WebflowClient } from "webflow-api";
const webflow = WebflowClient({ accessToken });
```
## Webflow Types
All of the types are nested within the `Webflow` namespace. Let IntelliSense
guide you!
## Exception Handling
All errors thrown by the SDK will be subclasses of [`WebflowError`](./src/errors/WebflowError.ts).
```javascript
import { WebflowClient, Webflow } from 'webflow';
const webflow = new WebflowClient({ accessToken: 'your_access_token' });
try {
const sites = await webflow.sites.get(...);
} catch (e) {
if (e instanceof Webflow.ForbiddenError) {
console.log(e.body.message);
} else if (e instanceof Webflow.BadRequestError) {
console.log(e.body.message);
} else {
throw e;
}
}
```
## Advanced
### Timeouts
By default, requests time out after 60 seconds. You can configure the timeout and # of max retries
```javascript
import { WebflowClient } from 'webflow';
const sites = await webflow.sites.get(..., {
timeoutInSeconds: 30 // override the timeout
});
```
### Retries
The SDK will automatically retry failures with exponential backoff.
You can configure the retries by setting maxRetries.
```javascript
import { WebflowClient } from 'webflow';
const sites = await webflow.sites.get(..., {
maxRetries: 10 // override the retries
});
```
## Beta Status
This SDK is in **Preview**, and there may be breaking changes between versions without a major
version update.
To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.
## Contributing
While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!