v1 Webhooks

What It Does

Set up real-time notifications for completed transactions and updates to product inventories.

Backend
Webhooks API

Square Webhooks are HTTP calls or snippets of code that are triggered by specific events. To detect changes to data, typical APIs would require calls at regular time intervals. Square Webhooks replace regular API calls with instant, real-time notifications.

For example, consider a company that works with a manufacturer to print custom images on mugs. This company can use Square Webhooks to send customer images to a manufacturer as soon as a payment is processed.

Webhooks for the Connect v1 API support payment update, inventory update, and timecard update notifications for updates to the Connect v1 API

Product components
Permalink Get a link to this section

A Square Webhook integration includes the following:

  • Events — An action or change in data that generates a notification to be sent to an application.

  • Subscriptions — A request sent to the Webhooks API to receive notifications associated with a specific event.

  • Notification URL — The configurable service in the application to which alerts are sent.

  • Notification body — Details about the event that generated the alert, such as the time it happened or an ID identifying the data that changed.

Events
Permalink Get a link to this section

Events are actions or changes in data that generate notifications. Square Webhooks can be used to create alerts that trigger for these events. See the technical reference for more information on available webhook events .

Subscriptions
Permalink Get a link to this section

Subscribe to webhook notifications by calling the Subscribe endpoint. The Subscribe request body should specify which events the application will subscribe to.

Notification URL
Permalink Get a link to this section

Applications need a notification URL to receive and process webhook events from Square. The notification URL can be set in the Application Dashboard. When trigger events occur, Square Webhooks will send a POST request with event data to that notification URL.

Notification body
Permalink Get a link to this section

Events include the following data:

  • The merchant the event was triggered for.

  • The location where the event occurred.

  • The type of webhook event. See the list of available webhook events in the Connect Technical Reference for possible values.

PAYMENT_UPDATED notifications also include an entity_id, which is a payment ID that can be used to look up more information.

Get started

Use the build guides below to integrate with the Webhooks API.