•••
 
Documentation   /   API   /   API - Starting tasks
 
 

API - Starting tasks

 

Endpoint

POST https://plainly.com/start

Parameters

key
Required. Workflow-specific API key. Obtained from the Developer tab for the relevant workflow in the Toolkit.
name
Optional but recommended. Names/describes the task so you can find it in your task list.
passed
Optional. Any variables that you want the task to ingest on starting. Format is {key_1}_IS_{value_1}_AND_{key_2}_IS_{value_2}
no_redirect
Optional. Options are 1 or 0. If set to 1, JSON response returned containing key of the task that was just created. If set to 0 or not set, redirects to the task that was just created.
silent
Optional. Options are 1 or 0. If set to 1, on success the task will be loaded in silent mode.

Example

Request

https://plainly.com/start?key=a1b2c3d4a1b2c3d4&no_redirect=1&name=My task name&passed=first_name_IS_Jane_AND_surname_IS_Doe_AND_any_other_variable_IS_any_other_value

On success

{
  "data": {
     "status": 200,
     "title": "Task started",
     "detail": "1a2b3c4d5e6f7g8h"
   }
}

(N.B. Only returned if no_redirect is set to 1.)

On error

{
  "errors": [
    {
      "status": 400,
      "title": "Missing attribute",
      "detail": "You need a key."
    }
  ]
}