---
name: zapier-platform-cli
description: Build and publish app integrations to the Zapier platform using the Platform CLI.
---

# Zapier Platform CLI

Build custom app integrations that connect your API to Zapier's ecosystem. Once published, your integration becomes available to millions of Zapier users and any agent using Zapier MCP or the SDK.

## When to use this skill

- You're a developer building a Zapier integration for your company's API
- You want your app's actions and triggers available through Zapier MCP and the SDK
- You prefer code-based development over the visual Platform UI

## Prerequisites

- Node.js 22+
- A Zapier developer account

## Install

```bash
npm install -g zapier-platform-cli
```

## Authenticate

```bash
zapier login
```

## Scaffold a new integration

```bash
zapier init my-app --template typescript
cd my-app
npm install
```

## Define authentication

In your `index.ts`, configure your app's auth scheme (OAuth2, API Key, Session Auth, etc.):

```typescript
const authentication = {
  type: "oauth2",
  oauth2Config: {
    authorizeUrl: "https://your-api.com/oauth/authorize",
    getAccessToken: getAccessTokenRequest,
    refreshAccessToken: refreshAccessTokenRequest,
  },
  test: testAuthRequest,
};
```

## Define triggers and actions

```typescript
const newLeadTrigger = {
  key: "new_lead",
  noun: "Lead",
  display: {
    label: "New Lead",
    description: "Triggers when a new lead is created.",
  },
  operation: {
    perform: async (z, bundle) => {
      const response = await z.request("https://your-api.com/leads");
      return response.data;
    },
  },
};
```

## Test

```bash
zapier test
```

## Deploy

```bash
zapier push
```

## Publishing lifecycle

1. **Private** — only your team can use it
2. **Promoted** — request review for public listing
3. **Available** — live in the Zapier directory
4. **Legacy/Deprecated** — superseded by newer versions

## Documentation

- Platform CLI docs: https://docs.zapier.com/platform/reference/cli-docs
- Authentication guide: https://docs.zapier.com/platform/build/auth
- Publishing requirements: https://docs.zapier.com/platform/publish/integration-publishing-requirements
- TypeScript support: https://docs.zapier.com/integrations/build-cli/typescript-integrations

## Related skills

- `zapier-mcp` — your published integration becomes available via MCP
- `zapier-sdk` — your published integration becomes callable via the SDK