Notification kinds

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

  • WebhookNotification.Kind.DISPUTE_OPENED
  • WebhookNotification.Kind.DISPUTE_LOST
  • WebhookNotification.Kind.DISPUTE_WON
  • WebhookNotification.Kind.DISPUTE_ACCEPTED
  • WebhookNotification.Kind.DISPUTE_EXPIRED
  • WebhookNotification.Kind.DISPUTE_DISPUTED

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

Notification Type Description
dispute_opened

A dispute is opened.

dispute_won

A dispute is won.

dispute_lost

A dispute is lost.

dispute_accepted

A dispute is accepted.

dispute_expired

A dispute is expired.

dispute_disputed

A dispute is disputed.

Attributes

getKind() enum

The kind of webhook notification.

getTimestamp() date

The UTC time at which the webhook was triggered.

getDispute() object

A Dispute object.

getTransactionDetails()

Deprecated. Please use transaction on the Dispute object instead.