Skip to content

Commit d9b914d

Browse files
Add backlink to payout.confirmed from external payouts (#311)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 52b263f commit d9b914d

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

docs/partners/external-payouts.mdx

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This is the default payout mode for new programs. All partners are paid directly
2929
### Hybrid
3030

3131
Partners with connected bank accounts are paid directly by Dub, while all other partners
32-
with tenant IDs configured receive payouts via the `payout.confirmed` webhook event.
32+
with tenant IDs configured receive payouts via the [`payout.confirmed`](/docs/webhooks/events/payout-confirmed) webhook event.
3333

3434
This mode offers the best of both worlds:
3535

@@ -39,7 +39,7 @@ This mode offers the best of both worlds:
3939

4040
### External only
4141

42-
All payouts are processed through the `payout.confirmed` webhook event to your platform. Dub handles commission tracking and payout calculations, but you're responsible for the actual money transfer.
42+
All payouts are processed through the [`payout.confirmed`](/docs/webhooks/events/payout-confirmed) webhook event to your platform. Dub handles commission tracking and payout calculations, but you're responsible for the actual money transfer.
4343

4444
<Frame>
4545
<img
@@ -60,7 +60,7 @@ The external payout flow follows these steps:
6060
</Step>
6161

6262
<Step title="Webhook event sent">
63-
Once the payout is processed by Stripe, Dub sends a `payout.confirmed` webhook
63+
Once the payout is processed by Stripe, Dub sends a [`payout.confirmed`](/docs/webhooks/events/payout-confirmed) webhook
6464
event for each external payout.
6565
</Step>
6666

@@ -82,7 +82,7 @@ If the webhook fails after all retries, you'll need to manually process the payo
8282

8383
<Note>
8484
External payout modes require an active webhook subscribed to the
85-
`payout.confirmed` event. You'll be prompted to set one up if you haven't
85+
[`payout.confirmed`](/docs/webhooks/events/payout-confirmed) event. You'll be prompted to set one up if you haven't
8686
already.
8787
</Note>
8888

@@ -113,7 +113,7 @@ You can set the tenant ID when:
113113

114114
### 2. Set up webhook receiver
115115

116-
Create a webhook endpoint that listens for the `payout.confirmed` event. See our [webhook setup guide](/docs/webhooks/introduction) for detailed instructions.
116+
Create a webhook endpoint that listens for the [`payout.confirmed`](/docs/webhooks/events/payout-confirmed) event. See our [webhook setup guide](/docs/webhooks/introduction) for detailed instructions.
117117

118118
Your webhook endpoint should:
119119

@@ -164,14 +164,14 @@ export const POST = async (req: Request) => {
164164
After configuring your partners and webhook receiver, test the integration to ensure everything works correctly:
165165

166166
1. **Confirm a payout** in your Dub dashboard for a partner with a configured `tenantId`
167-
2. **Check your webhook receiver** to verify it received the `payout.confirmed` event
167+
2. **Check your webhook receiver** to verify it received the [`payout.confirmed`](/docs/webhooks/events/payout-confirmed) event
168168
3. **Verify the payout status** in your Dub dashboard shows as "completed" after your webhook returns a 2xx response
169169

170170
If the payout is marked as "completed", your external payout integration is working correctly. If it's marked as "failed", check the [troubleshooting section](#troubleshooting) below.
171171

172172
## Webhook payload
173173

174-
The `payout.confirmed` webhook event contains the following information:
174+
The [`payout.confirmed`](/docs/webhooks/events/payout-confirmed) webhook event contains the following information:
175175

176176
<CodeGroup>
177177
```json payout-confirmed.json
@@ -262,7 +262,7 @@ Log all webhook events for debugging and reconciliation.
262262
<AccordionGroup>
263263

264264
<Accordion title="Webhook not receiving events">
265-
- Verify your webhook is subscribed to the `payout.confirmed` event - Check
265+
- Verify your webhook is subscribed to the [`payout.confirmed`](/docs/webhooks/events/payout-confirmed) event - Check
266266
that your webhook URL is publicly accessible - Ensure your endpoint returns a
267267
2xx status code - Review webhook logs in your [webhook
268268
settings](https://app.dub.co/settings/webhooks)
@@ -284,6 +284,7 @@ Log all webhook events for debugging and reconciliation.
284284

285285
## Related resources
286286

287+
- [`payout.confirmed` webhook event](/docs/webhooks/events/payout-confirmed)
287288
- [Webhook setup guide](/docs/webhooks/introduction)
288289
- [Webhook event types](/docs/webhooks/event-types)
289290
- [Verifying webhook requests](/docs/webhooks/verify-webhook-requests)

0 commit comments

Comments
 (0)