Webhooks
Webhooks allow you to receive real-time notifications of events in your Dots account. You can track Payout Links, Flows, and Transfers by setting up webhooks, enabling your application to respond immediately to changes and updates.
Configuring Webhooks
Each Dots App has its own webhook authentication credentials, which include the Webhook App ID and Webhook Integration Key. To find the webhooks information for your App, follow the steps:
- Access the Dots dashboard.
- From the sidebar, choose the desired App from your list.
- Navigate to the API Management tab for the webhook authentication information.
You will find the Webhook App ID and Webhook Integration Key here.
Dots uses Svix to manage webhooks. To configure a new webhook endpoint for your App, follow the steps:
- Click on Manage Webhooks in the API Management tab to access the Svix dashboard, where you will find all configured webhooks. Each App you create in Dots will have a different dashboard on the Svix.
- Click on + Add Endpoint to add a new webhook.
- Provide a URL or use an endpoint generated by Svix. Optionally, add a description to define the purpose of the webhook.
- Select the event types to which the endpoint should be subscribed. If no event is selected, the webhook will register for all events.
- Optionally, enable a rate limit for the endpoint.
- Click Create.
A new endpoint will be created to group all information from the notification received.
Available events
When creating an endpoint on Svix, you can subscribe to a wide list of events to receive notifications. The following accordions list the available events and present webhook notifications examples:
app.updated
app.updated
Triggered when an App object is updated.
flow.transaction_updated
flow.transaction_updated
Triggered when ACH transaction details within a flow are updated.
flow.updated
flow.updated
Called when a flow has been updated due to a user completing steps.
payment_intent.updated
payment_intent.updated
Triggered when a payment intent object is updated.
payout_link.claimed
payout_link.claimed
Occurs when a payout link is claimed by a user.
payout_link.paid_out
payout_link.paid_out
Occurs when a user completes a payout through a payout link, either in full or partially.
payout_link.sent
payout_link.sent
Occurs when a payout link is sent out, whether via email, SMS, or direct link.
payout_link.updated
payout_link.updated
Triggered when there is a change in the status of a payout link.
payout_request.updated
payout_request.updated
Occurs when a payout request changes status.
refund.updated
refund.updated
Triggered when a refund object is updated.
transfer.completed
transfer.completed
Triggered when a transfer is completed. This is a terminal state. The complete transfer object will be included in the payload.
transfer.failed
transfer.failed
Triggered when a transfer fails. This is a terminal state. The complete transfer object will be included in the payload.
transfer.updated
transfer.updated
When there is a change to a transfer status.
user.updated.background_check
user.updated.background_check
Triggered when a user’s background check is completed.
user.updated.ide_verified
user.updated.ide_verified
Triggered when a user’s ID is verified.
user.updated.payout_method
user.updated.payout_method
Triggered when a user’s payout method is updated.