How do I start a process from the API?

This article walks a first-time API use through starting a process, assuming you have a template already.

1. Get your token

In order to perform any action within the Tallyfy API, you must first gain the access token, which you can find out about here.

2. Gather your information

In order to make any call to the API, you must first make sure you have the necessary information.

This includes: 

• The name you are going to give this process
• The ID of the template you are going to use
• Any kick-off field ID's (or prerun fields) and what you want to put in them
• The user ID of the user you wish to assign the process to
• Any guests you wish to invite 

3. Prepare your JSON

Here is what a  JSON payload might actually look like:

{
  "name": "Client Onboarding",
  "checklist_id": "bd023ed4835f6e92f3ebfb4c3fa7a55b",
  "summary": "This is a sample of what a call to a client onboarding template might look like",
  "prerun": {
    "510": "(123)456-7890",
    "509": "Joe@Schmoe.com"
  },
  "trackers": {
    "users": [
      "15813"
    ],
    "guests": [
      "guest@user.com"
    ]
  }
}

4. Make your call

About the actual call:

Request type: 

POST

URL: 

go.tallyfy.com/api/organizations/{your_org_id}/runs

Headers: 

'Accept: application/json', 'Authorization: Bearer {your_auth_token}'

5. Response - 201

{
  "data": {
    "id": "76ad65a8300622d46b94d32d13658875",
    "checklist_id": "bd023ed4835f6e92f3ebfb4c3fa7a55b",
    "name": "Client Onboarding",
    "summary": "This is a sample of what a call to a client onboarding template might look like",
    "summary_html": "<p>This is a sample of what a call to a client onboarding template might look like</p>\n",
    "status": "active",
    "progress": {
      "complete": 0,
      "total": 5,
      "percent": 0
    },
    "started_by": 15806,
    "metadata": [],
    "prerun": [],
    "alerts": [],
    "starred": false,
    "created_at": "2018-04-27T18:01:14Z",
    "started_at": "2018-04-27T18:01:14Z",
    "started_at_as_str": "2018-04-27T18:01:14Z",
    "last_updated": "2018-04-27T18:01:14Z",
    "last_synced": "2018-04-27T18:01:14Z",
    "archived_at": null,
    "completed_at": null,
    "due_date_passed": false,
    "collaborators": [
      15806,
      15813
    ],
    "due_soon": true,
    "checklist": {
      "title": "Client Onboarding"
    }
  }
}

Please report a help ticket to Tallyfy Support with your question, issue or feature request. We would love to hear from you.