Register Script - Hosted | Webflow Developer Documentation

import { WebflowClient } from "webflow-api";
async function main() {
    const client = new WebflowClient({
        accessToken: "YOUR_TOKEN_HERE",
    });
    await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
        hostedLocation: "https://cdn.jsdelivr.net/.../cmsslider.js",
        integrityHash: "sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+",
        version: "1.0.0",
        displayName: "CMS Slider",
        canCopy: true,
    });
}
main();

{
  "id": "cms_slider",
  "canCopy": true,
  "displayName": "CMS Slider",
  "hostedLocation": "https://cdn.jsdelivr.net/.../cmsslider.js",
  "integrityHash": "sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+",
  "createdOn": "2022-10-26T00:28:54.191Z",
  "version": "1.0.0"
}

Script Registration

To apply a script to a site or page, the script must first be registered to a site via the Register Script endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on working with Custom Code for more information.

Required scope | custom_code:write

Register a hosted script to a site. <Note title="Script Registration"> To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> Required scope | `custom_code:write`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Request

This endpoint expects an object.

hostedLocationstringRequired

URI for an externally hosted script location

integrityHashstringRequiredformat: "hash"

Sub-Resource Integrity Hash

versionstringRequired

A Semantic Version (SemVer) string, denoting the version of the script

displayNamestringRequired

User-facing name for the script. Must be between 1 and 50 alphanumeric characters

canCopybooleanOptionalDefaults to false

Define whether the script can be copied on site duplication and transfer

Response

Request was successful

idstring or nullRead-only

Human readable id, derived from the user-specified display name

canCopyboolean or nullDefaults to false

Define whether the script can be copied on site duplication and transfer

displayNamestring or null

User-facing name for the script. Must be between 1 and 50 alphanumeric characters

hostedLocationstring or null

URI for an externally hosted script location

integrityHashstring or nullformat: "hash"

Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation)

createdOnstring or nullRead-onlyformat: "date-string"

Timestamp when the script version was created

lastUpdatedstring or nullRead-onlyformat: "date-string"

Timestamp when the script version was last updated

versionstring or null

A Semantic Version (SemVer) string, denoting the version of the script

Script Registration

Authentication

Path parameters

Request

Response

Errors

Script Registration