Netlify

List sites and trigger deploys on Netlify.

Developer toolsAPI key4 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (4)
start_deploy
get_site
list_files
list_site_deploys
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("netlify", "start_deploy", {
    "siteId": "<siteId>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Netlify answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "netlify-start-deploy",
  name: "Netlify: Start Deploy",
  description: "Calls Netlify when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("netlify", {
      "action": "start_deploy",
      "siteId": "<siteId>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/netlify/start_deploy" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"siteId":"<siteId>"}}'

Actions

start_deployin catalog

Start Deploy. Triggers a new build for a site on Netlify. Supports clearing build cache.

Input	Type	Description
`siteId`required	id (picked from your account)	Select the site to deploy
`clearCache`optional	boolean	Whether to clear the build cache before building

get_site

Get Site. Get a specified site. Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use getEnvVars to retrieve site environment variables.

Input	Type	Description
`siteId`required	id (picked from your account)	Select the site to retrieve information for

list_files

List Files. Returns a list of all the files in the current deploy.

Input	Type	Description
`siteId`required	id (picked from your account)	Select the site to list files for

list_site_deploys

List Site Deploys. Returns a list of all deploys for a specific site.

Input	Type	Description
`siteId`required	id (picked from your account)	Select the site to list deploys for
`page`optional	number	Page number for pagination (starts from 1)
`perPage`optional	number	Number of items per page (max 100)

Details

Id: netlify
Category: Developer tools
Tags: hosting, deployment, jamstack, frontend
Package: @activepieces/piece-netlify@0.1.3
Tier: Community