Skip to main content

Inbound webhook

The other system calls the engine. It gets its own address and shared secret.

Web↓ Inbound
Type codeWEBHOOK
Camel componentplatform-http
Formats carried
HL7 v2FHIR R4JSONXMLCSV
Set a shared secret before switching it on

The partner must send it in the X-Webhook-Secret header on every call. A call without it is refused. Give the secret to the partner privately.

The address you give the partner

It is /webhooks/connectors/<path> on this engine, using the Path you chose (letters, digits and dashes only).

Worked example​

Demo inbound webhook · Inbound · JSON · Test passes on any engine: Yes

The partner would POST to /webhooks/connectors/demo-orders. Set a shared secret before switching it on.

Values entered by Fill example
{
"direction": "Inbound",
"format": "JSON",
"settings": {
"path": "demo-orders"
}
}

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 🔒 (sharedSecret) 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.

SettingTypeRequiredDefaultWhat to enter
path
Path
textYes—Required. A short name you choose for this partner's door into the engine - e.g. portal-2-orders. It becomes the last part of the engine's address (/webhooks/connectors/<path>); you give that full address to the partner. Letters, digits and dashes only.
sharedSecret
Shared secret
passwordNo—🔒 secret. Required. A password only you and this partner know - press Generate. The partner sends it with every message (header X-Webhook-Secret); anything without it is refused. Give it to the partner privately.

What "Test connection" checks​

Nothing to reach - the partner calls us. The test checks the path is free and well-formed.

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.