Snippets

Inject custom code snippets into your deployed pages

The Snippets API allows you to inject custom HTML, JavaScript, or CSS into your deployed pages. This is useful for analytics, tracking pixels, custom scripts, and more.

List Snippets

GET /v1/snippets · endpoint

Retrieve all snippets for an environment.

Query Parameters

afterId · string

Pagination cursor for retrieving the next page

hosts · string

Filter by comma-separated hostnames

title · string

Filter by snippet title (URL-encoded)

Response

snippets · array

Array of snippet objects

Show Snippet Object

id · string

Unique snippet identifier

title · string

Snippet title for internal reference

content · string

HTML/JavaScript/CSS content to inject

enabled · boolean

Whether the snippet is active

location · string

Injection location: “head” or “body”

prepend · boolean

If true, inject as first child; otherwise as last child

rules · object

Conditional injection rules

Show Rules Object

hosts · array

Hostnames to inject on (supports wildcards like “*.dev”)

path · string

Path pattern to match for injection

pagination · object

Show Pagination

hasNextPage · boolean

Whether more results are available

afterId · string

Cursor for next page

Request

curl -X GET \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/snippets'

---

Create Snippet

POST /v1/snippets · endpoint

Add one or more snippets to an environment.

Request Body

snippets · array · required

Array of snippet objects to create

Show Snippet Object

title · string · required

Descriptive title for internal use

content · string · required

HTML/JavaScript/CSS content to inject

enabled · boolean · required

Whether the snippet should be active

location · string · required

Injection point: “head” or “body”

prepend · boolean · required

If true, inject as first child; otherwise as last child

rules · object

Conditional injection rules

Show Rules Object

hosts · array

Hostnames to inject on

path · string

Path pattern to match

Response

snippets · array

Array of created snippet objects with IDs

Status Codes

• 201: Snippet created successfully
• 400: Invalid snippet parameters
• 409: Duplicate snippet content in environment

Request

curl -X POST \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/snippets' \
  -d '{
    "snippets": [
      {
        "title": "Google Analytics",
        "content": "<script>console.log('Analytics loaded')</script>",
        "enabled": true,
        "prepend": false,
        "location": "head",
        "rules": {
          "hosts": ["example.org", "*.dev"],
          "path": "/"
        }
      }
    ]
  }'

---

Update Snippet

PUT /v1/snippets · endpoint

Update an existing snippet.

Request Body

snippet · object · required

Snippet object with updated values

Show Snippet Object

id · string · required

ID of the snippet to update

title · string · required

Updated title

content · string · required

Updated content

enabled · boolean · required

Whether the snippet is active

location · string · required

Injection location

prepend · boolean · required

Prepend or append

rules · object

Updated rules

Response

ok · boolean

Whether the update was successful

Status Codes

• 200: Snippet updated successfully
• 400: Invalid snippet parameters
• 409: Duplicate snippet content in environment

Request

curl -X PUT \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/snippets' \
  -d '{
    "snippet": {
      "id": "1501",
      "title": "Updated Analytics",
      "content": "<script>console.log('Updated')</script>",
      "enabled": true,
      "prepend": false,
      "location": "head",
      "rules": {
        "hosts": ["example.org"],
        "path": "/"
      }
    }
  }'

---

Delete Snippets

DELETE /v1/snippets · endpoint

Delete one or more snippets by ID.

You can delete a maximum of 100 snippets at a time.

Query Parameters

ids · string · required

Comma-separated snippet IDs to delete

Response

ok · boolean

Whether the deletion was successful

Request

curl -X DELETE \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/snippets?ids=1501,5061'

---

Snippet Configuration

Injection Locations

• head: Inject into the <head> element
• body: Inject into the <body> element

Prepend vs Append

• prepend: true: Inject as the first child of the location element
• prepend: false: Inject as the last child of the location element

Rules

Snippets can be conditionally injected based on:

• hosts: Specific domain names or wildcard patterns
• path: URL path pattern matching

Development Endpoints

To inject snippets on all development/preview deployments, use the wildcard pattern:

{
  "rules": {
    "hosts": ["*.dev"]
  }
}

Specifying an individual deployment endpoint will enable the snippet for all development endpoints.

---

Common Use Cases

Google Analytics

{
  "title": "Google Analytics",
  "content": "<script async src='https://www.googletagmanager.com/gtag/js?id=GA_MEASUREMENT_ID'></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'GA_MEASUREMENT_ID');</script>",
  "enabled": true,
  "location": "head",
  "prepend": false,
  "rules": {
    "hosts": ["example.org"]
  }
}

Custom CSS

{
  "title": "Custom Styles",
  "content": "<style>.custom-banner { background: #8B5CF6; color: white; }</style>",
  "enabled": true,
  "location": "head",
  "prepend": true
}

Tracking Pixel

{
  "title": "Facebook Pixel",
  "content": "<script>!function(f,b,e,v,n,t,s){...}(window,document,'script','https://connect.facebook.net/en_US/fbevents.js');</script>",
  "enabled": true,
  "location": "head",
  "prepend": false,
  "rules": {
    "path": "/landing"
  }
}

Chat Widget

{
  "title": "Support Chat",
  "content": "<script src='https://chat.example.com/widget.js'></script>",
  "enabled": true,
  "location": "body",
  "prepend": false
}