craftcms / craftcms/commerce-stripe

Improve documentation on webhook configuration

Open Beginner friendly
#369 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

bug Craft Commerce → Stripe
Dominant language
PHP
Stars
33
Forks
51
PR merge metrics
No merged PRs in 30d

Description

Description

Similar to craftcms/commerce-stripe#368, the documentation on webhooks lacks a couple of important details.


Selecting all events as recommended results in Stripe showing a warning that this is inefficient:

Image

I don't want to have to beef up the server just to handle tons of webhooks requests that are irrelevant, and it does looks like there is a lot of events that we don't need.


After selecting all events, the next screen informs you that the selection requires two different payload types:

Image

If you proceed with this selection, you end up creating two endpoints with two separate signing keys. But you can only configure a single signing key in the plugin, so this doesn't work at all.

I assume you need to deselect everything that uses the thin payload style. But that's mostly guesswork.

Suggested fix

The README should maintain a list of which events, or at least which event categories, need to be selected for the integration.

Additional info
  • Craft CMS version: 5.9.20
  • Stripe for Craft Commerce version: 5.6.2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the README and review the webhook configuration guidance for Craft CMS 5.9.20, Stripe for Craft Commerce 5.6.2, and the related commerce-stripe#368 issue. Document the required event categories, identify events that use thin payloads, and explain how to configure one compatible endpoint and signing key without selecting irrelevant events.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation, payments
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.