Add Admin configuraiton details #152
Conversation
keharper
added
editorial
Co-authored-by: Jared Hoover <98363870+jhadobe@users.noreply.github.com>
| **Active** | Indicates whether to skip a removed hook during the batch execution. | ||
| **Method** | The HTTP method (POST, PUT, GET, or DELETE) used to invoke the hook. | ||
|
|
||
| ### Configure hook fields |
There was a problem hiding this comment.
One idea from Sasha was to show screenshots of each of the fields/headers/rules section. For fields though, there is already a screenshot later in the Edit an existing hook section, but it's for the case when there are xml-defined hook fields that can't be edited
There was a problem hiding this comment.
I decided against adding screenshots for the bottom half of the configuration screen. The UI is repetitive and I don't think adding the screenshots really adds anything.
|
|
||
| <InlineAlert variant="warning" slots="text" /> | ||
|
|
||
| On Cloud instances, due to the read-only file system, the `webhooks:generate:module` command cannot be run. If a plugin-type webhook is added through the Admin, the method name and type should be declared in a `webhooks.xml` file so that the required plugin is generated during the build phase of the deployment process. | ||
| If the plugin for the webhook method and type entered into the form have not been generated for the Commerce instance, a warning to run the `webhooks:generate:module` command will appear upon clicking **Save**. You cannot run the `webhooks:generate:module` command on Cloud instances, due to its read-only file system. If you add a plugin-type webhook through the Admin, declare the method name and type in a `webhooks.xml` file. |
There was a problem hiding this comment.
We could consider just adding a mention of deploying after declaring the method name and type in a webhooks.xml file since it's during the deployment process that the needed plugin class would get generated
There was a problem hiding this comment.
We decided to leave this as-is. I added a statement to the events and webhooks generate:module commands stating they're for on-premises only,
Purpose of this pull request
This pull request (PR) adds details to the Admin configuration topic, created in #147. I also discovered some omissions from when conditional webhooks were introductions. This PR also contains some miscellaneous cleanup.
Affected pages
Links to Magento Open Source code