Custom Payloads API

Mon, 01 Jan 0001 00:00:00 +0000

The following views are available via the API:

customPayloads(category): Lists all the payloads currently loaded (category, payload, enabled state). Optionally filtered by category.
customPayloadsCategories: Lists all the available categories.

addCustomPayload (category*, payload): Adds a custom payload (enabled when added).
disableCustomPayloads(category): Disables custom payloads. Optionally limited by category. (No category means all)
enableCustomPayloads(category): Enables custom payloads. Optionally limited by category. (No category means all)
enableCustomPayload (category*, payload): Enables a custom payload.
disableCustomPayload (category*, payload): Disables a custom payload.
removeCustomPayload (category*, payload): Removes a custom payload.

Note: * Required parameter.

Options Custom Payloads screen

Mon, 01 Jan 0001 00:00:00 +0000

This screen/table allows you to configure Custom Payload options:

A checkbox indicating whether or not the particular custom payload is to be used or not.