← Netlify + Node integrations

Run Node Code with Node API on New Deploy Start (Instant) from Netlify API

Pipedream makes it easy to connect APIs for Node, Netlify and 1000+ other apps remarkably fast.

Trigger workflow on
New Deploy Start (Instant) from the Netlify API
Next, do this
Run Node Code with the Node API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

This integration creates a workflow with a Netlify trigger and Node action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Deploy Start (Instant) trigger
    1. Connect your Netlify account
    2. Select a Site ID
  3. Configure the Run Node Code action
    1. Connect your Node account
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger

Description:Emit new event when a new deployment is started
Version:0.1.0
Key:netlify-new-deploy-start

Netlify 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

Trigger Code

import webhook from "../common/webhook.mjs";
import { deployHooks } from "../common/constants.mjs";

export default {
  ...webhook,
  key: "netlify-new-deploy-start",
  name: "New Deploy Start (Instant)",
  description: "Emit new event when a new deployment is started",
  type: "source",
  version: "0.1.0",
  dedupe: "unique",
  methods: {
    ...webhook.methods,
    getHookEvent() {
      return deployHooks.DEPLOY_BUILDING;
    },
    getMetaSummary(data) {
      const { commit_ref: commitRef } = data;
      return `Deploy started for commit ${commitRef}`;
    },
  },
};

Trigger Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
NetlifynetlifyappThis component uses the Netlify app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
N/Ahttp$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
Site IDsiteIdstringSelect a value from the drop down menu.

Trigger 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:

About Netlify

All-in-one platform for automating modern web projects

Action

Description:Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.
Version:0.0.2
Key:node-run-node-code

Action Code

import node from "../../node.app.mjs";

export default {
  name: "Run Node Code",
  version: "0.0.2",
  key: "node-run-node-code",
  description: "Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.",
  props: {
    node,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Return data to use it in future steps
    return steps.trigger.event;
  },
};

Action Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

LabelPropTypeDescription
NodenodeappThis component uses the Node app.

Action Authentication

The Node API does not require authentication.

About Node

Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.

More Ways to Connect Node + Netlify

Run Node Code with Node API on New Deploy Failure (Instant) from Netlify API
Netlify + Node
 
Try it
Run Node Code with Node API on New Deploy Success (Instant) from Netlify API
Netlify + Node
 
Try it
Run Node Code with Node API on New Form Submission (Instant) from Netlify API
Netlify + Node
 
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
Run Node Code with the Node API

Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the Pipedream Node docs to learn more.

 
Try it