Skip to content

Commit 834f1ce

Browse files
Add detailed Stripe webhook and OAuth setup documentation (#2969)
Fixes #2969 ### Summary The existing Stripe documentation covered API keys and basic setup, but it was missing clear instructions for configuring webhooks and OAuth. ### Changes made - Added step-by-step guide for creating Stripe webhooks - Included required events needed for proper integration - Documented how to retrieve and use the webhook signing secret - Added explanation for setting up Stripe OAuth - Listed required redirect URIs for both local and production environments ### Why this change Without proper documentation, setting up Stripe can be confusing and requires trial and error. These additions aim to make the setup process more straightforward and easier to follow. ### Additional notes - The new content was added to the existing documentation without altering the current structure - Kept the format consistent with the rest of the file for readability
1 parent 3d3f5f5 commit 834f1ce

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

doc/user/payments/stripe.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,60 @@ Again, you can choose between live mode and test mode here.
3232

3333
.. _stripe.com: https://dashboard.stripe.com/register
3434
.. _test cards: https://stripe.com/docs/testing#cards
35+
36+
Stripe Webhook Configuration (Detailed)
37+
38+
To ensure proper communication between Stripe and Eventyay, webhooks need to be configured correctly.
39+
40+
1. Go to the Stripe Dashboard
41+
2. Navigate to Developers → Webhooks
42+
3. Click on "Add endpoint"
43+
44+
In the "URL to be called" field, enter the webhook URL provided in Eventyay (usually found in the payment settings section).
45+
46+
Select the following events:
47+
- payment_intent.succeeded
48+
- payment_intent.payment_failed
49+
- charge.refunded
50+
- checkout.session.completed
51+
52+
After creating the webhook, click on it and copy the "Signing secret". This secret should be added to Eventyay in the Stripe settings to verify incoming webhook requests.
53+
54+
---
55+
56+
Stripe OAuth Configuration
57+
58+
Stripe OAuth allows users to connect their Stripe accounts directly with Eventyay.
59+
60+
1. Go to Stripe Dashboard
61+
2. Navigate to Settings → Connect Settings
62+
3. Enable Stripe Connect if not already enabled
63+
64+
You will need the following credentials:
65+
- Client ID
66+
- Publishable Key
67+
- Secret Key
68+
69+
These credentials can be entered in the Eventyay payment settings.
70+
71+
---
72+
73+
Redirect URIs
74+
75+
Make sure the following redirect URI is configured in your Stripe application:
76+
77+
/_stripe/oauth_return/
78+
79+
For local development, you may need to use:
80+
http://localhost:8000/_stripe/oauth_return/
81+
82+
For production:
83+
https://your-domain.com/_stripe/oauth_return/
84+
85+
---
86+
87+
Notes
88+
89+
- Ensure you are using the correct mode (test or live) while configuring keys and webhooks.
90+
- Test mode should be used during development.
91+
- Live mode should only be used in production environments.

0 commit comments

Comments
 (0)