Webhook Providers
Webhooks can provide integration between FlexDeploy and source control, change management, issue tracking, or any application with support for outgoing webhooks. You have complete control over which applications you would like configured with webhooks. See our Sample Implementations for examples of some common providers.
Viewing Webhook Providers
Access providers by first navigating from the menu to Administration → Incoming Webhooks and then clicking the Configuration button in the top right of the page.
Provider Actions
You can change the order of Providers by dragging and dropping the sort icon on a row. Sort can only be done if there is no filter and no rows are expanded.
Selecting the icons in the Active column will activate/inactivate the Provider in that row.
In the context menu in the Actions column, you can edit the Provider, create a Function for the Provider, copy the Provider’s Id, and delete the Provider.
Creating/Editing Webhook Providers
To create a new provider, click the create provider button at the top right of the table. To view or edit an existing provider, click on the name of the provider or access the context menu in the Actions column.
Field | Description |
|---|---|
Name | The name of the provider |
Description | An optional description for the provider |
Active | Whether this provider is active |
Provider Matching
Each provider has a Groovy match script, which should verify an incoming webhook is from its provider and return true or false. The script may validate an incoming webhook by a signature or secret set in the provider application, or with other authentication methods.
When a webhook is received, each match script is executed in order of providers until a script returns true, meaning a match is found first. Higher-priority providers should be closer to the top for better performance.
Warning
While the provider match scripts do offer some level of verification and security, they should not be solely relied upon to prevent unwanted incoming requests. See how to secure your webhooks.
There are a variety of context variables and methods available to use in this script. Type Ctrl + Space for suggestions on available variables and methods.
Provider Properties
Properties, like signature or secret, can be defined and used in both the match script and the scripts for all functions belonging to the provider. You can toggle between Properties and the Match Script with the 2 tabs.
Field | Required | Description |
|---|---|---|
Name | Yes | Name of the property that will be used within the scripts to reference its value. |
Encrypted | No | If false, property expects a String value, otherwise it expects a credential. |
Value | Yes | Value that will be used when the property is referenced within a script. Expects a String as default. If the property is encrypted, expects a credential. |
Actions |
| Context menu where you can edit and delete the property. |
- style