mirror of
https://github.com/twentyhq/twenty.git
synced 2026-04-20 06:51:49 -04:00
9f97be67b1
## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
113 lines
4.0 KiB
Plaintext
113 lines
4.0 KiB
Plaintext
---
|
|
title: API Keys & Webhooks
|
|
info: "Create and manage API keys for authentication and set up webhooks for real-time notifications."
|
|
image: /images/user-guide/api/api.png
|
|
sectionInfo: Learn how to connect Twenty to your other tools.
|
|
---
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## API Keys
|
|
|
|
API keys allow automated access to your CRM data, synchronize data with other systems, and create custom integrations or solutions.
|
|
|
|
### Create an API Key
|
|
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. Click **+ Create key** at the top right
|
|
3. Configure your API key:
|
|
- **Name**: Give your API key a descriptive name
|
|
- **Expiration Date**: Set when the key should expire
|
|
4. Click **Save** to generate your API key
|
|
5. **Important**: Copy and store your API key immediately, it's only shown once
|
|
|
|
Once created, your API key provides access to your custom API documentation and playground where you can test endpoints with your actual data model.
|
|
|
|
<Warning>
|
|
Since your API key gives access to sensitive information, you shouldn't share it with services you don't fully trust. If leaked, someone can use it maliciously. If your API key's security is compromised, immediately disable it and generate a new one.
|
|
</Warning>
|
|
<div style={{padding:'70.59% 0 0 0', position:'relative', margin: '32px 0px 0px' }}>
|
|
<iframe
|
|
src="https://player.vimeo.com/video/928786722?autoplay=1&loop=1&autopause=0&background=1&app_id=58479"
|
|
frameBorder="0"
|
|
allow="autoplay; fullscreen; picture-in-picture; clipboard-write"
|
|
style={{
|
|
position:'absolute',
|
|
top:0,
|
|
left:0,
|
|
width:'100%',
|
|
height:'100%',
|
|
borderRadius: '16px',
|
|
border:'2px solid black'
|
|
}}
|
|
title="Export data"
|
|
></iframe>
|
|
</div>
|
|
<script src="https://player.vimeo.com/api/player.js"></script>
|
|
|
|
|
|
### Manage API Keys
|
|
|
|
**Regenerate an API Key:**
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. Click on the API key you want to regenerate
|
|
3. Click the **Regenerate** button
|
|
4. Copy and store the new API key immediately
|
|
|
|
**Delete an API Key:**
|
|
1. Find the API key in your list
|
|
2. Click on the key to open its details
|
|
3. Click **Delete** to remove it permanently
|
|
|
|
## Webhooks
|
|
|
|
Webhooks allow for immediate updates to your specified URL about changes or events related to your customer data.
|
|
|
|
For example, when an Opportunity moves to "Closed Won", a webhook can automatically trigger invoice creation in your accounting system. Note that this type of automation can also be achieved using Twenty's in-app [Workflows feature](/user-guide/workflows/getting-started-workflows), which offers triggers based on field updates for internal automation.
|
|
|
|
Webhooks are ideal for integrating with external systems, while Workflows support both internal automation and external tool connections via webhook triggers, code nodes, and HTTP nodes.
|
|
|
|
### Create a Webhook
|
|
|
|
1. Go to **Settings → APIs & Webhooks → Webhooks**
|
|
2. Click **+ Create webhook**
|
|
3. Enter your webhook URL (where you want to receive notifications)
|
|
4. Click **Save**
|
|
|
|
Your webhook will immediately start receiving real-time notifications about changes to your CRM data.
|
|
|
|
<div style={{padding:'70.59% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
|
<iframe
|
|
src="https://player.vimeo.com/video/928786708?autoplay=1&loop=1&autopause=0&background=1&app_id=58479"
|
|
frameBorder="0"
|
|
allow="autoplay; fullscreen; picture-in-picture; clipboard-write"
|
|
style={{
|
|
position:'absolute',
|
|
top:0,
|
|
left:0,
|
|
width:'100%',
|
|
height:'100%',
|
|
borderRadius: '16px',
|
|
border:'2px solid black'
|
|
}}
|
|
title="Export data"
|
|
></iframe>
|
|
</div>
|
|
<script src="https://player.vimeo.com/api/player.js"></script>
|
|
|
|
### Manage Webhooks
|
|
|
|
**Delete a Webhook:**
|
|
1. Go to **Settings → APIs & Webhooks → Webhooks**
|
|
2. Find the webhook you want to remove
|
|
3. Click on the webhook
|
|
4. Click **Delete** and confirm in the popup
|
|
|
|
**Edit a Webhook:**
|
|
1. Click on the webhook you want to modify
|
|
2. Update the URL or other settings
|
|
3. Click **Save** to apply changes
|
|
|
|
|