Setting Up API Integrations

To create an API integration:

1. Go to integrations: Navigate to the Integrations section in your dashboard
2. Create integration: Click "Create Integration" and select the integration type
3. Configure auth: Set up authentication (API key, OAuth, custom auth, etc.)
4. Set configuration: Configure connection settings, endpoints, and options
5. Test connection: Test the integration to ensure it works correctly
6. Save: Save the integration for use in your workflows

Once created, integrations can be used in workflow nodes to connect to external services. The system handles authentication, retries, and error handling automatically.

AgentCanvas supports various authentication methods:

• API Key: Simple authentication using API keys in headers or query parameters
• OAuth 2.0: Standard OAuth flow for services that support it
• Basic Auth: Username and password authentication
• Bearer Token: Token-based authentication with tokens in headers
• Custom Auth: Custom authentication methods for specific services

Each integration type supports different authentication methods. The system securely stores credentials and handles token refresh for OAuth integrations.

Common integration types you can create:

• REST API: Connect to RESTful APIs with GET, POST, PUT, DELETE requests
• Webhook: Configure webhooks to receive events from external services
• Database: Connect to databases (PostgreSQL, MySQL, MongoDB, etc.)
• File Storage: Connect to storage services (S3, Google Drive, Dropbox, etc.)
• Messaging: Connect to messaging services (Slack, Discord, email, SMS, etc.)
• Social Media: Connect to social platforms (Twitter, Facebook, Instagram, etc.)

Each integration type has specific configuration options and authentication requirements. The system validates configurations before saving.

Configure your integrations with these settings:

• Name: Descriptive name for your integration
• Description: What the integration does and how it's used
• Base URL: Base URL for API endpoints
• Rate limits: Configure rate limits to avoid hitting API quotas
• Retry attempts: Number of retry attempts for failed requests
• Timeout seconds: Request timeout in seconds
• Event types: Which events trigger webhooks (for webhook integrations)

The system uses these settings to handle requests, retries, and error handling automatically. Configure rate limits to match your API provider's limits to avoid throttling.

Once created, integrations can be used in workflow nodes:

• HTTP Request nodes: Use REST API integrations to make HTTP requests
• Webhook trigger nodes: Use webhook integrations to trigger workflows
• Database nodes: Use database integrations to query or update databases
• File nodes: Use file storage integrations to read or write files
• Notification nodes: Use messaging integrations to send notifications

When you configure a node to use an integration, it automatically handles authentication, formatting requests, and parsing responses.