Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Component: WebHook

Functions to catch web hooks.

We run a tiny web server to catch HTTP requests and trigger a script.
Works even on server with WebHook.Check function. Can be used with TLS if needed or in raw mode without HTTP.

Version macOS Windows Linux Server iOS SDK
11.5 / 14.4 ✅ Yes ✅ Yes ✅ Yes ✅ 94% ✅ Yes

Item Details Server
WebHook.Check
Checks whether a web hook has been triggered.
All
11.5
  ✅ Server
WebHook.Create
Creates a new web hook object.
All
11.5
  ✅ Server
WebHook.GetAutoAnswer
Queries auto answer.
All
11.5
  ✅ Server
WebHook.GetCertificateFile
Queries file path for certificate file.
All
11.5
  ✅ Server
WebHook.GetConnectionCounter
Queries number of connections accepted.
All
11.5
  ✅ Server
WebHook.GetFileName
Queries file name for the trigger script.
All
11.5
  ❌ Server
WebHook.GetMaximumRequestSize
Queries maximum allowed request size.
All
12.1
  ✅ Server
WebHook.GetMode
Queries keep open flag.
All
11.5
  ✅ Server
WebHook.GetPort
Queries listening port for a web hook.
All
11.5
  ✅ Server
WebHook.GetPrivateKeyFile
Queries file path for private key file.
All
11.5
  ✅ Server
WebHook.GetSSL
Whether SSL is enabled.
All
11.5
  ✅ Server
WebHook.GetScriptName
Queries script name for the trigger script.
All
11.5
  ❌ Server
WebHook.GetTag
Queries the tag value.
All
14.4
  ✅ Server
WebHook.GetTimeOut
Queries the timeout for the hook.
All
12.0
  ✅ Server
WebHook.GetWebRequestCounter
Queries number of web requests created.
All
11.5
  ✅ Server
WebHook.List
Lists all web hook objects with their reference numbers.
All
11.5
  ✅ Server
WebHook.Listen
Starts listening for incoming requests on this port.
All
11.5
  ✅ Server
WebHook.Release
Releases the object and all memory used for it.
All
11.5
  ✅ Server
WebHook.SetAutoAnswer
Sets auto answer text.
All
11.5
  ✅ Server
WebHook.SetMaximumRequestSize
Sets maximum allowed request size.
All
12.1
  ✅ Server
WebHook.SetMode
Sets mode flags.
All
11.5
  ✅ Server
WebHook.SetSSL
Sets SSL certificate and key to use.
All
11.5
  ✅ Server
WebHook.SetScript
Sets the script to call when request was received.
All
11.5
  ❌ Server
WebHook.SetTag
Sets the tag value.
All
14.4
  ✅ Server
WebHook.SetTimeOut
Sets the timeout for the hook.
All
12.0
  ✅ Server
WebRequest.GetBody
Queries body for HTTP request.
All
11.5
  ✅ Server
WebRequest.GetBodyAsContainer
Queries body for HTTP request as container.
All
11.5
  ✅ Server
WebRequest.GetBodySize
Queries size of body in bytes.
All
12.1
  ✅ Server
WebRequest.GetHTTPMethod
Queries HTTP method for the request.
All
11.5
  ✅ Server
WebRequest.GetHTTPVersion
Queries HTTP method.
All
11.5
  ✅ Server
WebRequest.GetHeaders
Queries HTTP headers as JSON.
All
11.5
  ✅ Server
WebRequest.GetHost
Queries host name from HTTP headers.
All
11.5
  ✅ Server
WebRequest.GetLocalIP
Queries local IP for web hook.
All
11.5
  ✅ Server
WebRequest.GetLocalPort
Queries local port number
All
11.5
  ✅ Server
WebRequest.GetMode
Queries mode of request.
All
13.0
  ✅ Server
WebRequest.GetRawData
Get raw data of full request.
All
11.5
  ✅ Server
WebRequest.GetRemoteIP
Queries remote IP address.
All
11.5
  ✅ Server
WebRequest.GetRemotePort
Queries remote port number.
All
11.5
  ✅ Server
WebRequest.GetSSL
Whether this web request comes in with SSL.
All
11.5
  ✅ Server
WebRequest.GetSize
Queries size of whole request.
All
12.1
  ✅ Server
WebRequest.GetState
Queries the state of the web request.
All
12.0
  ✅ Server
WebRequest.GetTag
Queries the tag value.
All
14.4
  ✅ Server
WebRequest.GetURL
Queries HTTP URL received.
All
11.5
  ✅ Server
WebRequest.GetWebHook
Queries the web hook for this web request.
All
11.5
  ✅ Server
WebRequest.List
Lists all web request objects with their reference numbers.
All
11.5
  ✅ Server
WebRequest.Release
Releases the object and all memory used for it.
All
11.5
  ✅ Server
WebRequest.Send
Send custom answer.
All
11.5
  ✅ Server
WebRequest.SetTag
Sets the tag value.
All
14.4
  ✅ Server
WebRequest.URLComponents
Queries parsed URL components.
All
11.5
  ✅ Server

49 functions shown.

These functions require a license (55%).

Release notes

Blog Entries

Example Databases