> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/mqtt/receive.md). # Receive Task version: 1.1.0 Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Host : `String` |

The address of the MQTT broker.


Default: -
Example: broker\_host

| | BrokerPort : `Int32` |

The port of the MQTT broker.


Default: -
Example: 1883

| | ReceivingTime : `Int32` |

Specifies how many seconds the task (client) will live and process messages.


Default: -
Example: 10

| | ClientId : `String` |

The client (session) identificator. This will allow to collect messages from an existing session


Default: -
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

| | Topic : `String` |

The topic the client subscribes to when connecting.


Default: -
Example: example topic

| | UseTls12 : `Boolean` |

Whether to use TLS authentication.


Default: -
Example: false

| | QoS : `QoS` |

The Quality of Service (QoS) level for the MQTT session.

Possible values:


Default: -
Example: QoS.AtMostOnce

| | Username : `String` |

Username for authentication.


Default: -
Example: testuser

| | 🗝Password : `String` |

Password for authentication.


Default: -
Example: Password123

| | AllowInvalidCertificate : `Boolean` |

When true, allows connections even if the server's TLS certificate is invalid (e.g., self-signed,

expired, or hostname mismatch). WARNING: This reduces security and should only be used in

development/testing environments or when connecting to internal servers with self-signed certificates.


Default: -
Example: true

| | {% endtab %} | | {% tab title="Options" %} | Name | Description | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | ThrowErrorOnFailure : `Boolean` |

Whether to throw an error on failure.


Default: True
Example: true

| | ErrorMessageOnFailure : `String` |

Overrides the error message on failure.


Default: -
Example: MQTT connection failed: broker unreachable

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Whether connection to the MQTT broker was successful or not.
Example: true

| | Error : `String` |

Error(s) if connecting to broker failed. Returns an empty string if no errors exist.
Example: Connection refused

| | MessagesList : `ConcurrentQueue` |

All messages received from the broker in this session.
Example: \["message1", "message2"]

| | CurrentClientId : `String` |

The MQTT client ID. Used to restore a previously opened session to receive buffered messages. When making a new connection, pass it to receive buffered messages.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

| ## Task Changelog Changelog for Task Frends.MQTT.Receive. ### \[1.1.0] - 2026-08-17 #### Added * Added an `Options` parameter to control error handling: use `ThrowErrorOnFailure` to throw on failure, or set it to `false` to receive the error details in the result instead. ### \[1.0.0] - 2025-04-07 #### Added * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.frends.com/tasks/tasks/mqtt/receive.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.