HTTP / REST API
Send to, or poll, any HTTP endpoint - JSON, XML, HL7 or FHIR in the body.
Web↓ Inbound↑ OutboundHTTP_RESTcamel-httpHL7 - Health Level Seven - the standard family for exchanging healthcare messages · FHIR - Fast Healthcare Interoperability Resources - a modern web API standard for health data · REST - a common style of web API using plain HTTP · API - application programming interface
See the Glossary for every term.
Even when Method is POST or PUT, the test sends a GET (to the health path, or to the URL itself) and never a POST, so it cannot create anything on the other side.
Worked example
Demo REST endpoint (this engine) · Outbound · JSON · Test passes on any engine: Yes
Points at this engine itself, only so Test has something real to reach. Use the partner's URL for real.
{
"direction": "Outbound",
"format": "JSON",
"settings": {
"url": "http://localhost:8080",
"method": "POST",
"auth": "NONE",
"healthPath": "/",
"pollSeconds": "60"
}
}
This is what the console's Fill example button enters. Secrets are never part of an example. Every setting is explained below.
Settings
Required fields are marked Yes. Fields marked 🔒 (password, token, apiKey) are stored encrypted and never sent back to the browser - the console only shows Set / Not set. A field marked inbound only or outbound only appears just for that direction.
| Setting | Type | Required | Default | What to enter |
|---|---|---|---|---|
urlURL | text | Yes | https:// | Required: the full address messages go to (or are read from), e.g. https://portal2.example.org/fhir/R4/Bundle. |
methodMethod | select | Yes | POST | POST - send a new message (usual for orders and results) · PUT - send to replace an existing one · GET - read from it every N seconds (polling). The test always uses GET. Options: POST, PUT, GET. |
authAuthentication | select | Yes | NONE | Only the fields for the chosen type are shown. All four work for sending. Options: NONE, BASIC, BEARER, API_KEY. |
usernameUsername | text | No | — | Required for Basic: the account name the receiver gave you, e.g. xellabs-engine. |
passwordPassword | password | No | — | 🔒 secret. Required for Basic: that account's password. Stored encrypted; shown only as Set / Not set. |
tokenBearer token | password | No | — | 🔒 secret. Required for Bearer: the token the receiver issued, sent as Authorization: Bearer <token>. |
apiKeyHeaderAPI key header | text | No | X-API-Key | The header name the receiver reads the key from, e.g. X-API-Key. |
apiKeyAPI key | password | No | — | 🔒 secret. Required for API key: the key the receiver issued. Stored encrypted. |
healthPathHealth check path | text | No | — | Optional: a path Test connection reads, e.g. /health. Blank tests the URL itself with a GET. |
pollSecondsPoll every (seconds) | number | No | 60 | How often to read the URL, e.g. 60 (seconds). GET only. |
What "Test connection" checks
The address answers and the credential is accepted, by a GET on the health path. Never a POST.
Test connection is read-only and says how far it got: verified, reached, checked or failed. See Testing a connection, and Troubleshooting if it fails.