Repository navigation
docs: add guide for webhooks created through the Admin API - #2659
Aydin Hassan (AydinHassan) wants to merge 5 commits into
Conversation
Developer Docs healthcheckStatus: Completed with |
📢 Developer Announcement RecommendationRecommendation: ❌ No Announcement Recommended No developer announcement signals were detected.
|
There was a problem hiding this comment.
🔵 Needs a closer look
A maintainer must confirm that Shopware 6.7.17.0 has been released before merging this release-dependent documentation.
2 open issues
What changed in this PR
Adds an Admin API webhook guide to the Shopware developer documentation, distinguishing user- and integration-owned webhooks from manifest-registered app webhooks.
Changes:
- Documents creation, ownership, permissions, role restrictions, and lifecycle rules.
- Covers target URL restrictions, payloads, and legacy webhook migration.
- Links the app webhook guide to the new guide.
| File | Description |
|---|---|
guides/plugins/apps/lifecycle/webhook.md |
Clarifies scope and links to Admin API webhooks. |
guides/development/integrations-api/webhooks.md |
Adds the Admin API webhook guide and migration guidance. |
Review effort: Balanced
I think this does warrant an announcement: specifically about auditing of legacy webhooks. Also, it could be there is a better place for this guide, i'm open for suggestions! |

Summary
Adds a guide for webhooks created through the Admin API by users and integrations: ownership, which events a webhook receives,
aclRoleIds, who can change or delete it, allowed URLs, the payload, and the "Legacy webhooks" migration. The app webhook guide links to it.Related links
ADR: https://github.com/shopware/shopware/blob/trunk/adr/2026-09-29-authorize-webhooks-against-their-owner.md
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.Dependent PRs
Notes
The Shopware changes are merged but only ship with 6.7.17.0, so the release box stays unticked: please merge this only once 6.7.17.0 is out.