feat: Migrate documentation to Mintlify and implement Helper Agent with search functionality (#15443)
This commit is contained in:
Abdul Rahman
@@ -0,0 +1,112 @@
|
||||
---
|
||||
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/section/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
|
||||
|
||||
|
||||
@@ -0,0 +1,118 @@
|
||||
---
|
||||
title: APIs Overview
|
||||
info: Understand the four different APIs and when to use each one.
|
||||
image: /images/user-guide/api/api-overview.png
|
||||
sectionInfo: Learn how to connect Twenty to your other tools.
|
||||
---
|
||||
<Frame>
|
||||
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
||||
</Frame>
|
||||
|
||||
Twenty was built to be developer-friendly, offering powerful APIs that adapt to your custom data model. We provide four distinct API types to meet different integration needs.
|
||||
|
||||
## Developer-First Approach
|
||||
|
||||
Twenty generates APIs specifically for your data model, meaning:
|
||||
- **No long IDs required**: Use your object and field names directly in endpoints
|
||||
- **Standard and custom objects treated equally**: Your custom objects get the same API treatment as built-in ones
|
||||
- **Dedicated endpoints**: Each object and field gets its own API endpoint
|
||||
- **Custom documentation**: Generated specifically for your workspace's data model
|
||||
|
||||
<Warning>
|
||||
Your custom API generates personalized documentation accessible via Settings → API & Webhooks after creating an API key. This documentation reflects your exact data model and field configurations.
|
||||
</Warning>
|
||||
|
||||
## The Four API Types
|
||||
|
||||
Twenty offers APIs in both **REST** and **GraphQL** formats:
|
||||
|
||||
### REST APIs
|
||||
|
||||
#### 1. REST Metadata API
|
||||
- **Purpose**: Manage your workspace and data model structure
|
||||
- **Use cases**:
|
||||
- Create, modify, or delete objects and fields
|
||||
- Configure workspace settings
|
||||
- Manage data model relationships
|
||||
- **Access**: Available through REST endpoints
|
||||
|
||||
#### 2. REST Core API
|
||||
- **Purpose**: Manage your actual data records
|
||||
- **Use cases**:
|
||||
- Create, read, update, delete records
|
||||
- Query specific data
|
||||
- Manage record relationships
|
||||
- **Access**: Available through REST endpoints
|
||||
|
||||
### GraphQL APIs
|
||||
|
||||
#### 3. GraphQL Metadata API
|
||||
- **Purpose**: Same as REST Metadata API but with GraphQL benefits
|
||||
- **Use cases**: Same workspace and data model management
|
||||
- **Additional benefits**:
|
||||
- Query multiple metadata types in one request
|
||||
- Precise field selection
|
||||
- Better performance for complex queries
|
||||
|
||||
#### 4. GraphQL Core API
|
||||
- **Purpose**: Same as REST Core API but with GraphQL advantages
|
||||
- **Use cases**: Same data record management
|
||||
- **Additional benefits**:
|
||||
- **Batch operations**: Available for all operations
|
||||
- **Upsert operations**: Create or update records in one call
|
||||
- Query relationships in single requests
|
||||
- Precise data fetching
|
||||
|
||||
## Batch Operations
|
||||
|
||||
### REST and GraphQL Batch Support
|
||||
Both REST and GraphQL APIs support batch operations for most actions:
|
||||
- **Batch size**: Up to 60 records per request
|
||||
- **Available operations**: Create, update, delete multiple records
|
||||
- **Performance**: Significantly faster than individual API calls
|
||||
|
||||
### GraphQL-Only Features
|
||||
- **Batch Upsert**: Only available in GraphQL APIs
|
||||
- **Usage**: Use plural object names (e.g., `CreateCompanies` instead of `CreateCompany`)
|
||||
- **Requirement**: This is why singular and plural object names must be distinct
|
||||
|
||||
## API Documentation Access
|
||||
|
||||
1. Go to **Settings → API & Webhooks**
|
||||
2. Create an API key (required for documentation access)
|
||||
3. Access your custom documentation and playground
|
||||
4. Test APIs with your actual data model
|
||||
|
||||
Your documentation is unique to your workspace because it reflects your custom objects, fields, and relationships.
|
||||
|
||||
## When to Use Each API
|
||||
|
||||
### Use Metadata APIs when:
|
||||
- Setting up your data model
|
||||
- Creating custom objects or fields
|
||||
- Configuring workspace settings
|
||||
|
||||
### Use Core APIs when:
|
||||
- Managing day-to-day data (People, Companies, Opportunities)
|
||||
- Integrating with external systems
|
||||
- Building custom applications
|
||||
- Automating data workflows
|
||||
|
||||
### Choose GraphQL when:
|
||||
- You need batch operations
|
||||
- You want to minimize API calls
|
||||
- You need upsert functionality
|
||||
- You're building complex integrations
|
||||
|
||||
### Choose REST when:
|
||||
- You prefer simpler API structure
|
||||
- You're building basic integrations
|
||||
- Your team is more familiar with REST
|
||||
- You need straightforward CRUD operations
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[API & Webhooks Setup](/user-guide/section/integrations-api/api-webhooks)**: Learn how to create API keys and webhooks
|
||||
- **Custom Documentation**: Access your personalized API docs via Settings → API & Webhooks
|
||||
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Integrations
|
||||
info: "Connect Twenty to your existing tools and build custom automations."
|
||||
image: /images/user-guide/integrations/plug.png
|
||||
sectionInfo: Connect Twenty to your existing tools and workflows
|
||||
---
|
||||
<Frame>
|
||||
<img src="/images/user-guide/integrations/plug.png" alt="Header" />
|
||||
</Frame>
|
||||
|
||||
## Current Integration Options
|
||||
|
||||
### Native Integrations
|
||||
Twenty currently offers native integration with:
|
||||
- **Email & Calendar**: Connect Gmail, Outlook, or SMTP/CalDAV providers
|
||||
- **API Access**: Use our REST and GraphQL APIs to build custom integrations
|
||||
|
||||
For email and calendar setup, visit [Email & Calendar Setup](/user-guide/section/settings/email-calendar-setup).
|
||||
|
||||
### Workflows (Recommended)
|
||||
The primary way to connect Twenty to other tools is through our in-app **Workflows** feature:
|
||||
- **HTTP Nodes**: Make API calls to external services
|
||||
- **Code Nodes**: Write custom logic for complex integrations
|
||||
- **Webhook Triggers**: Receive data from external systems
|
||||
- **Field Update Triggers**: Automate actions based on CRM changes
|
||||
|
||||
Learn more in our [Workflows section](/user-guide/section/workflows/getting-started-workflows).
|
||||
|
||||
### Zapier Integration (Legacy)
|
||||
We maintain a Zapier integration for users who prefer no-code automation:
|
||||
|
||||
1. Visit [Twenty on Zapier](https://zapier.com/apps/twenty/integrations)
|
||||
2. Create a new Zap with Twenty as trigger or action
|
||||
3. Generate an API key in Settings → API & Webhooks
|
||||
4. Connect your Twenty workspace to Zapier
|
||||
|
||||
## Future Vision: Community-Built Connectors (2026)
|
||||
|
||||
### Extensibility Platform
|
||||
We're building an extensibility platform that will allow developers to create apps as code. This will enable:
|
||||
- **Custom Connectors**: Build integrations with your favorite software
|
||||
- **Community Contributions**: Share and discover connectors built by others
|
||||
- **Flexible Architecture**: Extend Twenty's capabilities beyond core features
|
||||
|
||||
### AI-Assisted Workflow Building
|
||||
Coming in 2026, AI assistance will help users:
|
||||
- **Auto-Generate Workflows**: Describe your integration needs in plain language
|
||||
- **Smart Suggestions**: Get recommendations for connecting your specific tools
|
||||
- **Template Library**: Access pre-built workflows for common use cases
|
||||
|
||||
The future of Twenty integrations is community-driven, AI-assisted, and infinitely extensible.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user