Webhook Context Variables and Methods Reference

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

Incoming 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.

Outgoing Context Variables

Name	Description
EVENT	The Event payload for the Outgoing Webhook. For more information see Events

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')
EVENT.payload.workflowExecutionId

Function Classes (Incoming Webhooks)

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	Utility functions for interacting with Slack
GITLAB	Functions for getting information from a GitLab payload
BITBUCKET_SERVER	Functions for getting information from a Bitbucket Server payload
AZURE	Functions for getting information from an Azure Git payload. Available @since 5.4.0.4

Function Classes (Outgoing Webhooks)

Class	Description
FLEXDEPLOY	Functions for performing actions in FlexDeploy
EMAIL	Functions for formatting and sending emails
LOG	Functions for printing log messages
REST	Object exposing REST functions. For more info see Using the REST object.
MICROSOFTTEAMS	Functions for formatting and sending Teams messages
SLACK	Functions for formatting and sending Slack messages