Launch via API

How to launch processes via the Tallyfy API

Requirements

Before starting, make sure you have:

• A Tallyfy account with API access enabled for your account.
• API authentication credentials (API key or OAuth token).
• The ID of the template(s) you want to launch.
• A basic understanding of REST API concepts and JSON.

API-triggered process launches

Tallyfy’s REST API allows starting processes automatically using code. This enables smooth integration with other systems and allows building custom ways to launch processes.

Implementation steps

1. Get authentication details

   • Generate an API key (or set up OAuth) in your Tallyfy account settings.
   • Store credentials securely for making API requests.

2. 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.

3. Build the API request

   • Use the /api/v1/processes endpoint with a POST request.
   • Include authentication headers.
   • Format the request body (JSON) with the template ID and process details.

4. 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.

Key features

Launching via the API offers several benefits:

Automation capabilities

• Start processes based on events in other systems.
• Schedule repeating process launches.
• Start many processes at once (bulk launch).

Data integration

• Fill kick-off form fields with external data.
• Send complex data structures into processes.
• Link Tallyfy processes to records in other systems (like a CRM).

Process customization

• Use custom process names.
• Control task assignments via code.
• Set custom deadlines using logic.

Sample API request

POST /api/v1/processes HTTP/1.1
Host: api.tallyfy.com
Authorization: Bearer YOUR_API_TOKEN
Content-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"
  }
}

Common use cases

Launching via API is good for:

• Connecting a CRM to start customer onboarding.
• Starting approval workflows from document management systems.
• Starting inspection processes from IoT devices.
• Creating processes from external form submissions.
• Starting workflows from database changes.

Related articles

Pro > Launching

Process launching transforms static workflow templates into active projects by assigning tasks and deadlines to specific team members while maintaining independence between running processes and offering multiple launch methods including manual API triggers and automated schedules.

Launching > Triggers

Tallyfy offers multiple process launch methods including manual buttons API integration email triggers magic links schedules task completion triggers and kick-off forms with options to automatically populate data during launch.

Processes > Launch process

A comprehensive REST API endpoint that enables launching new process instances by sending a POST request with required template ID and name along with optional configurations for pre-filling fields and overriding task properties.

Triggers > Launch via a schedule

Scheduled process launches can be implemented through middleware platforms API scheduling or integrated workflows to automate recurring business tasks at specified intervals without manual intervention.