Square API
You are viewing an old version of the API
Webhooks
Square API
Get notified about Square API events in realtime
Guides: Webhooks
Bank Accounts
You are viewing an old version of the API
-
bank_account.created
Published when you link an external bank account to a Square account in the Seller Dashboard.
-
bank_account.disabled
Published when Square sets the status of a BankAccount to DISABLED.
-
bank_account.verified
Published when Square sets the status of a BankAccount to VERIFIED.
Bookings
-
booking.created
Published when a booking is created.
-
booking.updated
Published when a booking is updated or cancelled.
Cards
-
card.automatically_updated
Published when a Card's 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 forgottenvaulted.
-
card.updated
Published when a Card is updated by the developer using the UpdateCard endpoint.
Catalog
Customer Custom Attributes
-
customer.custom_attribute.deleted
Published when a customer custom attribute associated with a custom attribute definition that is owned by the subscribing app is deleted.
BETA -
customer.custom_attribute.public.deleted
Published when a customer custom attribute that is visible to the subscribing app is deleted.
BETA -
customer.custom_attribute.public.updated
Published when a customer custom attribute that is visible to the subscribing app is updated.
BETA -
customer.custom_attribute.updated
Published when a customer custom attribute associated with a custom attribute definition that is owned by the subscribing app is updated.
BETA -
customer.custom_attribute_definition.created
Published when a customer custom attribute definition that is owned by the subscribing app is created.
BETA -
customer.custom_attribute_definition.deleted
Published when a customer custom attribute definition that is owned by the subscribing app is deleted.
BETA -
customer.custom_attribute_definition.public.created
Published when a customer custom attribute definition that is visible to the subscribing app is created.
BETA -
customer.custom_attribute_definition.public.deleted
Published when a customer custom attribute definition that is visible to the subscribing app is deleted.
BETA -
customer.custom_attribute_definition.public.updated
Published when a customer custom attribute definition that is visible to the subscribing app is updated.
BETA -
customer.custom_attribute_definition.updated
Published when a customer custom attribute definition that is owned by the subscribing app is updated.
BETA
Customers
-
customer.created
Published when a customer is created.
-
customer.deleted
Published when a customer is deleted.
-
customer.updated
Published when a customer is updated.
Devices
Disputes
-
dispute.created
Published when a Dispute is created.
-
dispute.evidence.created
Published when evidence is added to a Dispute from the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app, or by calling either CreateDisputeEvidenceFile or CreateDisputeEvidenceText.
-
dispute.evidence.deleted
Published when evidence is removed from a Dispute from the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app, or by calling DeleteDisputeEvidence.
-
dispute.state.updated
Published when the state of a Dispute changes.
Gift Card Activities
-
gift_card.activity.created
Published when a gift card activity is created.
-
gift_card.activity.updated
Published when a gift card activity is updated.
Gift Cards
-
gift_card.created
Published when a gift card is created.
-
gift_card.customer_linked
Published when a customer is linked to a gift card.
-
gift_card.customer_unlinked
Published when a customer is unlinked from a gift card.
-
gift_card.updated
Published when a gift card is updated.
Inventory
Invoices
-
invoice.canceled
Published when an Invoice is canceled.
-
invoice.created
Published when an Invoice is created.
-
invoice.deleted
Published when a draft Invoice is deleted.
-
invoice.payment_made
Published when a payment that is associated with an Invoice is completed.
-
invoice.published
Published when an Invoice transitions from a draft to a non-draft status.
-
invoice.refunded
Published when a refund is applied towards a payment of an Invoice.
-
invoice.scheduled_charge_failed
Published when an automatic scheduled payment for an Invoice has failed.
-
invoice.updated
Published when an Invoice is updated.
Labor
-
labor.shift.created
Published when a worker starts a Shift.
-
labor.shift.deleted
Published when a Shift is deleted.
-
labor.shift.updated
Published when a Shift is updated.
Locations
-
location.created
Published when a Location is created.
BETA -
location.updated
Published when a Location is updated.
BETA
Loyalty
-
loyalty.account.created
Published when a loyalty account is created.
-
loyalty.account.deleted
Published when a loyalty account is deleted.
-
loyalty.account.updated
Published when a loyalty account is updated.
-
loyalty.event.created
Published when a loyalty event is created.
-
loyalty.program.created
Published when a loyalty program is created.
-
loyalty.program.updated
Published when a loyalty program is updated.
OAuth
Orders
-
order.created
Published when an Order is created.
BETA -
order.fulfillment.updated
Published when an OrderFulfillment is created or updated.
BETA -
order.updated
Published when an Order is updated.
BETA
Payments
-
payment.created
Published when a Payment is created.
-
payment.updated
Published when a Payment is updated.
-
PAYMENT_UPDATED
Published when a charge is made or refunded through the Square Point of Sale app or the Transactions API.
V1
Payouts
-
payout.failed
Published when a Payout has failed.
-
payout.paid
Published when a Payout is complete.
-
payout.sent
Published when a Payout is sent.
Refunds
-
refund.created
Published when a Refund is created.
-
refund.updated
Published when a Refund is updated.
Subscriptions
-
subscription.created
Published when a Subscription is created.
-
subscription.updated
Published when a Subscription is updated.
Team
-
team_member.created
Published when a Team Member is created.
-
team_member.updated
Published when a Team Member is updated.
-
team_member.wage_setting.updated
Published when a Wage Setting is updated.
Terminal
-
terminal.action.created
Published when a TerminalAction is created.
BETA -
terminal.action.updated
Published when a TerminalAction is updated.
BETA -
terminal.checkout.created
Published when a TerminalCheckout is created.
-
terminal.checkout.updated
Published when a TerminalCheckout is updated.
-
terminal.refund.created
Published when a Terminal API refund is created.
-
terminal.refund.updated
Published when a Terminal API refund is updated.