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

▶

Watch us build a workflow

7 min

Watch now ➜

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

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.

Select this integration
Configure the New Deploy Start (Instant) trigger
1. Connect your Netlify account
2. Select a Site ID
Configure the Run Node Code action
1. Connect your Node account
Deploy the workflow
Send a test event to validate your setup
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#

New Deploy Start (Instant) on Netlify

Description:Emit new event when a new deployment is started

Version:0.1.0

Key:netlify-new-deploy-start

View on GitHub

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.

Label	Prop	Type	Description
Netlify	`netlify`	`app`	This component uses the Netlify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This 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 ID	`siteId`	`string`	Select 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#

Run Node Code on Node

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

View on GitHub

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;
  },
};