Dispute created
The Dispute created trigger starts a workflow when a chargeback or inquiry dispute is created for an order in your store that uses Shopify Payments.
On this page
Data provided by the Dispute created trigger
The following data is provided to workflows that start with the Dispute created trigger.
| Data | Description |
|---|---|
dispute | The dispute that was created. Allows accessing data on the GraphQL Admin API ShopifyPaymentsDispute object |
Actions
This trigger provides a dispute, which lets you use any action that requires dispute information.
Because disputes relate to orders, the trigger can also be used with actions that require orders, such as:
- Add order line item
- Add order tags
- Archive order
- Cancel order
- Capture payment
- Hold fulfillment order
- Mark order as paid
Disputes also relate to customers, so it can be used with customer actions, such as:
- Add customer tags
- Remove customer metafield
- Remove customer tags
- Update customer metafield
- Update customer note
Disputes contain data about the order and transaction details. You can loop through related data and perform actions on each item by using a For each action.
Testing the trigger
To test an active workflow that starts with this trigger, you can:
- Use Shopify Payments in test mode and create a test dispute using the dispute credit card numbers from the payments test mode documentation.
- Create a test order with Shopify Payments, then initiate a dispute through your payment processor's test environment.
API details
The Dispute created trigger allows actions to be taken with the ShopifyPaymentsDispute GraphQL API object. This trigger corresponds to the disputes/create webhook.
Related triggers
For other payment and order-related workflows, you might also consider:
- Order transaction created - starts when a transaction on an order is created.
- Order created - starts when an order is placed.
- Order paid - starts when an order is paid.