Scripts
##Creating a Script
Scripts are imported from your GitHub repositories. To expose a file as a callable endpoint, add @deploy as a comment at the top.
Scripts imported from public repositories are themselves publicly accessable to anyone.
##Running a Script
Scripts hosted here have the same path as they do on GitHub. All you need to do is replace github.com by taskmill.io and blob by exec.
https://github.com/a7medkamel/taskmill-help/blob/master/intro/helloworld.jscurl https://taskmill.io/a7medkamel/taskmill-help/exec/master/intro/helloworld.js
^^^^^^^^^^^ ^^^^Input
Your script is an express endpoint. The function's signature is (req, req, next). All data posted or streamed to the script is available on your req object. Same goes for query parameters.
Request Body
Request Query String
Output
Use the Response Object to write output data. You have access to multiple methods on Response, again these are the same as express.
Content Type
You can set the content-type header either programaticaly or through the scripts manual.
Programaticaly
Manual
Manual
Each script should define a usage manual as a comment block. The manual is used to describe variouse aspects of the script's execution.
For a script to be exposed to Taskmill, your manual should start with @deploy.
/*
@deploy
*/You can also define input and output contrainsts as well as additional metadata.
| attribute | usage | default |
|---|---|---|
| @deploy | required for all scripts | required |
| @title | human readable title | undefined |
| @description | detailed description | undefined |
| @type | generate, transform, or none |
none |
| @input | json with input content-type and example |
undefined |
| @output | json with output content-type |
undefined |
Services
We provide built in services that you can make use of. Such services include Email, SMS, and Automated Phone Calls.
You can send emails directly from our servers.
SMS
You can send sms directly from our servers.