HTTP Endpoint

<< Click to Display Table of Contents >>

Navigation:  Workflow Designer > Activities >

HTTP Endpoint

Previous pageReturn to chapter overviewNext page

Function

In gooflow, an HTTP endpoint is a type of trigger that initiates a workflow when a specific HTTP request is received. This is especially useful for creating workflows that need to react to web requests, such as APIs or webhooks.

 

Trigger mechanism: The HTTP endpoint acts as the trigger for the workflow. When a request is received that matches the defined criteria (such as path and HTTP method), the workflow is started.

Configuration: You can configure the HTTP endpoint with properties such as the endpoint path and the supported HTTP methods. For example, you can set the path to /hello-world and the method to GET.

Workflow execution: Once the workflow has been triggered, it can perform various actions. For example, it can return a response to the client.

 

Input

Parameter

Description

Example

Path

The endpoint to access the workflow.

helloWorld -> results in: https://app.gooflow.ch/[Mandant-id]/workflows/helloWorld

Supported Methods

Allowed HTTP Methods for this endpoint.


Authorize

Forces authorization, it is recommended to always set this.


Policy

A mechanism for enforcing security and access control for incoming HTTP requests. Gooflow allows you to define a policy that determines whether a request should be allowed or denied based on specific criteria.


Request Timout

Timespan until a request receives a timeout.


Request Size Limit

The maximal size of a request.


File Size Limit

The maximal size in Bytes for files.


Allowed File Extensions

Allowed file extensions, everything else will cause gooflow to send an error code. Leave empty to allow all (not recommended).


Blocked File Extensions

A blacklist for file extensions, leave empty to allow all extensions as specified above.


Allowed Mime Types

A whitelist for MIME types, leave empty to allow everything as specified by the two properties above.


Expose request too large Outcome

Allows gooflow to send the error code for too large requests.


Expose file too large Outcome

Allows gooflow to send the error code for too large files.


Expose invalid file extension Outcome

Allows gooflow to send the error code for wrong file extensions.


Expose Invalid File Mime Type Outcome

Allows gooflow to send the error code for wrong MIME types.


 

Output

Parameter

Description

Example

Parsed Content

Select a workflow variable to store the parsed content received by the endpoint. Should generally be of the type "Object".


Files

Select a workflow variable to store the parsed content received by the endpoint. Has to be of the type "FileArray".


Route Data

The RouteData parameter is used to capture route data from the incoming HTTP request.

This is especially useful when you have dynamic segments in your URL path, such as users/{userid}. With the RouteData parameter, you can extract these dynamic values and store them in a variable for further use within the workflow.

Query String Data

A workflow variable of type Object Dictionary into which the parameters of the query string are written.


Headers

A workflow variable of type Object Dictionary into which the header data is written.


Result

A workflow variable of type HTTP Request into which the response of the endpoint is written.