Technical Reference
V1 Webhooks API
Webhooks (also known as web callbacks or push APIs) are HTTP calls or snippets of code that are triggered by specific events.
See the Webhooks API guide for more information.
Available webhook events
Different webhook events require different permissions. Applications must have the required permission scope to subscribe to webhook events. Subscribing to, or updating subscriptions for, webhook events without the necessary permissions fails with an error.
If permission for a given event is revoked at a later time, it will not generate an error, but the application no longer receives notifications for that event type.
| Webhook Event | Description |
|---|---|
| PAYMENT_UPDATED | A charge was made or refunded through Square Point of Sale or the Transaction API. Permission: PAYMENTS_READ |
| INVENTORY_UPDATED (deprecated) - use inventory.count.updated | The inventory quantity for a catalog item was updated. Permission: ITEMS_READ |
| TIMECARD_UPDATED (deprecated) - use labor.shift.updated | A timecard was created in the Square dashboard or an employee clocked in using Square Point of Sale. Permission: TIMECARDS_READ |
Webhook endpoints
ListWebhooks
GET /v1/{location_id}/webhooks
Lists which types of events trigger webhook notifications for a particular location. See the Webhooks API guide for more information.
Path Parameters
location_id
Type: string
The ID of the location to list webhook notification types for.
Return Value: A list of webhook event enums.
UpdateWebhooks
PUT /v1/{location_id}/webhooks
Changes the webhook event subscriptions for a location. See the Webhooks API guide for more information.
Path Parameters
location_id
Type: string
The ID of the location to list webhook notification types for.
Return Value: A list of webhook event enums the location is currently subscribed to.