V2 Webhook Events 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.

Customer Custom Attributes 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:

Event	Description
customer.custom_attribute_definition.created	A custom attribute definition was created by your application.
customer.custom_attribute_definition.updated	A custom attribute definition owned by your application was updated. Note that only the definition owner can update a custom attribute definition.
customer.custom_attribute_definition.deleted	A custom attribute definition owned by your application was deleted. Note that only the definition owner can delete a custom attribute definition.
customer.custom_attribute.updated	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.
customer.custom_attribute.deleted	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:

Event	Description
customer.custom_attribute_definition.public.created	A publicly visible custom attribute definition was created.
customer.custom_attribute_definition.public.updated	A publicly visible custom attribute definition was updated.
customer.custom_attribute_definition.public.deleted	A publicly visible custom attribute definition was deleted.
customer.custom_attribute.public.updated	A publicly visible custom attribute was created or updated for a customer profile.
customer.custom_attribute.public.deleted	A publicly visible custom attribute was deleted from a customer profile.

For more information about customer-related custom attribute events, see Webhooks. For information about using the Customer Custom Attributes API, see Custom Attributes for Customer Profiles.

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.
DEPRECATED: 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.state.updated	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.
DEPRECATED: 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.created	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.
DEPRECATED: dispute.evidence.removed	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 was linked to a gift card.
gift_card.customer_unlinked	A customer was 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 was changed. This event is also invoked following invoice.published and invoice.canceled events.
invoice.payment_made	A payment was made for an invoice.
invoice.scheduled_charge_failed	A scheduled automatic payment has failed.
invoice.canceled	An invoice was canceled.
invoice.refunded	A refund was processed for an invoice.
invoice.deleted	A draft invoice was deleted. A deleted invoice is removed entirely from the seller account and cannot be retrieved.

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

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

OAuth API

Event	Description
oauth.authorization.revoked	Notifies 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.created	Published whenever the Subscription object is created.
subscription.updated	Published whenever the Subscription object changes.

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.action.created	A TerminalAction request was created.
terminal.action.updated	A TerminalAction request was updated.
terminal.checkout.created	A TerminalCheckout request was created.
terminal.checkout.updated	A TerminalCheckout status was changed.
terminal.refund.created	A TerminalRefund request was created.
terminal.refund.updated	A TerminalRefund status was changed.

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

Vendors API

Event	Description
vendor.created	Published when a vendor is created by calling CreateVendor or BulkCreateVendors, as well as using the Square Seller Dashboard.
vendor.updated	Published when a vendor is updated by calling UpdateVendor or BulkUpdateVendors, as well as using the Seller Dashboard.

For more information about vendor events, see Receive Vendors Webhook Events. For information about using the Vendors API, see Manage Suppliers of a Seller.