Incoming Webhooks are a simple way to create tasks inside Workast from external sources. They make use of normal HTTP requests with a JSON payload that includes the task text and some additional details. 

The Incoming Webhooks app


To get started, you need to add the Incoming Webhooks application to the space where you want to be creating tasks. Click on ellipses (three dots) in the top right corner of the space and then on "Manage apps" from the menu.   Scroll down, and select "Add" next to "Incoming Webhooks."   Click the X in the top right-hand corner to return to your space.


 

 


Creating a Webhook URL


  • Click on either the webhook icon or the ellipses (three dots) in the top right corner of you app and select and select "Incoming Webhooks."  
  • A dialogue box will open.  Select "Create new webhook."
  • Give a name to your webhook URL and click on Create
  • A new dialog will show up with your webhook details. From here, copy the webhook URL that was recently created (https://hooks.workast.app/..)  NOTE: Keep this URL safe. Anyone that has access to the URL will be able to create tasks in your Space.



 


 


Creating your first task


The Webhook URL accepts the HTTP POST method with the header Content-Type: application/json with the task details as JSON body.

If you are familiar with curl, you can try to create a task right away 


curl -XPOST -H "Content-type: application/json" -d '{"text": "A task from the new webhook URL"}' 'https://hooks.workast.app/your-token'


 


More than just text


You can add a description, assign the task, set a start date and a due date. Here is the full payload that is accepted by the Webhook URL.


{
  "text": "string",
  "description": "string",
  "assignedTo": [
    "USERID"
  ],
  "assignedToEmail": [
    "user@email"
  ],
  "startDate": "2019-03-20",
  "dueDate": "2019-03-20",
  "subListId": "5a9cf7219285..." // The list ID within the space
} 

Please note: dates should be in UTC