Skip to content

Commit 64ab607

Browse files
authored
Merge pull request #7914 from camunda/webhook-xml
feat: webhook now supports XML strings
2 parents b06d2a0 + 2f9901d commit 64ab607

File tree

4 files changed

+40
-0
lines changed

4 files changed

+40
-0
lines changed

docs/components/connectors/protocol/http-webhook.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,16 @@ For example, if you want to set the message ID to the value of the `transactionI
128128
The **Message TTL** is an optional field that allows you to set the time-to-live (TTL) for the correlated messages. TTL defines the time for which the message is buffered in Zeebe before being correlated to the process instance (if it can't be correlated immediately).
129129
The value is specified as an ISO 8601 duration. For example, `PT1H` sets the TTL to one hour. Learn more about the TTL concept in Zeebe in the [message correlation guide](../../../concepts/messages#message-buffering).
130130
131+
### XML payloads
132+
133+
You can send XML to the webhook or return XML using the response expression, but XML content is treated as a plain string. It will not be parsed or extracted into process variables.
134+
135+
If you need to use correlation keys with XML payloads, send the correlation key in a request header and retrieve it using the **Correlation key (payload)** property. For example:
136+
137+
```feel
138+
=request.headers["x-correlation-id"]
139+
```
140+
131141
## Activate the HTTP Webhook connector by deploying your diagram
132142

133143
Once you click the **Deploy** button, your HTTP Webhook will be activated and publicly available.

versioned_docs/version-8.6/components/connectors/protocol/http-webhook.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,16 @@ For example, if you want to set the message ID to the value of the `transactionI
128128
The **Message TTL** is an optional field that allows you to set the time-to-live (TTL) for the correlated messages. TTL defines the time for which the message is buffered in Zeebe before being correlated to the process instance (if it can't be correlated immediately).
129129
The value is specified as an ISO 8601 duration. For example, `PT1H` sets the TTL to one hour. Learn more about the TTL concept in Zeebe in the [message correlation guide](../../../concepts/messages#message-buffering).
130130
131+
### XML payloads
132+
133+
You can send XML to the webhook or return XML using the response expression, but XML content is treated as a plain string. It will not be parsed or extracted into process variables.
134+
135+
If you need to use correlation keys with XML payloads, send the correlation key in a request header and retrieve it using the **Correlation key (payload)** property. For example:
136+
137+
```feel
138+
=request.headers["x-correlation-id"]
139+
```
140+
131141
## Activate the HTTP Webhook Connector by deploying your diagram
132142

133143
Once you click the **Deploy** button, your HTTP Webhook will be activated and publicly available.

versioned_docs/version-8.7/components/connectors/protocol/http-webhook.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,16 @@ For example, if you want to set the message ID to the value of the `transactionI
128128
The **Message TTL** is an optional field that allows you to set the time-to-live (TTL) for the correlated messages. TTL defines the time for which the message is buffered in Zeebe before being correlated to the process instance (if it can't be correlated immediately).
129129
The value is specified as an ISO 8601 duration. For example, `PT1H` sets the TTL to one hour. Learn more about the TTL concept in Zeebe in the [message correlation guide](../../../concepts/messages#message-buffering).
130130
131+
### XML payloads
132+
133+
You can send XML to the webhook or return XML using the response expression, but XML content is treated as a plain string. It will not be parsed or extracted into process variables.
134+
135+
If you need to use correlation keys with XML payloads, send the correlation key in a request header and retrieve it using the **Correlation key (payload)** property. For example:
136+
137+
```feel
138+
=request.headers["x-correlation-id"]
139+
```
140+
131141
## Activate the HTTP Webhook connector by deploying your diagram
132142

133143
Once you click the **Deploy** button, your HTTP Webhook will be activated and publicly available.

versioned_docs/version-8.8/components/connectors/protocol/http-webhook.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,16 @@ For example, if you want to set the message ID to the value of the `transactionI
128128
The **Message TTL** is an optional field that allows you to set the time-to-live (TTL) for the correlated messages. TTL defines the time for which the message is buffered in Zeebe before being correlated to the process instance (if it can't be correlated immediately).
129129
The value is specified as an ISO 8601 duration. For example, `PT1H` sets the TTL to one hour. Learn more about the TTL concept in Zeebe in the [message correlation guide](../../../concepts/messages#message-buffering).
130130
131+
### XML payloads
132+
133+
You can send XML to the webhook or return XML using the response expression, but XML content is treated as a plain string. It will not be parsed or extracted into process variables.
134+
135+
If you need to use correlation keys with XML payloads, send the correlation key in a request header and retrieve it using the **Correlation key (payload)** property. For example:
136+
137+
```feel
138+
=request.headers["x-correlation-id"]
139+
```
140+
131141
## Activate the HTTP Webhook connector by deploying your diagram
132142

133143
Once you click the **Deploy** button, your HTTP Webhook will be activated and publicly available.

0 commit comments

Comments
 (0)