Trigger: Difference between revisions
Jump to navigation
Jump to search
(Created page with "API Triggers can be used to execute external scripts and applications.") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{stub}} | |||
API Triggers can be used to execute external scripts and applications. | 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: | |||
{|class=wikitable | |||
! 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. | |||
Revision as of 11:16, 8 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.