Webhooks

Dispute

Notification kindsAnchorIcon

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The $webhookNotification->kind for Dispute webhooks will be one of the following:

  • BraintreeWebhookNotification::DISPUTEACCEPTED
  • BraintreeWebhookNotification::DISPUTEAUTOACCEPTED
  • BraintreeWebhookNotification::DISPUTEDISPUTED
  • BraintreeWebhookNotification::DISPUTEEXPIRED
  • BraintreeWebhookNotification::DISPUTELOST
  • BraintreeWebhookNotification::DISPUTEOPENED
  • BraintreeWebhookNotification::DISPUTEUNDERREVIEW
  • BraintreeWebhookNotification::DISPUTEWON

The following table describes the conditions that trigger each kind of webhook.

Notification TypeDescription
dispute_accepted

A dispute is accepted.

dispute_auto_accepted

A dispute is automatically accepted.

dispute_disputed

A dispute is disputed.

dispute_expired

A dispute is expired.

dispute_lost

A dispute is lost.

dispute_opened

A dispute is opened.

dispute_under_review

A dispute is under internal review with PayPal.

dispute_won

A dispute is won.

AttributesAnchorIcon

kindenum
The kind of webhook notification.
timestampdate
The UTC time at which the webhook was triggered.
disputeobject

A `Dispute` object.

transactionDetails
Deprecated. Please use transaction on the Dispute object instead.