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 |
---|---|
Functions for performing actions in FlexDeploy | |
Functions for generating an HMAC string | |
Functions for printing log messages | |
Functions for getting information from a GitHub payload | |
Functions for getting information from a Bitbucket payload | |
Utility functions for interacting with Slack | |
Functions for getting information from a GitLab payload | |
Functions for getting information from a Bitbucket Server payload | |
Functions for getting information from an Azure Git payload | |
Functions for receiving Approvals from Teams | |
Functions for formatting and sending emails | |
Functions for getting files Salesforce Org and commiting to Git. |
Function Classes (Outgoing Webhooks)
Class | Description |
---|---|
Functions for performing actions in FlexDeploy | |
Functions for formatting and sending emails | |
Functions for printing log messages | |
Object exposing REST functions. For more info see Using the REST object. | |
Functions for formatting and sending Teams messages | |
Functions for formatting and sending Slack messages |
FLEXDEPLOY Function Incompatible Changes for 6.0
Removed Methods
# ChangeManagementSystemService object is no longer available
ChangeManagementSystemService FLEXDEPLOY.getCMSService(Long pCMSInstanceId)
ChangeManagementSystemService FLEXDEPLOY.findCMSService(String pCode, String pName)
Replaced by following methods
ChangeManagementSystem FLEXDEPLOY.getChangeManagementSystemByInstanceCode(String pInstanceCode)
ChangeManagementSystem FLEXDEPLOY.getChangeManagementSystemByInstanceName(String pInstanceName)
CMSObject FLEXDEPLOY.createIncidentForWorklowRequest(Long pWorkflowRequestId, Map<String, Serializable> pIncidentFields, String pCMSInstanceCode, String pCMSInstanceName)
CMSObject FLEXDEPLOY.createIncidentByWorkflowType(Long pWorkflowRequestId, Map<String, Serializable> pIncidentFields)
ChangeManagementSystem FLEXDEPLOY.getChangeManagementSystemByInstanceId(Long pCMSInstanceId)
- style