API
Settings → API (सेटिंग्स) में एक key बनाएँ और उसे X-Api-Key header में भेजें।
GET https://taskbeacon.io/api/v1/jobs list your jobs
POST https://taskbeacon.io/api/v1/jobs create one: {"name": "Sales", "period_minutes": 1440}
GET https://taskbeacon.io/api/v1/jobs/ID one job
DELETE https://taskbeacon.io/api/v1/jobs/ID delete (owner only)
किसी job का ping_url केवल उन लोगों को दिया जाता है जो उसे edit कर सकते हैं।
जिस job पर नज़र रखी जाती है लेकिन जो कोई alert नहीं भेजता, उसके लिए alerts_on का मान false होता है; job बनाते समय "alerts_on": false
भेजें ताकि वह इसी तरह शुरू हो (default true)।
Ping पते
Ping के लिए किसी key की ज़रूरत नहीं: पता ही अपने आप में secret है। GET और POST दोनों काम करते हैं (10 KB तक की POST body रखी जाती है; failure होने पर उसके आख़िरी 10 KB)।
https://taskbeacon.io/ping/ID finished (numbers after ?, e.g. ?rows=15234, or a JSON body) https://taskbeacon.io/ping/ID/start started https://taskbeacon.io/ping/ID/fail failed (?exit_code=, ?rc=, ?error=, the output as the body) https://taskbeacon.io/ping/ID/0 finished, by exit code https://taskbeacon.io/ping/ID/N failed with exit code N (any other number)
HEAD request (link preview) का जवाब दिया जाता है, लेकिन उसे कभी run नहीं गिना जाता। देखें Exit code और Output में शब्द।