Netlify

All-in-one platform for automating modern web projects

Go to site
Explore
/
Apps
/
Netlify

Netlify API Integrations

Build and run workflows using the Netlify API. Use 1000s of source-available triggers and actions across 1000+ apps. Or write custom code to integrate any app or API in seconds.

Overview

With the Netlify API, you can build a number of things, including:

  • A platform for hosting static websites
  • A Continuous Deployment platform for your web applications
  • A serverless functions platform
  • A headless CMS
  • A static site generator
  • A image processing service
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    netlify: {
      type: "app",
      app: "netlify",
    }
  },
  async run({steps, $}) {
    return await axios($, {
      url: `https://api.netlify.com/api/v1/user`,
      headers: {
        Authorization: `Bearer ${this.netlify.$auth.oauth_access_token}`,
      },
    })
  },
})
Get Site with Netlify API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Netlify
 
Try it
Send Message (Advanced) with Discord Webhook API on New Deploy Failure (Instant) from Netlify API
Netlify + Discord Webhook
 
Try it
Add Multiple Rows with Google Sheets API on New Deploy Failure (Instant) from Netlify API
Netlify + Google Sheets
 
Try it
Get Site with Netlify API on New Item in Feed from RSS API
RSS + Netlify
 
Try it
Get Site with Netlify API on New Message from Discord API
Discord + Netlify
 
Try it
New Form Submission (Instant) from the Netlify API

Emit new event when a user submits a form

 
Try it
New Deploy Failure (Instant) from the Netlify API

Emit new event when a new deployment fails

 
Try it
New Deploy Success (Instant) from the Netlify API

Emit new event when a new deployment is completed

 
Try it
New Deploy Start (Instant) from the Netlify API

Emit new event when a new deployment is started

 
Try it
Get Site with the Netlify API

Get a specified site. See docs

 
Try it
List Files with the Netlify API

Returns a list of all the files in the current deploy. See docs

 
Try it
List Site Deploys with the Netlify API

Returns a list of all deploys for a specific site. See docs

 
Try it
Rollback Deploy with the Netlify API

Restores an old deploy and makes it the live version of the site. See docs

 
Try it

Authentication

Netlify uses OAuth authentication. When you connect your Netlify account, Pipedream will open a popup window where you can sign into Netlify and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Netlify API.

Pipedream requests the following authorization scopes when you connect your account:

OAuth Request Configurations:
  1. authorization
    GEThttps://app.netlify.com/authorize?client_id={{oauth.client_id}}&redirect_uri={{oauth.redirect_uri}}&state={{oauth.state}}&response_type=code&scope={{oauth.space_separated_scopes}}
  2. accessToken
    POSThttps://api.netlify.com/oauth/tokencontent-type: application/x-www-form-urlencodedaccept: application/json
    client_id={{oauth.client_id}}&client_secret={{oauth.client_secret}}&redirect_uri={{oauth.redirect_uri}}&grant_type=authorization_code&code={{oauth.code}}