FixoTask Documentation
Welcome to FixoTask! This documentation will help you get started with building powerful workflow automations that connect your favorite apps and services.
Integrations
Connect with 500+ apps and services or build custom integrations.
Browse Integrations →Quick Start Guide
Follow these steps to create your first workflow automation:
Create an Account
Sign up for a free FixoTask account to get started.
curl -X POST https://api.fixotask.com/auth/signup \
-H "Content-Type: application/json" \
-d '{"email": "your@email.com", "password": "your_password"}'
Get Your API Key
Generate an API key from your dashboard settings.
export FIXOTASK_API_KEY="your_api_key_here"
Create Your First Workflow
Use our visual editor or API to create a simple automation.
{
"name": "Welcome Email Automation",
"trigger": {
"type": "webhook",
"config": {
"method": "POST",
"path": "/new-user"
}
},
"actions": [
{
"type": "email",
"config": {
"to": "{{trigger.email}}",
"subject": "Welcome to our platform!",
"template": "welcome_email"
}
}
]
}
Authentication
FixoTask uses API keys for authentication. Include your API key in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.fixotask.com/workflows
Security Note
Keep your API keys secure and never expose them in client-side code. Use environment variables or secure key management systems.
Understanding Workflows
Workflows are the core building blocks of FixoTask. They consist of triggers, actions, and conditions that automate your business processes.
Workflow Structure
{
"id": "wf_123456789",
"name": "Customer Onboarding",
"description": "Automates new customer setup process",
"status": "active",
"trigger": {
"type": "form_submission",
"config": {
"form_id": "signup_form"
}
},
"actions": [
{
"type": "create_user",
"config": {
"email": "{{trigger.email}}",
"name": "{{trigger.name}}"
}
},
{
"type": "send_email",
"config": {
"template": "welcome_email",
"to": "{{trigger.email}}"
}
}
],
"conditions": [
{
"field": "trigger.plan",
"operator": "equals",
"value": "premium"
}
]
}
API Overview
The FixoTask API is RESTful and uses JSON for request and response bodies. All API endpoints are available at https://api.fixotask.com
.
Base URL
https://api.fixotask.com/v1
Common Endpoints
Official SDKs
We provide official SDKs for popular programming languages to make integration easier.
JavaScript/Node.js
npm install @fixotask/sdk
const FixoTask = require('@fixotask/sdk');
const client = new FixoTask('your_api_key');
Python
pip install fixotask
import fixotask
client = fixotask.Client('your_api_key')
Go
go get github.com/fixotask/go-sdk
import "github.com/fixotask/go-sdk"
client := fixotask.NewClient("your_api_key")
Error Handling
The FixoTask API uses conventional HTTP response codes to indicate success or failure of requests.
HTTP Status Codes
Error Response Format
{
"error": {
"code": "INVALID_WORKFLOW",
"message": "The workflow configuration is invalid",
"details": {
"field": "trigger.type",
"issue": "Unknown trigger type 'invalid_trigger'"
}
}
}
Best Practices
Security
- Store API keys securely using environment variables
- Use HTTPS for all API requests
- Implement proper error handling and logging
- Regularly rotate your API keys
Performance
- Use webhooks instead of polling when possible
- Implement exponential backoff for retries
- Cache frequently accessed data
- Monitor your workflow execution metrics
Workflow Design
- Keep workflows simple and focused
- Use descriptive names and documentation
- Test workflows thoroughly before deployment
- Implement proper error handling and fallbacks