Context Variables and Methods Reference

A number of context variables and methods are available for use in webhook provider match scripts and webhook function scripts. View suggestions while editing the match script or function editing windows by typing Ctrl + Space. These variables and methods are described below.

Context Variables

Name	Description
FLX_MESSAGE_ID	Unique id for the incoming webhook message
FLX_PRISTINE_PAYLOAD	Pristine (untouched) payload from the sender. Use this payload when generating hmac strings
FLX_REMOTE_ADDR	Remote address of the incoming request. If using a reverse proxy, this will be the address of the proxy, NOT the address of the original sender. A reverse proxy will typically pass the original sender address as a new header 'x-forwarded-for'.
FLX_REMOTE_HOST	Remote host of the incoming request. If using a reverse proxy, this will be the host of the proxy, NOT the host of the original sender.
HTTP_HEADERS	Map of the incoming request headers. See 'Accessing Map Values' below.
PAYLOAD	Map of incoming payload. See 'Accessing Map Values' below. If the webhook payload cannot be converted to JSON, it will be passed as a simple string
QUERY_PARAMS	Map of the incoming request query parameters. See 'Accessing Map Values' below.

Accessing Map Values

Map Values can be accessed a number of ways. Here are a few common ones:

HTTP_HEADERS['header-key-with-dash']
QUERY_PARAMS.paramWithNoDash
PAYLOAD.get('key')
PAYLOAD.field1.field2

Function Classes

Class	Description
FLEXDEPLOY	Functions for performing actions in FlexDeploy
HMAC	Functions for generating an hmac string
LOG	Functions for printing log messages
GITHUB	Functions for getting information from a GitHub payload
BITBUCKET	Functions for getting information from a Bitbucket payload
SLACK	Functions for getting information from a Slack payload