Webhooks

V2 Webhook Events Technical Reference

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.

Bank Accounts API

Event	Description
bank_account.disabled	Published when Square sets the status of a bank account to DISABLED.
bank_account.verified	Published when Square sets the status of a bank account to VERIFIED.
bank_account.created	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.

Bookings API

Event	Description
booking.created	A booking is created by calling CreateBooking.
booking.updated	An API-created booking is updated in the Seller Dashboard, on the seller's online booking site, or by calling UpdateBooking.

For more information about booking events, see Handle Booking Event Notifications with Webhooks. For information about using the Bookings API, see Manage Bookings for Square Sellers.

Cards API

Event	Description
card.automatically_updated	Published when card expiration information or pan is automatically updated.
card.created	Published when a card is created or imported.
card.disabled	Published when a card is disabled.
card.forgotten	Published when a card is GDPR forgotten/vaulted.
card.updated	Published when a card is updated by the developer using the `UpdateCard` endpoint.

For information about using the Cards API, see Cards API Overview.

Catalog API

Event	Description
catalog.version.updated	The catalog was updated. Webhook notification data is packaged as `"catalog_version": { "updated_at": "2019-05-14T17:51:27Z"}`.

For more information about catalog events, see Webhooks. For information about using the Catalog API, see What It Does.

Customers API

Event	Description
customer.created	A customer profile is created, including when customer profiles are merged into a new customer profile.
customer.deleted	A customer profile is deleted, including when customer profiles are merged into a new customer profile.
customer.updated	An attribute on a customer profile is changed, except for the following: `cards` (deprecated) `segment_ids`

For more information about customer events, see Use Customer Webhooks. For information about using the Customers API, see Manage Customers and Integrate with Other Services.

Devices API

Event	Description
device.code.paired	A Square Terminal has been paired with a Terminal API client and the `device_id` of the paired Square Terminal is available.

For information about using the Devices API, see Connect a Square Terminal.

Disputes API

Event	Description
dispute.created	A dispute was created.
dispute.state.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.
dispute.evidence.added	Evidence was added to a dispute from the Disputes Dashboard in the Seller Dashboard, in the Square Point of Sale application, or by calling the Disputes API (CreateDisputeEvidenceFile or CreateDisputeEvidenceText).
dispute.evidence.deleted	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.

For more information about dispute events, see Disputes webhook notifications. For information about using the Disputes API, see Disputes Overview.

Gift Cards API

Event	Description
gift_card.created	A gift card was created.
gift_card.updated	A gift card was updated. The attributes on a gift card that can be updated are `balance_money`, `state`, and `customer_ids`.
gift_card.customer_linked	A customer is linked to a gift card.
gift_card.customer_unlinked	A customer is unlinked from a gift card.
gift_card.activity.created	A gift card activity was created.

For more information about gift card events, see Gift Cards API Webhooks. For information about using the Gift Cards API, see Gift Cards API Overview.

Inventory API

Event	Description
inventory.count.updated	The quantity was updated for a catalog item variation. Webhook notification data is packaged as InventoryCount[].

For information about using the Inventory API, see What It Does.

Invoices API

Event	Description
invoice.created	A draft invoice was created.
invoice.published	An invoice was published. This also applies to invoices that are published but scheduled to be processed at a later time.
invoice.updated	An invoice has changed.
invoice.payment_made	A payment was made for an invoice.
invoice.scheduled_charge_failed	A scheduled charge has failed.
invoice.canceled	An invoice was canceled.
invoice.refunded	A refund was processed for an invoice.
invoice.deleted	An invoice was deleted.

For information about using the Invoices API, see Manage Invoices Using the Invoices API.

Labor API

Event	Description
labor.shift.created	A worker started a shift. Webhook notification data is packaged as a Shift.
labor.shift.updated	A shift was updated. Typically a break was started or ended or a worker ended the shift. Webhook notification data is packaged as a Shift.
labor.shift.deleted	A shift was deleted. Notification data includes the deleted shift ID and the `isDeleted` flag.

For information about using the Labor API, see Labor API.

Locations API

Event	Description
location.created	A Location was created.
location.updated	A Location was updated.

For information about using the Locations API, see Locations API.

Loyalty API

Event	Description
loyalty.account.created	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.
loyalty.account.updated	Published for any updates to an existing loyalty account. For example: The seller updates the phone number associated with a 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.
loyalty.account.deleted	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.
loyalty.program.created	Published when a loyalty program is created using the Seller Dashboard.
loyalty.program.updated	Published when a loyalty program is updated using the Seller Dashboard.
loyalty.event.created	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.

For information about using the Loyalty API, see Manage Loyalty Accounts Using the Loyalty API.

OAuth API

Event	Description
oauth.authorization.revoked	A webhook for notifying an application whenever a seller revokes all access tokens and refresh tokens granted to the application.

For information about using the OAuth API, see OAuth Overview.

Orders API

Event	Description
order.created	An Order was created. This event is triggered only by the CreateOrder endpoint call.
order.fulfillment.updated	An OrderFulfillment was created or updated. This event is triggered only by the UpdateOrder endpoint call.
order.updated	An Order was updated. This event is triggered only by the UpdateOrder endpoint call.

For information about using the Orders API, see What It Does.

Payments API

Event	Description
payment.created	A Payment was created.
payment.updated	A Payment was updated. Typically the `payment.status` or `card_details.status` field is updated when a payment is canceled, authorized, or completed.

For information about using the Payments API, see Payments API and Refunds API Overview.

Refunds API

Event	Description
refund.created	A Refund was created.
refund.updated	A Refund was updated. Typically the `refund.status` field changes when a refund is completed.

For information about using the Refunds API, see Payments API and Refunds API Overview.

Subscriptions API

Event	Description
`subscription.updated`	Published whenever the `Subscription` object changes.
`subscription.created`	Published when a `Subscription` object is created.

For information about using the Subscriptions API, see Manage Subscriptions Using the Subscriptions API.

Team API

Event	Description
team_member.created	A new team member was created.
team_member.updated	A team member was updated.
team_member.wage_setting.updated	A new team member wage setting was updated.

For information about using the Team API, see Team API.

Terminal API

Event	Description
terminal.checkout.created	A `TerminalCheckout` request was created.
terminal.checkout.updated	The status of a `TerminalCheckout` was changed.

For information about using the Terminal API, see Square Terminal Integration Overview.

Was this page helpful?

Still haven't found what you are looking for?

Contact Developer Support, or ask for help in the Developer Forums.

V2 Webhook Events Technical Reference

On this page

Bank Accounts API Permalink Get a link to this section

Bookings API Permalink Get a link to this section

Cards API Permalink Get a link to this section

Catalog API Permalink Get a link to this section

Customers API Permalink Get a link to this section

Devices API Permalink Get a link to this section

Disputes API Permalink Get a link to this section

Gift Cards API Permalink Get a link to this section

Inventory API Permalink Get a link to this section

Invoices API Permalink Get a link to this section

Labor API Permalink Get a link to this section

Locations API Permalink Get a link to this section

Loyalty API Permalink Get a link to this section

OAuth API Permalink Get a link to this section

Orders API Permalink Get a link to this section

Payments API Permalink Get a link to this section

Refunds API Permalink Get a link to this section

Subscriptions API Permalink Get a link to this section

Team API Permalink Get a link to this section

Terminal API Permalink Get a link to this section