Webhook Authentication

Default Behaviour

By default, requests to execute a webhook do not need to be authenticated. The knowledge of the specific flow’s ID and the corresponding webhook URL is assumed to be sufficient authorization. Of course, this means that the webhook URL should be treated as sensitive information and not be freely exposed.

Enabling Authentication

In cases where additional security is desired, templates and flows can be set to require authentication on webhook requests. This can be set in the Template Editor for templates of the type “Incoming Webhook”, here:

In the template’s and flow’s JSON representation, this corresponds to the property flowSettings.webhooks.requireWebhookAuth :

{
	"description": "Authenticated Flow",
	"graph": { ... },
	"flowSettings": {
	  "webhooks": {
      "requireWebhookAuth": true
    }
  }
}

Authenticated Behavior

If a flow is set to require webhook auth, all webhook requests must be authenticated using a valid Bearer token in the Authorization header, in the same manner as all other Flowmate API requests. This flow can only be executed by these accounts:

• The end-user who created and owns the flow

• Any tenant-admin partner account of the same tenant as that end-user

If no bearer token is supplied, or any other account attempts to execute the flow, the API will respond with a code 403 and the response body

{ "error": "Unauthorized" }