{"id":19301874,"url":"https://github.com/payloadcms/plugin-zapier","last_synced_at":"2025-10-08T12:01:56.571Z","repository":{"id":63324482,"uuid":"541247595","full_name":"payloadcms/plugin-zapier","owner":"payloadcms","description":"The official Zapier plugin for Payload","archived":false,"fork":false,"pushed_at":"2023-08-08T11:13:57.000Z","size":457,"stargazers_count":26,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-25T06:39:13.861Z","etag":null,"topics":["payload","payload-plugin","payloadcms"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/payloadcms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-25T17:09:33.000Z","updated_at":"2025-04-06T12:31:17.000Z","dependencies_parsed_at":"2024-11-09T23:29:33.499Z","dependency_job_id":null,"html_url":"https://github.com/payloadcms/plugin-zapier","commit_stats":{"total_commits":23,"total_committers":2,"mean_commits":11.5,"dds":0.04347826086956519,"last_synced_commit":"90cbaf5d2a7142f480c84e2009282ceb0eb35701"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/payloadcms/plugin-zapier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payloadcms%2Fplugin-zapier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payloadcms%2Fplugin-zapier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payloadcms%2Fplugin-zapier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payloadcms%2Fplugin-zapier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/payloadcms","download_url":"https://codeload.github.com/payloadcms/plugin-zapier/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/payloadcms%2Fplugin-zapier/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262079733,"owners_count":23255622,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["payload","payload-plugin","payloadcms"],"created_at":"2024-11-09T23:19:10.381Z","updated_at":"2025-10-08T12:01:51.529Z","avatar_url":"https://github.com/payloadcms.png","language":"TypeScript","readme":"# Payload Zapier Plugin\n\nThis plugin can be added to a Payload project to make it simple to send Zaps to a zapier webhook address when collection data changes. It is designed to be flexible and generic to allow for all use-cases to manage zaps.\n\n### How it works\nWhen a collection is created/updated/deleted, the plugin will send a Zap to the webhook address. The Zap will contain the collection name, the operation (create/update/delete), and the data related to the document.\n\nWe recommend starting with the Zapier Paths + Webhooks template to get started. [See here](https://zapier.com/apps/paths/integrations/webhook). Using Paths, will allow you to handle many different types of data and operations coming from Payload.\n\n### Requirements\n\n- A Zapier account with 1 webhook configured. [More](https://zapier.com/help/create/code-webhooks/trigger-zaps-from-webhooks)\n- A Payload project\n\n## Plugin Config Example\n\n\n```ts\n/* file: payload.config.ts */\n\nimport { buildConfig } from 'payload/config'\nimport path from 'path'\nimport Users from './collections/Users'\nimport { zapierPlugin } from '@payloadcms/plugin-zapier'\n\nexport default buildConfig({\n  // ...rest of your config goes here\n  plugins: [\n    zapierPlugin({\n      collections: ['posts'],\n      webhookURL: 'https://hooks.zapier.com/hooks/catch/123456/abcdef/',\n      enabled: async req =\u003e {\n        // -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --\n        // `enabled` can be a boolean OR a function that returns a boolean.\n        //\n        // if it is a function, it will be passed the following arguments:\n        //  - all arguments from the hook that triggered the Zap\n        //  - operation (create/update/delete)\n        // -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --\n        return req.user.role === 'admin'\n      },\n    }),\n  ],\n})\n```\nThis plugin is configurable to work across many different Payload collections. A * denotes that the property is required. [Types file](./src/types.ts).\n| Option                        | Description |\n| ----------------------------- | ----------- |\n| **`collections`***            | Array of collection slugs that will  send data to Zapier. `[\"*\"]` can be used to zap every collection. |\n| **`webhookURL`***             | Zapier webhook URL to send events to. |\n| **`enabled`**                 | Function or boolean value that is checked before a Zap is sent. |\n\n## Features\n\n**Send Zaps**\nAllows for events to be sent to Zapier when a specified collection is updated or deleted.\n\n#### Webhook Data\n\nThe data sent to the Zapier webhook URL will include:\n\n1. The `collection` slug that triggered the zap.\n1. The `operation` used, one of: 'create', 'update', or 'delete'.\n1. The `data` object, which is the Payload document that was created, updated, or deleted.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpayloadcms%2Fplugin-zapier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpayloadcms%2Fplugin-zapier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpayloadcms%2Fplugin-zapier/lists"}