Set up a webhook endpoint with WorkbenchBeta
This guide describes how to set up a webhook endpoint using Workbench.
Register a webhook endpoint with Workbench
To register a webhook endpoint in Workbench:
- Open Workbench in the Dashboard, then click the Webhooks tab.
- Click Register a new webhook endpoint.
- Select the API version for the events object you want to consume.
- If you’re using Connect, you can listen for Events on connected accounts. Otherwise, choose Events on your account.
- Select the event types that you want to send to a webhook endpoint, then click Continue.
- Provide the Endpoint URL for Stripe to send webhooks to and an optional description for the endpoint.
- Click Create destination to create your webhook endpoint.
Register a new webhook endpoint in the Webhooks tab
Configure an existing webhook endpoint
You can update or delete existing webhook endpoints in the Workbench Webhooks tab. You can also temporarily disable a registered webhook endpoint. Stripe won’t attempt to resend any events generated while the respective webhook endpoint is disabled. You can also manage webhook endpoints programmatically.
View event deliveries
To view event deliveries, select the webhook endpoint in Webhooks, then select the Event deliveries tab.
The Event deliveries tab provides a list of events and whether they’re Delivered
, Pending
, or Failed
. Click an event to view the Delivery attempts
, which includes the HTTP status code of previous delivery attempts and the time of pending future deliveries.
View event delivery attempts on a webhook endpoint’s Event deliveries tab.
Retry sending an event
In live mode, Stripe attempts to deliver a given event to your webhook endpoint for up to 3 days with an exponential back off. In the Event deliveries section of your webhook endpoint listed on Workbench, you can view when the next retry will occur.
In test mode, Stripe retries three times over a few hours. You can manually retry transmitting individual events to your webhook endpoint after this time using the Workbench Webhooks tab by navigating to the Event deliveries listed for your desired endpoint. You can also query for missed events to reconcile the data over any time period.
Retry sending events using a webhook endpoint’s Event deliveries tab.