Skip to content
Tallyfy

Launch via API

Launching processes via API

Send a POST request to Tallyfy’s REST API to launch processes from code - triggered by events in other systems like CRM deals closing or form submissions.

What you’ll need

  • A Tallyfy account with API access
  • An OAuth Bearer token for authentication
  • The checklist_id (template ID) you want to launch
  • Familiarity with REST APIs and JSON

How to launch a process

  1. Get your access token - set up OAuth in Tallyfy and store your Bearer token securely

  2. Find the template ID - grab the checklist_id from the URL when viewing your template, and note any kick-off form fields that need data

  3. Send the POST request - call POST /organizations/{org_id}/runs with your JSON body containing checklist_id and process details

  4. Handle the response - a 201 response returns the new process data including its ID. Add error handling for failures.

See the API process launch guide for full details.

What you can do via API

  • Start processes from events in other systems (CRM, forms, IoT sensors)
  • Pre-fill kick-off form fields with external data using the prerun object
  • Set custom process names, task assignments, and deadlines per step
  • Assign users, groups, and roles at launch time
  • Tag processes and place them in folders automatically

Sample API request

POST /organizations/{org_id}/runs HTTP/1.1
Host: go.tallyfy.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
X-Tallyfy-Client: APIClient


{
  "checklist_id": "your-template-id",
  "name": "Customer Onboarding - Acme Corporation",
  "prerun": {
    "customer_name": "Acme Corporation",
    "contract_value": 15000,
    "start_date": "2024-01-15T00:00:00.000Z"
  }
}

Common use cases

  • CRM integration - start onboarding when deals close
  • Document management - trigger approvals when files are uploaded
  • IoT devices - launch inspections when sensors fire alerts
  • External forms - create processes from third-party submissions
  • Database triggers - start workflows from data changes

Processes > Launch process

Tallyfy’s Launch Process API endpoint (POST to /organizations/[org_id]/runs) lets you programmatically start a new process from a template by providing a checklist_id along with optional parameters like name and pre-filled kick-off form fields and per-step assignee or deadline overrides.

Postman > Working with templates and processes

Tallyfy’s API lets you launch processes from templates by posting to the runs endpoint with a checklist ID and optional kick-off form data while also supporting advanced patterns like dynamic template selection and bulk launching through Postman scripts.

Launching > Triggers

Tallyfy offers seven ways to start a process — manually clicking launch or submitting a form or automatically through API calls and emails and magic links and recurring schedules and task completion chains — with some triggers able to pre-fill kick-off form data to cut manual entry and reduce errors.

Workato > Launch Tallyfy processes from Workato

Workato recipes can automatically launch Tallyfy processes by connecting any trigger system like Salesforce or Zendesk through an HTTP connector that sends authenticated POST requests to Tallyfy’s API with template IDs and kick-off form data mapped dynamically from the triggering event.
Get in touch
About Tallyfy