HTTP Message Queue (Passive)

The HTTP Message Queue is a passive destination for retrieving messages from Flowlyze. Messages remain in the "New" state until they are requested through the queue endpoint.

Settings

Field	Description
Path	The final part of the endpoint used to request messages.
ApiKey	API key to include in the request for authentication.

Note: Settings cannot be overridden within the Flow.

Endpoints

The complete endpoints are available in the Destination section of Flowlyze.

1. Queue

Endpoint for retrieving messages from the queue.

Field	Value	Description
Method	GET	HTTP method used to make the request.
Resource Path	/api/message-queue/{tenant_id}/{path}	Endpoint path. {tenant_id} and {path} are dynamic parameters.
Query Params	is-acknowledged (bool)	Indicates whether an acknowledge call should be performed on the message. Default: false.
Query Params	max-items (int)	Maximum number of messages returned. Default: 10.
Headers	x-apikey (string)	API key defined in the destination configuration.

Additional Notes:

• Replace {tenant_id} and {path} with the correct values for the tenant and desired path.
• Always verify the validity of the API key (x-apikey) before making the request.

2. Acknowledge

Endpoint for confirming message processing.

Field	Value	Description
Method	POST	HTTP method used to perform the acknowledge.
Resource Path	/api/message-queue/{tenant_id}/{path}/acknowledge	Endpoint to execute the message acknowledge.
Headers	x-apikey (string)	API key defined in the destination configuration.
Body	JSON	Request body containing the message status.

Body Structure

{
    "isAsync": false,
    "messages": [
        {
            "msgId": "6785469c8046471646714630",
            "status": "Success",
            "errorMessage": ""
        }
    ]
}

Body Field Details

• isAsync (boolean) – If true, the update is performed asynchronously.
• messages (array) – List of messages to update.
• msgId (string) – Unique ID of the message.
• status (string) – Status of the message: "Success" or "Error".
• errorMessage (string) – Error message, present only if status is "Error".