Content JSON

Overview

The content portion of the request is an array. Each numerical index in the array corresponds to an index in the question array. For instance, index 1 of the content array will be displayed along side the form data present at index 1 of the question array.

Width

A number 1 through 12 that corresponds to the width of the element. Atom task uses a bootstrap grid system, meaning that 1 is roughly a width of 8.3% and 12 is 100%.

Offset

A number 1 through 12 that corresponds to the offset of the element from the left. Atom task uses a bootstrap grid system, meaning that 1 is roughly an offset of 8.3% and 6 is 50%.

Type

Atom Task supports the following content types: Text, Image, Iframe, PDF.

Options Available For Each Type

Text
Value - The text that should be displayed.

Image
URL - The url that should be displayed.

Iframe
URL - The url that should be displayed.

PDF
URL - The url that should be displayed.

* Please remember that CORS headers should be set to '*', and that content must be served over HTTPS.

Example Open Task Request

If you're loading a remote script, be sure to set the Access-Control-Allow-Origin header to *. This is required

JSON

{
  "USERID": "YOUR_USERID_HERE",
  "KEY": "YOUR_API_KEY_HERE",
  "WebHook": "https://www.yourwebsite.com/processWebHook/something.php?id=whaterurlencodeddatayouwant",
  "CustomID": "YOUR_CUSTOMID_HERE",
  "Budget": "100",
  "Title": "Example Request",
  "Description": "This is an example task request.",
  "EstimatedDuration": 600,
  "ExpiresAfter": 86400,
  "Keywords": [
    "Keyword1",
    "Keyword2"
  ], 
  "AutoApproveAfter": 86400,
  "Instructions": "This is where you say what needs to be done.",
 "Content": {
      "0":{
        "Width": 8,
        "Type": "pdf",
        "Options": {
          "url": ""
        }
      },
      "1":{
        "Width": 8,
        "Type": "text",
        "Options": {
          "value": "Go to google and search for the 'Country Villas Homeowners Association' and enter the url."
        }
      }
 },
  "Questions": {
    "0": {
      "Width": 4,
      "Body": [
        {
          "parent": 0,
          "label": "What type of dwelling is listed on the document?",
          "type": "SELECT",
          "width": "12",
		  "offset": "0",
          "element_id": 0,
          "step": 0,
          "subType": 0,
          "subType_data": {
            "Single Family Home": "0",
            "Town Home": "1",
            "Condo": "2"
          }
        },
        {
          "parent": "1",
          "label": "",
          "type": "SELECT",
          "width": "12",
		  "offset": "0",
          "element_id": 1,
          "step": 1,
          "subType": "0",
          "subType_data": {
            "a": "1",
            "b": "2",
            "c": "3"
          }
        }
      ]
    },
    "1": {
      "Width": 4,
      "Body": [
        {
          "parent": "2",
          "label": "Could You Located The Homeowner Association URL?",
          "type": "SELECT",
          "width": "12",
		  "offset": "0",
          "element_id": 2,
          "step": 0,
          "subType": 0,
          "subType_data": {
            "No": "0",
            "Yes": "1"
          }
        }
      ]
    }
  }
}

Atom Task