Outgoing Webhooks

Outgoing Webhooks can be used to trigger actions in other applications based on specific events that occur within FlexDeploy. Traditional webhooks simply POST a json payload to a specified endpoint. While this functionality is a big use case, FlexDeploy offers the ability to execute any groovy script when the event occurs, called Listeners. For example, you can setup a Listener to upload failed plugin logs from a workflow execution to a separate server in addition to sending an email. The flexibility of groovy script and FlexDeploy’s model allows users to accomplish exactly what they need.

Outgoing Webhook Flow

In order to take advantage of FlexDeploy’s Outgoing Webhooks, you must first create a Listener. When creating this listener, you can specify on which event types the script will be executed. Once one of these events are executed, FlexDeploy will automatically notify any listeners corresponding with the event type.

Navigation

Outgoing Webhooks can be accessed from Administration → Outgoing Webhooks. This will show the Outgoing Webhook Messages that have been executed in FlexDeploy in the last week. You can click on any row to see more information about the webhook’s execution or resubmit the message for debugging.

Open

To configure Outgoing Webhooks, we can press the button in the top right. This will take us to the page that will show all the Webhook Listeners configured in FlexDeploy. You can create a new Webhook Listener by clicking the button on the page.

Open

Event Types

See Events page for list of events.

Related Articles

See more details about each webhook topic below:

• Webhook Context Variables and Methods Reference