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 Permalink Get a link to this section

EventDescription
bank_account.disabledPublished when Square sets the status of a bank account to DISABLED.
bank_account.verifiedPublished when Square sets the status of a bank account to VERIFIED.
bank_account.createdPublished 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 Permalink Get a link to this section

EventDescription
booking.createdA booking is created by calling CreateBooking.
booking.updatedAn 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 Permalink Get a link to this section

EventDescription
card.automatically_updatedPublished when card expiration information or pan is automatically updated.
card.createdPublished when a card is created or imported.
card.disabledPublished when a card is disabled.
card.forgottenPublished when a card is GDPR forgotten/vaulted.
card.updatedPublished 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 Permalink Get a link to this section

EventDescription
catalog.version.updatedThe 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 Permalink Get a link to this section