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:

Occurs when a payout link is claimed by a user.

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "link": "<string>",
  "amount": 123,
  "status": "created",
  "payee": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "delivery": {
    "method": "link",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "tax_exempt": true,
  "claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>"
}

Occurs when a user completes a payout through a payout link, either in full or partially.

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "link": "<string>",
  "amount": 123,
  "status": "created",
  "payee": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "delivery": {
    "method": "link",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "tax_exempt": true,
  "claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>"
}

Occurs when a payout link is sent out, whether via email, SMS, or direct link.

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "link": "<string>",
  "amount": 123,
  "status": "created",
  "payee": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "delivery": {
    "method": "link",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "tax_exempt": true,
  "claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>"
}

Triggered when a transfer is completed. This is a terminal state. The complete transfer object will be included in the payload.

{
"transfer": {
  "amount": 123,
  "created": "2023-11-07T05:31:56Z",
  "external_data": {
  "account_id": "<string>",
  "external_id": "<string>",
  "platform": "ach"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>",
  "status": "completed",
  "transactions": [
  {
    "amount": 123,
    "created": "2023-11-07T05:31:56Z",
    "destination_name": "<string>",
    "id": 123,
    "metadata": "<string>",
    "source_name": "<string>",
    "type": "balance"
  }
  ],
  "type": "refill",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Triggered when a transfer fails. This is a terminal state. The complete transfer object will be included in the payload.

{
"transfer": {
  "amount": 123,
  "created": "2023-11-07T05:31:56Z",
  "external_data": {
  "account_id": "<string>",
  "external_id": "<string>",
  "platform": "ach"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>",
  "status": "failed",
  "transactions": [
  {
    "amount": 123,
    "created": "2023-11-07T05:31:56Z",
    "destination_name": "<string>",
    "id": 123,
    "metadata": "<string>",
    "source_name": "<string>",
    "type": "balance"
  }
  ],
  "type": "refill",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Overview

Guides

References

Configuring Webhooks

Available events

Overview

Guides

References

​Configuring Webhooks

​Available events

Configuring Webhooks

Available events