@fern-api/webflow v0.1.0

Webflow Node Library

The Webflow Node.js library provides access to the Webflow API from JavaScript/TypeScript.

Documentation

API reference documentation is available at https://developers.webflow.com/.

Usage

import { WebflowClient } from "@fern-api/webflow";

const webflow = new WebflowClient({
    token: "USER_TOKEN",
});

const sites = await webflow.sites.publish("580e63e98c9a982ac9b8b741", {
    customDomains: ["test-api-domain.com", "www.test-api-domain.com"],
    publishToWebflowSubdomain: false,
});

console.log("Published sites!", sites);

OAuth

The SDK exports utility functions that you can use to setup OAuth.

import { WebflowClient, getAccessTokenSupplier } from "@fern-api/webflow";

const webflow = new WebflowClient({
    token: getAccessTokenSupplier({
        clientId: "CLIENT_ID",
        clientSecret: "CLIENT_SECRET",
        code: "code", // the authorization code for your user
    }),
});

Errors

When the API returns a non-success status code (4xx or 5xx response), a subclass of WebflowError will be thrown:

import { WebflowError, WebflowTimeoutError } from "@fern-api/webflow";

try {
    await webflow.sites.publish(/* ... */);
} catch (err) {
    if (err instanceof WebflowTimeoutError) {
    } else if (err instanceof WebflowError) {
        // catch all errros
        console.log(err.statusCode);
        console.log(err.message);
        console.log(err.body);
    }
}

Error codes are as followed:

Retries

409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried twice with exponential bakcoff. You can use the maxRetries option to configure this behavior:

const sites = await webflow.webhooks.list("site-id", {
    maxRetries: 0, // disable retries
});

Timeouts

By default, the SDK has a timeout of 60s. You can use the timeoutInSeconds option to configure this behavior

const sites = await webflow.webhooks.list("site-id", {
    timeoutInSeconds: 10, // timeout after 10 seconds
});

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest 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!