Skip to main content
WEBHOOK
dispute_alert.created
{
  "api_version": "v1",
  "data": {
    "amount": 6.9,
    "charge_for_alert": true,
    "created_at": "2023-12-01T05:00:00.401Z",
    "dispute": {
      "amount": 6.9,
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "dspt_xxxxxxxxxxxxx",
      "reason": "Product Not Received"
    },
    "id": "dspa_xxxxxxxxxxxxx",
    "payment": {
      "card_last4": "4242",
      "created_at": "2023-12-01T05:00:00.401Z",
      "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
      "id": "pay_xxxxxxxxxxxxxx",
      "member": {
        "id": "<string>",
        "phone": "<string>"
      },
      "membership": {
        "id": "mem_xxxxxxxxxxxxxx"
      },
      "paid_at": "2023-12-01T05:00:00.401Z",
      "subtotal": 6.9,
      "total": 6.9,
      "usd_total": 6.9,
      "user": {
        "email": "john.doe@example.com",
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    },
    "transaction_date": "2023-12-01T05:00:00.401Z"
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "dispute_alert.created",
  "company_id": "biz_xxxxxxxxxxxxxx"
}

Headers

​
webhook-id
string
required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
webhook-signature
string
required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

​
webhook-timestamp
string
required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:

"1727606400"

Body

application/json
​
api_version
string
required

The API version for this webhook

Allowed value: "v1"
Example:

"v1"

​
data
object
required

A dispute alert represents an early warning notification from a payment processor about a potential dispute or chargeback.

​
id
string
required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
timestamp
string<date-time>
required

The timestamp in ISO 8601 format that the webhook was sent at on the server

Example:

"2025-01-01T00:00:00.000Z"

​
type
string
required

The webhook event type

Allowed value: "dispute_alert.created"
Example:

"dispute_alert.created"

​
company_id
string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

Return a 200 status to indicate that the data was received successfully