You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Developers creating apps for PaaS systemscan create a `webhooks.xml` file in the `etc` directory of their custom module. The XML file has the following structure:
44
+
On PaaS systems, you can create a `webhooks.xml` file in the `etc` directory of a custom module or in the Commerce `app/etc/webhooks.xml` file. The XML file has the following structure:
45
45
46
46
```tree
47
47
|__ config
@@ -120,15 +120,15 @@ Admin field | XML attribute | Description
120
120
--- | --- | ---
121
121
| **Name** | `header.name` | The header name, in the same form as it will be sent. For example, `Authorization`.
122
122
**Value** | - | The value of the header, such as `Bearer: <token>`.
123
-
**Active** | - |Set to **No** to remove the header from the request.
123
+
**Active** | header.remove | Set to **No** (SaaS) or `true` (PaaS) to remove the header from the request.
124
124
125
125
The `x-adobe-commerce-request-id` is added automatically to each request and is used to track the request in the system. You can filter logs by this ID to find all logs related to a specific request.
126
126
127
127
<InlineAlertvariant="info"slots="text"/>
128
128
129
129
Secrets and other sensitive data should not be stored in the `webhooks.xml` file. Instead, use environment or configuration variables to relay this information.
130
130
131
-
### Dynamic header resolvers
131
+
####Dynamic header resolvers
132
132
133
133
<Editionname="paas" />
134
134
@@ -180,9 +180,9 @@ Point to the `AddProductToCartResolver` class in the `header.resolver` attribute
180
180
181
181
The **Hook Rules** configuration panel or `rules` element allows you to define rules that trigger a webhook when certain conditions are met. [Create conditional webhooks](./conditional-webhooks.md) describes how to configure hook rules.
182
182
183
-
Field | Description
184
-
--- | ---
185
-
**Field** | The event field to be evaluated. For nested fields, use the dot-separated format, such as `data.order.product.id`.
186
-
**Value** | The value to be compared.
187
-
**Operator** | Defines which comparison operator to use. Examples include `equal`, `notEqual`, and `regex`.
188
-
**Active** | Set to **No** to remove the rule from the request.
183
+
Admin field | XML attribute | Description
184
+
--- | --- | ---
185
+
**Field** | `rule.field` | The event field to be evaluated. For nested fields, use the dot-separated format, such as `data.order.product.id`.
186
+
**Value** | `rule.value` | The value to be compared.
187
+
**Operator** | `rule.operator` | Defines which comparison operator to use. Examples include `equal`, `notEqual`, and `regex`.
188
+
**Active** | `rule.remove` | Set to **No** (SaaS) or `true` (PaaS) to remove the rule from the request.
0 commit comments