Launch via API
Before starting, make sure you have:
- A Tallyfy® account with API access enabled for your account for technical integration.
- API authentication credentials (API key or OAuth token) for secure access.
- The ID of the template(s) you want to launch for proper targeting.
- A basic understanding of REST API concepts and JSON for implementation.
These requirements ensure successful API integration and secure process automation.
Tallyfy’s REST API allows starting processes automatically using code - enabling sophisticated workflow automation. This enables smooth integration with other systems and allows building custom ways to launch processes based on external events or conditions.
API-triggered launches provide the highest level of automation flexibility for complex enterprise workflows.
-
Get authentication details
- Generate an API key (or set up OAuth) in your Tallyfy account settings.
- Store credentials securely for making API requests.
-
Find the process template ID
- Locate the Template ID (e.g., from the URL when viewing the template).
- Note any kick-off form fields that need data.
-
Build the API request
- Use the
/api/processes
endpoint with aPOST
request. - Include authentication headers.
- Format the request body (JSON) with the template ID and process details.
- Use the
-
Handle the response
- Get the Process ID from a successful response.
- Add error handling for failed requests.
For full details, including request payload formats and authentication, see the API Process Launch Guide.
Launching via the API offers several strategic benefits:
- Start processes based on events in other systems for real-time workflow initiation.
- Schedule repeating process launches for recurring business activities.
- Start many processes at once (bulk launch) for efficient batch processing.
- Fill kick-off form fields with external data for seamless information transfer.
- Send complex data structures into processes for sophisticated workflow parameterization.
- Link Tallyfy processes to records in other systems (like a CRM) for comprehensive data connectivity.
- Use custom process names for dynamic identification and organization.
- Control task assignments via code for intelligent resource allocation.
- Set custom deadlines using logic for adaptive timeline management.
These capabilities enable enterprise-grade workflow automation with sophisticated business logic.
POST /api/processes HTTP/1.1Host: go.tallyfy.com/apiAuthorization: Bearer YOUR_API_TOKENContent-Type: application/json
{ "template_id": "your-template-id", "name": "API Triggered Process - Customer Onboarding", "kickoff_fields": { "customer_name": "Acme Corporation", "contract_value": 15000, "start_date": "2023-05-01T00:00:00.000Z" }}
Launching via API is ideal for:
- Connecting a CRM to start customer onboarding when new deals close.
- Starting approval workflows from document management systems when documents are uploaded.
- Starting inspection processes from IoT devices when sensors trigger alerts.
- Creating processes from external form submissions for automated intake workflows.
- Starting workflows from database changes for real-time process automation.
These use cases demonstrate how API launching enables seamless workflow integration across diverse business systems.
Workato > Launch Tallyfy processes from Workato
Triggers > Launch via a schedule
- 2025 Tallyfy, Inc.
- Privacy Policy
- Terms of Use
- Report Issue
- Trademarks