•••
 
Documentation   /   API   /   API - Doing task actions
 
 

API - Doing task actions

 

Endpoint

POST https://plainly.com/hook 

Parameters

task
Required. Key of the relevant task which has the item being completed. Can be obtained via the {{checklist_key}} variable.
for
Required. The ---id: directive of the task item being completed. Can be obtained by inspecting the code of the relevant Workflow.
answer
Required. The answer or value being passed to the task item in order to complete it. Must comply with any ---string_format: directive for the item being completed.
actioner
Optional. If not logged into Plainly, the name or other identifier for the person taking the action.
redirect
Optional. A URL to redirect to on success.

Example

https://plainly.com/hook?task=a1b2c3d4a1b2c3d4&for=item_12345678&answer=Jane Doe

Notes

  • Returns 200 status code on success. Returns 400 or 500 error code on error.
  • Only works for hook, question, text_input, attachment or hidden actions.