StephanieJoly4GitHubcubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>github-actionsAbdul RahmanFélix MalfaitReorganizing by Feature sections
Capabilities folders to give an overview of each feature
How-Tos folders to give guidance for advanced customizations
Reorganized the Developers section as well, moving the API sub section
there
added some new visuals and videos to illustrate the How-Tos articles
checked the typos, the links and added a section at the end of the
doc.json file to redirect existing links to the new ones (SEO purpose +
continuity of the user experience)
What I have not updated is the "l" folder that, per my understanding,
contains the translation of the User Guide - that I only edited in
English
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> <sup>[Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) is
generating a summary for commit
5301502a32. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: github-actions <github-actions@twenty.com>
Co-authored-by: Abdul Rahman <ar5438376@gmail.com>
Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
77 lines
1.4 KiB
Plaintext
77 lines
1.4 KiB
Plaintext
---
|
|
title: Zapier App
|
|
---
|
|
|
|
|
|
Effortlessly sync Twenty with 3000+ apps using [Zapier](https://zapier.com/). Automate tasks, boost productivity, and supercharge your customer relationships!
|
|
|
|
## About Zapier
|
|
|
|
Zapier is a tool that allows you to automate workflows by connecting the apps that your team uses every day. The fundamental concept of Zapier is automation workflows, called Zaps, and include triggers and actions.
|
|
|
|
You can learn more about how Zapier works [here](https://zapier.com/how-it-works).
|
|
|
|
## Setup
|
|
|
|
### Step 1: Install Zapier packages
|
|
|
|
```bash
|
|
cd packages/twenty-zapier
|
|
|
|
yarn
|
|
```
|
|
|
|
### Step 2: Login with the CLI
|
|
|
|
Use your Zapier credentials to log in using the CLI:
|
|
|
|
```bash
|
|
zapier login
|
|
```
|
|
|
|
### Step 3: Set environment variables
|
|
|
|
From the `packages/twenty-zapier` folder, run:
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
Run the application locally, go to [http://localhost:3000/settings/api-webhooks](http://localhost:3000/settings/api-webhooks), and generate an API key.
|
|
|
|
Replace the **YOUR_API_KEY** value in the `.env` file with the API key you just generated.
|
|
|
|
## Development
|
|
|
|
<Warning>
|
|
|
|
Make sure to run `yarn build` before any `zapier` command.
|
|
|
|
</Warning>
|
|
|
|
### Test
|
|
```bash
|
|
yarn test
|
|
```
|
|
### Lint
|
|
```bash
|
|
yarn format
|
|
```
|
|
### Watch and compile as you edit code
|
|
```bash
|
|
yarn watch
|
|
```
|
|
### Validate your Zapier app
|
|
```bash
|
|
yarn validate
|
|
```
|
|
### Deploy your Zapier app
|
|
```bash
|
|
yarn deploy
|
|
```
|
|
### List all Zapier CLI commands
|
|
```bash
|
|
zapier
|
|
```
|
|
|
|
|