Webhooks let you subscribe to Square API events and receive notice when an event occurs. For more information about how to set up a webhook subscription, see Webhooks Overview.
Published when you link an external bank account to a Square account in the Seller Dashboard. Square sets the initial status to VERIFICATION_IN_PROGRESS and publishes the event.
For information about using the Bank Accounts API, see Bank Accounts API.
Subscribe to the following events to receive notifications for changes to custom attribute definitions and custom attributes that are owned by the subscribing application:
A custom attribute owned by your application was created or updated for a customer profile. A custom attribute is owned by the application that created the corresponding definition.
A custom attribute owned by your application was deleted from a customer profile. A custom attribute is owned by the application that created the corresponding definition.
Subscribe to the following events to receive notifications for changes to custom attribute definitions and custom attributes that are publicly visible:
The state of a dispute changed. This includes the dispute resolution (WON or LOST) reported by the bank. The event data includes details about what changed.
The state of a dispute changed. This includes the dispute resolution (WON or LOST) reported by the bank. The event data includes details about what changed.
Evidence was removed from a dispute from the Disputes Dashboard in the Seller Dashboard, in the Square Point of Sale application, or by calling DeleteDisputeEvidence.
Evidence was removed from a dispute from the Disputes Dashboard in the Seller Dashboard, in the Square Point of Sale application, or by calling DeleteDisputeEvidence.
Published when a loyalty account is created for a buyer. A loyalty account can be created using any of the following methods, which all publish this event:
An application calls the CreateLoyaltyAccount endpoint.
A buyer enrolls in the program from a Square Point of Sale application.
The seller enrolls a buyer using the Customer Directory.
The seller merges two customer accounts into one account using the Customer Directory. In this process, sellers might merge the two corresponding loyalty accounts by creating a new account and deleting the existing accounts.
Published for any updates to an existing loyalty account. For example:
The seller updates the phone number registered for the loyalty account using the Seller Dashboard. For more information,
see Square Loyalty FAQ.
Any change in the loyalty point balance, such as points added for visits, points expiration, or a manual adjustment to the point balance that a seller might perform.
The customer ID of the loyalty account changes. Perhaps the loyalty account moves to another customer.
Published when a loyalty account is deleted. The published event does not contain the customer_id that was associated with the deleted account.
The following actions to delete the account can publish this event:
The seller deletes an account using the Seller Dashboard.
The seller merges two customer accounts into one account using the Customer Directory. In this process, sellers might merge the two corresponding loyalty accounts by creating a new account and deleting the existing accounts.
Square Loyalty maintains a ledger of events that occur over the lifetime of a loyalty account. Square publishes notifications for each loyalty event logged to the ledger.
These loyalty events are immutable, which means they are never updated or deleted. For example, when a buyer redeems a reward and then returns it, Square publishes separate notifications for the corresponding CREATE_REWARD and DELETE_REWARD events. Similarly, Square publishes a notification for the ADJUST_POINTS event when points are deducted after a purchase that accrued points is refunded.