HTTP Message Queue (Passiva)

La Http Message Queue è una destinazione passiva per richiedere i messaggi da Flowlyze. I messaggi rimangono nello stato "New" fino a quando non vengono richiesti tramite l’endpoint della coda.

Settings

Campo	Descrizione
Path	Parte finale dell'endpoint utilizzato per la richiesta dei messaggi.
ApiKey	Chiave API da inserire nella richiesta per l’autenticazione.

Nota: I settings non possono essere sovrascritti all’interno del Flow.

Endpoints

Gli endpoint completi sono disponibili nella sezione Destination di Flowlyze.

1. Queue

Endpoint per recuperare i messaggi dalla coda.

Campo	Valore	Descrizione
Method	GET	Metodo HTTP utilizzato per la richiesta.
Resource Path	/api/message-queue/{tenant_id}/{path}	Percorso dell’endpoint. tenant_id e path sono parametri dinamici.
Query Params	is-acknowledged (bool)	Indica se sul messaggio deve essere effettuata la chiamata di acknowledge. Default: false.
Query Params	max-items (int)	Numero massimo di messaggi restituiti. Default: 10.
Headers	x-apikey (string)	Chiave API definita nella configurazione della destinazione.

Note aggiuntive:

• Sostituire {tenant_id} e {path} con i valori corretti per il tenant e il percorso specifico.
• Verificare sempre la validità della chiave API (x-apikey) prima della richiesta.

2. Acknowledge

Endpoint per confermare l’elaborazione dei messaggi.

Campo	Valore	Descrizione
Method	POST	Metodo HTTP utilizzato per l’acknowledge.
Resource Path	/api/message-queue/{tenant_id}/{path}/acknowledge	Endpoint per eseguire l’acknowledge dei messaggi.
Headers	x-apikey (string)	Chiave API definita nella configurazione della destinazione.
Body	JSON	Corpo della richiesta contenente lo stato dei messaggi.

Struttura del Body

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

Dettagli campi del Body

• isAsync (boolean) – Se true, l’aggiornamento viene eseguito in modalità asincrona.
• messages (array) – Lista dei messaggi da aggiornare.
  • msgId (string) – ID univoco del messaggio.
  • status (string) – Stato del messaggio: "Success" o "Error".
  • errorMessage (string) – Messaggio di errore, presente solo se status è "Error".