Flowingly's webhooks are automated messages that are sent to external services when a step is either created or completed. The format of the webhook message is JSON and the request is done as an HTTP POST request.

When a webhook is enabled on a step, you can get Flowingly talking to other systems. For example, when a step is completed a Microsoft Teams message is sent out.

Webhooks is a paid add-on and is not turned on by default. Please contact Flowingly Customer Success or Support if you'd like to give it a try.

To add a webhook, select the step that you want to add the webhook to and click on Integration (beta) then Add webhook.

Configure the webhook:

  • Enable it

  • Giving it a Name e.g. Send Customer Data

  • Give it a Description (optional)

  • Add an Endpoint URL i.e. the service you would like to send the step data to

  • Add a Trigger

  • Select Authentication type

Steps that have a webhook will have the webhook icon on them:

Save the webhook and publish your flow model as a workflow.

When a flow is running, on completed steps with a webhook you should see the status of the webhook:

Triggers

Type

Description

When the step is completed

The current step's data is sent out via the webhook when the step is submitted

When the step is created

The previous step's data is sent out via the webhook. The previous step will have to be either:

  1. Another step

  2. Approval step

  3. Parallel approval step

  4. Sequential approval step

  5. Public form (public or intranet)

*Please note: Previous step data in a webhook message will only be populated for webhooks with a step creation trigger.

Authentication options

Type

Description

None

This is the default authentication type when adding a new webhook to a step.

No authentication is applied when sending the message to the webhook endpoint.

Client Secret

This is a simple way of asserting the message has come from Flowingly.

When this type of authentication is selected you are required to enter a client secret. The client secret is a free text field with a limit of 250 characters.

The configured secret is then included in the message Flowingly sends to the endpoint.

Basic

When this type of authentication is selected you are require to enter a username and password.

The username and password fields are free text with a limit of 100 characters each.

The configured username and password is then included in the HTTP header of the webhook message Flowingly sends to the endpoint.

  • HTTP Header: authorization

  • Scheme: basic

  • Parameter: base64 encoded username:password

Please note: If using this authentication method, please ensure that you use HTTPS/TLS tp protect sensitive data.

Did this answer your question?