Skip to main content
WEBHOOK
dispute
{
  "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_timestamp": "2023-11-07T05:31:56Z",
  "is_livemode": true,
  "dispute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user": {
    "external_id": "<string>",
    "email": "<string>",
    "email_aliases": [
      "<string>"
    ]
  },
  "psp_dispute_id": "<string>"
}

Body

application/json

Sent once when a dispute is opened on an order. Currently only one subtype is possible:

  • OPENED - A dispute was registered for an order. Triggered on dispute creation only; subsequent status changes do not produce additional webhook events.

Delivery is configured using the Webhook dispute events toggle on the Settings page of the FunnelFox Billing dashboard.

​
event_type
enum<string>
required
Available options:
subscription,
oneoff,
order,
refund,
user,
dispute
​
event_id
string<uuid>
required
​
event_timestamp
string<date-time>
required
​
is_livemode
boolean
required
​
subtype
enum<string>
required
Available options:
opened
​
dispute_id
string<uuid>
required

FunnelFox internal dispute identifier

​
order_id
string<uuid>
required

FunnelFox order identifier the dispute belongs to

​
user
object
required
​
order
object

Full order details, including initial_order_metadata

​
psp_dispute_id
string | null

PSP-assigned dispute identifier (e.g. Primer's processorDisputeId)

​
processor
enum<string>

Underlying payment processor that issued the dispute

Available options:
stripe,
braintree,
paypal,
adyen,
checkout,
primer_processor
​
subscription
object
​
oneoff
object