Web Hooks

See See Topic: WebHooks for general information or Interface: WebHooks for UI help.

Event ✎

The event to trigger on, for example "Operation Completed".

See Topic: WebHooks.

Url ✎

The URL that will be called when the event occurs. This must be reachable from the server that the API is located on.

Payload ✎

The content of the message. If not customized this will contain a JSON structure with the base data of the event.

See Topic: WebHooks.

Formatter ✎

See Topic: WebHooks.

Count ✎

Read-only

The number of times this webhook has triggered.

Headers ✎

The HTTP headers that should be included with the request. This may contain authorization headers, cookies or other data.

Rules ✎

If the webhook should not send data on every occurence, rules may be applied to filter down to the required events.

See Topic: WebHooks.

Description ✎

Descriptive text on how this webhook is used

Enabled ✎

Enable or disable the webhook. Disabling the webhook will also stop processing of already queued messages.