Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Webhook Functions are groovy scripts defining what to do which are executed when a webhook is received by FlexDeploy. Incoming webhook messages are matched to a Function first by matching to a provider, then by the Function's URI. Each webhook provider may have multiple functions associated with it. Functions, and multiple Functions may be executed for one incoming message, though the order of execution is indeterminate.

Viewing Webhook Functions

Access functions by navigating to Administration → Integrations → Incoming Webhooks.{{screenshot of demo}}

...

Creating/Editing Webhook Functions

To create a new functionFunction, click the Image Removed Image Added button. To view or edit a functionFunction, click on the name of the functionFunction.

Field

Description

Name

The name of the function

Description

The description for the function

Provider

Provider the function is for

Uri

Path webhook will be sent (appended to /flexdeploy/webhooks/v1)

Active

Whether or not the function is active (Defaults to Yes)

Groovy Script

The Groovy script

...

for the Function will be executed when a webhook is received at the listed

...

URI that has been matched to the selected Provider. The editing window has capabilities for undo, redo, find, find and replace, and go to line. There are a variety of

...

context variables and methods available to use in this script. Type Ctrl + Space in the editor for suggestions on variables and methods that can be used.

...

Examples

See more examples of Functions on our Sample Implementations page.

...