Trigger: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 31: | Line 31: | ||
==Response== | ==Response== | ||
The web server is expected to send a response. | The web server is expected to send a response which is a parseable JSON object. If the trigger type is TQL, each key of the object must be a valid TQL update statement, and each value must be a value in decimal notation. | ||
<!-- | |||
==Examples== | |||
Some simple examples exist to demonstrate the call-and-response functionality required for API triggers. | |||
===TQL example: Geometry counter=== | |||
The following example is PHP code which reads out a number of [[Item]] types, and writes the results into [[Global]]s. | |||
--> | |||
Revision as of 12:04, 13 December 2021
This article is a stub.
API Triggers can be used to execute external scripts and applications.
When an API Trigger executes, it sends a web request to a specified url. The web request includes query parameters which the receiving server can use to interact with the session from which the call originated.
Request
The following query parameters are relevant:
| Type | Key | Meaning | Notes |
|---|---|---|---|
| Querystring / GET parameter | token | API token for session access | |
| Querystring / GET parameter | f | Expected return format. | Defaults to "JSON" |
| Request header | Referer | The originating Tygron server | "Referer" is misspelled in the original http specification. |
Response
The web server is expected to send a response which is a parseable JSON object. If the trigger type is TQL, each key of the object must be a valid TQL update statement, and each value must be a value in decimal notation.