> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/netlify.md).

# Netlify

Manage Netlify sites, deploys, environment variables, DNS records, TLS certificates, form submissions, and team members, and react to deploy and form-submission events.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector                       | Authentication        |
| ------------------------------- | --------------------- |
| Netlify                         | OAuth sign-in         |
| Netlify (Personal Access Token) | Personal Access Token |

#### Netlify

Connect to Netlify to manage sites, deploys, environment variables, DNS records, TLS certificates, form submissions, and team members.

**Set up in Netlify**

1. Use a Netlify account with access to the records and operations that your workflow needs.
2. If your organization restricts application access or user consent, have its administrator approve the connection before you sign in.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Netlify**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

#### Netlify (Personal Access Token)

Connect to Netlify using a personal access token instead of the OAuth flow. Use this when you provision a token directly in Netlify user settings.

**Set up in Netlify**

1. Prepare the Netlify account or service that the workflow will access. Grant access to the required resources and operations.
2. **Personal Access Token:** Create one under Netlify > User settings > Applications > Personal access tokens. Sent as a Bearer token; acts with your personal account permissions.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Netlify (Personal Access Token)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field         | Required | What to enter                                                                                                                                                                                                                                     |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Personal Access Token | Yes      | Create one under Netlify > User settings > Applications > Personal access tokens. Sent as a Bearer token; acts with your personal account permissions. [Provider instructions](https://app.netlify.com/user/applications#personal-access-tokens). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Netlify** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Sites

List all Netlify sites you have access to, including their live URLs and current deploy status.

**Inputs**

| Field       | Type            | Required | Description                                                                                                                                                                                      |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Filter      | select (string) | No       | Show all accessible sites, only sites you own, or only sites you are a guest collaborator on. Available values: All accessible sites, Only sites I own, Only guest collaborations. Default: all. |
| Name Search | string          | No       | Filter results to sites whose name contains this string.                                                                                                                                         |
| Page        | integer         | No       | Page number to fetch, starting at 1. Up to 100 items per page.                                                                                                                                   |

**Outputs**

| Field     | Type          | Description                                                                                        |
| --------- | ------------- | -------------------------------------------------------------------------------------------------- |
| Sites     | object\_array | Sites with id, name, url, ssl\_url, custom\_domain, account\_slug, and the published deploy state. |
| Next Page | integer       | Page number for the next batch of results. Absent on the last page.                                |

#### Create Site

Create an empty Netlify site, optionally in a team or on a custom domain.

**Inputs**

| Field         | Type            | Required | Description                                                                                                       |
| ------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| Site Name     | string          | Yes      | Unique Netlify project name.                                                                                      |
| Team Slug     | select (string) | No       | Team that will own the site. Uses the token's default team if omitted. Options load from the selected connection. |
| Custom Domain | string          | No       | Optional custom domain to assign to the new site.                                                                 |
| Configure DNS | boolean         | No       | Ask Netlify to configure managed DNS for the custom domain. Default: false.                                       |

**Outputs**

| Field     | Type   | Description                         |
| --------- | ------ | ----------------------------------- |
| Site ID   | string | ID of the newly created site.       |
| Name      | string | Name assigned by Netlify.           |
| URL       | string | Public site URL.                    |
| Admin URL | string | Netlify dashboard URL for the site. |

#### Get Site

Get configuration and live URL for a Netlify site.

**Inputs**

| Field | Type            | Required | Description                                                  |
| ----- | --------------- | -------- | ------------------------------------------------------------ |
| Site  | select (string) | Yes      | Site to retrieve. Options load from the selected connection. |

**Outputs**

| Field                  | Type   | Description                    |
| ---------------------- | ------ | ------------------------------ |
| Site ID                | string | Site ID.                       |
| Name                   | string | Site name.                     |
| State                  | string | Site state.                    |
| URL                    | string | Public URL.                    |
| Custom Domain          | string | Configured custom domain.      |
| Team Slug              | string | Owning team slug.              |
| Published Deploy State | string | State of the published deploy. |

#### Create Deploy

Publish generated UTF-8 static files as an atomic Netlify deploy.

**Inputs**

| Field        | Type            | Required | Description                                                           |
| ------------ | --------------- | -------- | --------------------------------------------------------------------- |
| Site         | select (string) | Yes      | Site to publish to. Options load from the selected connection.        |
| Files        | object          | Yes      | Map of deploy paths to UTF-8 text contents.                           |
| Draft Deploy | boolean         | No       | Create a preview without changing the published site. Default: false. |
| Branch       | string          | No       | Optional branch label for the deploy.                                 |
| Title        | string          | No       | Optional deploy title.                                                |

**Outputs**

| Field          | Type    | Description                          |
| -------------- | ------- | ------------------------------------ |
| Deploy ID      | string  | Created deploy ID.                   |
| State          | string  | Initial deploy state.                |
| Deploy URL     | string  | Deploy-specific URL, when available. |
| Uploaded Files | integer | Number of content blobs uploaded.    |

#### Trigger Deploy

Rebuild a Netlify site from its connected repository, the same as clicking 'Trigger deploy' in the dashboard. Optionally target a branch, label the build, or clear the build cache first. This queues a real repository rebuild, so it cannot produce a draft/preview deploy - draft deploys require uploading pre-built site files, which this action does not do.

**Inputs**

| Field        | Type            | Required | Description                                                                                                                            |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Site         | select (string) | Yes      | The site to deploy. Options load from the selected connection.                                                                         |
| Branch       | string          | No       | Git branch to rebuild. Defaults to the site's production branch when omitted.                                                          |
| Deploy Title | string          | No       | Short label for this build, shown in the Netlify dashboard.                                                                            |
| Clear Cache  | boolean         | No       | Wipe the build cache before rebuilding - use after dependency or build-config changes a cached build wouldn't pick up. Default: false. |

**Outputs**

| Field         | Type   | Description                                                                                                                                         |
| ------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Deploy ID     | string | Unique ID of the newly created deploy.                                                                                                              |
| Initial State | string | Deploy state immediately after triggering: 'building' while the build runs, 'ready' if it finished synchronously, or 'error' if it failed to start. |
| Deploy URL    | string | Preview URL scoped to this deploy, once assigned.                                                                                                   |

#### List Deploys

List all deploys for a site, newest first. Use this to find a deploy ID before rolling back.

**Inputs**

| Field | Type            | Required | Description                                                                                  |
| ----- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Site  | select (string) | Yes      | The site whose deploy history you want to browse. Options load from the selected connection. |
| Page  | integer         | No       | Page number to fetch, starting at 1. Up to 20 items per page.                                |

**Outputs**

| Field     | Type          | Description                                                                         |
| --------- | ------------- | ----------------------------------------------------------------------------------- |
| Deploys   | object\_array | Deploys with id, state, branch, commit\_ref, title, created\_at, and published\_at. |
| Next Page | integer       | Page number for the next batch. Absent when on the last page.                       |

#### Get Deploy Status

Check the current status and details of a specific deploy, including any error message if it failed.

**Inputs**

| Field  | Type            | Required | Description                                                               |
| ------ | --------------- | -------- | ------------------------------------------------------------------------- |
| Site   | select (string) | Yes      | The site that owns the deploy. Options load from the selected connection. |
| Deploy | select (string) | Yes      | The deploy to inspect. Options load from the selected connection.         |

**Outputs**

| Field         | Type     | Description                                                        |
| ------------- | -------- | ------------------------------------------------------------------ |
| State         | string   | Current deploy state: new, building, uploading, ready, error, etc. |
| Error Message | string   | Error details when the deploy failed.                              |
| Deploy URL    | string   | Preview URL scoped to this deploy.                                 |
| Published At  | datetime | Timestamp when this deploy was published live.                     |
| Branch        | string   | Git branch associated with this deploy.                            |
| Commit SHA    | string   | Git commit this deploy was built from.                             |

#### Rollback to Deploy

Restore a site to a specific previous deploy, making it the new live version immediately.

**Inputs**

| Field             | Type            | Required | Description                                                                                          |
| ----------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| Site              | select (string) | Yes      | The site to roll back. Options load from the selected connection.                                    |
| Deploy to Restore | select (string) | Yes      | The historical deploy to promote as the new live version. Options load from the selected connection. |

**Outputs**

| Field              | Type   | Description                                       |
| ------------------ | ------ | ------------------------------------------------- |
| Restored Deploy ID | string | ID of the deploy now serving as the live version. |
| State              | string | State of the restored deploy (typically 'ready'). |
| Live URL           | string | HTTPS URL now serving the restored deploy.        |

#### Get Environment Variables

List environment variables for a Netlify team, optionally filtered to a specific site or deploy context.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                  |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Account         | select (string) | Yes      | The Netlify team whose environment variables to read. Options load from the selected connection.                                             |
| Site (optional) | select (string) | No       | Restrict results to variables set on this specific site. Options load from the selected connection.                                          |
| Deploy Context  | select (string) | No       | Return only variables active in this deploy context. Available values: All contexts, Production, Branch deploys, Deploy previews, Local dev. |

**Outputs**

| Field                 | Type          | Description                                                      |
| --------------------- | ------------- | ---------------------------------------------------------------- |
| Environment Variables | object\_array | Env vars with key, values (per context), scopes, and is\_secret. |

#### Set Environment Variable

Create or update an environment variable on a Netlify team or site. Applies to the chosen deploy context.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                                            |
| --------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Account         | select (string) | Yes      | The Netlify team to set the variable on. Options load from the selected connection.                                                                                    |
| Site (optional) | select (string) | No       | Set the variable on this site only instead of team-wide. Options load from the selected connection.                                                                    |
| Variable Name   | string          | Yes      | The environment variable name, case-sensitive.                                                                                                                         |
| Value           | secret          | Yes      | The value to assign. Enable 'Secret' below to hide it from the Netlify UI after saving.                                                                                |
| Deploy Context  | select (string) | No       | Which deploy environment this value applies to. Available values: All contexts, Production, Branch deploys, Deploy previews, Local dev, Specific branch. Default: all. |
| Branch Name     | string          | No       | Required when Deploy Context is 'Specific branch': the exact branch name.                                                                                              |
| Secret          | boolean         | No       | Mark as secret - value will be hidden in the Netlify UI and API responses after saving. For an existing variable this must match its current setting. Default: false.  |

**Outputs**

| Field      | Type     | Description                                    |
| ---------- | -------- | ---------------------------------------------- |
| Key        | string   | The variable name that was created or updated. |
| Is Secret  | boolean  | Whether the variable is marked as a secret.    |
| Updated At | datetime | Timestamp of the last update.                  |

#### Create DNS Record

Add a DNS record (A, CNAME, MX, TXT, etc.) to a Netlify-managed DNS zone.

**Inputs**

| Field         | Type            | Required | Description                                                                                                                                          |
| ------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| DNS Zone      | select (string) | Yes      | The DNS zone to add the record to. Options load from the selected connection.                                                                        |
| Record Type   | select (string) | Yes      | The DNS record type. Available values: A, AAAA, CNAME, MX, TXT, NS, SRV, CAA.                                                                        |
| Hostname      | string          | Yes      | The subdomain or name for this record (e.g. 'www', 'api', or '@' for the apex). Automatically expanded to a full hostname against the zone's domain. |
| Value         | string          | Yes      | The record value - IP address for A records, target hostname for CNAME, mail server for MX, text string for TXT, etc.                                |
| TTL (seconds) | integer         | No       | Time-to-live in seconds. Defaults to 3600 (1 hour). Default: 3600.                                                                                   |
| Priority      | integer         | No       | Record priority for MX and SRV records. Lower value = higher preference.                                                                             |

**Outputs**

| Field     | Type   | Description                          |
| --------- | ------ | ------------------------------------ |
| Record ID | string | Unique ID of the created DNS record. |
| Hostname  | string | The full hostname of the new record. |
| Type      | string | DNS record type.                     |
| Value     | string | The value the record resolves to.    |

#### Provision SSL Certificate

Provision a free Let's Encrypt TLS certificate for a site's custom domain. The site must have a custom domain configured with DNS pointing to Netlify.

**Inputs**

| Field | Type            | Required | Description                                                                                                                    |
| ----- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Site  | select (string) | Yes      | The site to provision a certificate for. Must have a custom domain and correct DNS. Options load from the selected connection. |

**Outputs**

| Field             | Type          | Description                                               |
| ----------------- | ------------- | --------------------------------------------------------- |
| Certificate State | string        | Certificate provisioning state (e.g. 'pending', 'ready'). |
| Covered Domains   | string\_array | Domains included in this certificate.                     |
| Expires At        | datetime      | Certificate expiry date.                                  |

#### List Form Submissions

Retrieve submissions collected by a Netlify form on your site.

**Inputs**

| Field | Type            | Required | Description                                                                                 |
| ----- | --------------- | -------- | ------------------------------------------------------------------------------------------- |
| Site  | select (string) | Yes      | The site that owns the form. Options load from the selected connection.                     |
| Form  | select (string) | Yes      | The form whose submissions you want to retrieve. Options load from the selected connection. |
| Page  | integer         | No       | Page number to fetch, starting at 1. Up to 20 items per page.                               |

**Outputs**

| Field       | Type          | Description                                                    |
| ----------- | ------------- | -------------------------------------------------------------- |
| Submissions | object\_array | Submissions with id, email, name, body, data, and created\_at. |
| Next Page   | integer       | Page number for the next batch. Absent when on the last page.  |

#### Invite Team Member

Invite a collaborator to your Netlify team by email and assign them a role.

**Inputs**

| Field         | Type            | Required | Description                                                                                                                                                                                     |
| ------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Team          | select (string) | Yes      | The Netlify team to invite the person to. Options load from the selected connection.                                                                                                            |
| Email Address | string          | Yes      | Email address of the person to invite.                                                                                                                                                          |
| Role          | select (string) | Yes      | Access level to grant: Owner has full control, Developer can deploy, Billing Admin manages billing, Reviewer can view and comment. Available values: Owner, Developer, Billing Admin, Reviewer. |

**Outputs**

| Field        | Type          | Description                                                      |
| ------------ | ------------- | ---------------------------------------------------------------- |
| Team Members | object\_array | Updated list of team members including the newly invited person. |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### Deploy Succeeded

Fires when a site deploy completes successfully and goes live.

This trigger registers a Netlify webhook automatically when you start listening. **Requirements:** 1. Connect with a token that can manage webhooks on the site (an account owner or a site collaborator with deploy access). 2. Select the **Site** to watch below.

**Configuration**

| Field | Type            | Required | Description                                                                          |
| ----- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Site  | select (string) | Yes      | The site to watch for successful deploys. Options load from the selected connection. |

**Event inputs**

| Field        | Type   | Required | Description                              |
| ------------ | ------ | -------- | ---------------------------------------- |
| Deploy ID    | string | Yes      | ID of the deploy that succeeded.         |
| Site ID      | string | Yes      | ID of the site that was deployed.        |
| Live URL     | string | No       | The live URL now serving the new deploy. |
| Branch       | string | No       | Git branch that was deployed.            |
| Commit SHA   | string | No       | Git commit SHA for this deploy.          |
| Deploy Title | string | No       | Human-readable label for the deploy.     |

**Outputs**

| Field        | Type   | Description                              |
| ------------ | ------ | ---------------------------------------- |
| Deploy ID    | string | ID of the deploy that succeeded.         |
| Site ID      | string | ID of the site that was deployed.        |
| Live URL     | string | The live URL now serving the new deploy. |
| Branch       | string | Git branch that was deployed.            |
| Commit SHA   | string | Git commit SHA for this deploy.          |
| Deploy Title | string | Human-readable label for the deploy.     |

#### Deploy Failed

Fires when a site deploy fails, enabling automated alerting or rollback workflows.

This trigger registers a Netlify webhook automatically when you start listening. **Requirements:** 1. Connect with a token that can manage webhooks on the site (an account owner or a site collaborator with deploy access). 2. Select the **Site** to watch below.

**Configuration**

| Field | Type            | Required | Description                                                                      |
| ----- | --------------- | -------- | -------------------------------------------------------------------------------- |
| Site  | select (string) | Yes      | The site to watch for failed deploys. Options load from the selected connection. |

**Event inputs**

| Field         | Type   | Required | Description                                    |
| ------------- | ------ | -------- | ---------------------------------------------- |
| Deploy ID     | string | Yes      | ID of the deploy that failed.                  |
| Site ID       | string | Yes      | ID of the site.                                |
| Error Message | string | No       | Description of what caused the deploy to fail. |
| Branch        | string | No       | Git branch that was being deployed.            |
| Commit SHA    | string | No       | Git commit SHA for the failed build.           |

**Outputs**

| Field         | Type   | Description                                    |
| ------------- | ------ | ---------------------------------------------- |
| Deploy ID     | string | ID of the deploy that failed.                  |
| Site ID       | string | ID of the site.                                |
| Error Message | string | Description of what caused the deploy to fail. |
| Branch        | string | Git branch that was being deployed.            |
| Commit SHA    | string | Git commit SHA for the failed build.           |

#### Form Submission Received

Fires when a visitor submits a Netlify-managed form on your site.

This trigger registers a Netlify webhook automatically when you start listening. **Requirements:** 1. Connect with a token that can manage webhooks on the site. 2. Select the **Site** to watch below. This covers submissions across every form on the site.

**Configuration**

| Field | Type            | Required | Description                                                                          |
| ----- | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Site  | select (string) | Yes      | The site whose forms you want to monitor. Options load from the selected connection. |

**Event inputs**

| Field           | Type   | Required | Description                                      |
| --------------- | ------ | -------- | ------------------------------------------------ |
| Submission ID   | string | Yes      | Unique ID of the form submission.                |
| Submitter Email | string | No       | Email address provided in the form submission.   |
| Submitter Name  | string | No       | Name provided in the form submission.            |
| Message Body    | string | No       | Main text body of the form submission.           |
| All Fields      | object | No       | All submitted form fields as a key-value object. |
| Submitted At    | string | No       | Timestamp when the form was submitted.           |

**Outputs**

| Field           | Type     | Description                                      |
| --------------- | -------- | ------------------------------------------------ |
| Submission ID   | string   | Unique ID of the form submission.                |
| Submitter Email | string   | Email address provided in the form submission.   |
| Submitter Name  | string   | Name provided in the form submission.            |
| Message Body    | string   | Main text body of the form submission.           |
| All Fields      | object   | All submitted form fields as a key-value object. |
| Submitted At    | datetime | Timestamp when the form was submitted.           |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/netlify.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
