> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Square

> How to set up the Square connector, plus the actions and events that are available.

![Square](https://stackone-logos.com/api/square-payroll/filled/svg)

Previewv3.0.1[See changelog](https://docs.stackone.com/connectors/square/changelog.md)

[137 actions](#actions) · [96 events](#events) · 2 auth methods

Payments
E-Commerce
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/square/guides/connector-profile/oauth-2-0.md)
>
> OAuth 2.0 provides secure, delegated access to Square resources without sharing credentials. You need a Square Developer...

> [card] [Access Token · Connector Profile](https://docs.stackone.com/connectors/square/guides/connector-profile/access-token.md)
>
> Uses the non-expiring personal access token of a Square app. Acts as the seller account that owns the app, with access t...

Optionally, configure receiving Events for Square into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/square/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/square/guides/link-account/oauth-2-0.md)

> [card] [Access Token · Link Account](https://docs.stackone.com/connectors/square/guides/link-account/access-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Access Token

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

BANK\_ACCOUNTS\_READ

CUSTOMERS\_READ

CUSTOMERS\_WRITE

DISPUTES\_READ

DISPUTES\_WRITE

EMPLOYEES\_READ

EMPLOYEES\_WRITE

GIFTCARDS\_READ

GIFTCARDS\_WRITE

INVENTORY\_READ

INVENTORY\_WRITE

INVOICES\_READ

INVOICES\_WRITE

ITEMS\_READ

ITEMS\_WRITE

MERCHANT\_PROFILE\_READ

MERCHANT\_PROFILE\_WRITE

ORDERS\_READ

ORDERS\_WRITE

PAYMENTS\_READ

PAYMENTS\_WRITE

PAYOUTS\_READ

SUBSCRIPTIONS\_READ

SUBSCRIPTIONS\_WRITE

TIMECARDS\_READ

TIMECARDS\_SETTINGS\_READ

TIMECARDS\_SETTINGS\_WRITE

TIMECARDS\_WRITE

No scopes found

137 actions

ActionDescriptionRequired scopes

List Payments`square_list_payments`

Retrieve a paginated list of payments taken by the account

`PAYMENTS_READ`

Create Payment`square_create_payment`

Create a payment using a payment source such as a card or gift card

`PAYMENTS_WRITE`

Get Payment`square_get_payment`

Retrieve details for a specific payment by ID

`PAYMENTS_READ`

Update Payment`square_update_payment`

Update a payment with APPROVED status to modify tip or amount

`PAYMENTS_WRITE`

Cancel Payment`square_cancel_payment`

Cancel (void) a payment by its ID

`PAYMENTS_WRITE`

Cancel Payment By Idempotency Key`square_cancel_payment_by_idempotency_key`

Cancel a payment using the original idempotency key when the payment ID is unknown

`PAYMENTS_WRITE`

Complete Payment`square_complete_payment`

Complete (capture) a payment that was created with autocomplete set to false

`PAYMENTS_WRITE`

List Payment Refunds`square_list_payment_refunds`

Retrieve a paginated list of refunds for the account

`PAYMENTS_READ`

Refund Payment`square_refund_payment`

Refund a payment, either fully or partially

`PAYMENTS_WRITE`

Get Payment Refund`square_get_payment_refund`

Retrieve details of a specific refund by ID

`PAYMENTS_READ`

Create Order`square_create_order`

Create a new order for a location

`ORDERS_WRITE`

Search Orders`square_search_orders`

Search for orders across one or more locations with filters

`ORDERS_READ`

Retrieve Order`square_retrieve_order`

Retrieve an order by its ID

`ORDERS_READ`

Update Order`square_update_order`

Update an open order by adding, replacing, or deleting fields

`ORDERS_WRITE`

Pay Order`square_pay_order`

Pay for an order using one or more approved payments

`ORDERS_WRITE``PAYMENTS_WRITE`

Calculate Order`square_calculate_order`

Preview order pricing without creating an order

`ORDERS_WRITE`

Batch Retrieve Orders`square_batch_retrieve_orders`

Retrieve multiple orders by their IDs in a single request

`ORDERS_READ`

Clone Order`square_clone_order`

Create a new order by cloning an existing order

`ORDERS_WRITE`

List Customers`square_list_customers`

Retrieve a paginated list of all customer profiles for the account

`CUSTOMERS_READ`

Create Customer`square_create_customer`

Create a new customer profile for the business

`CUSTOMERS_WRITE`

Search Customers`square_search_customers`

Search customer profiles by phone, email, name, or custom attributes

`CUSTOMERS_READ`

Retrieve Customer`square_retrieve_customer`

Retrieve a specific customer profile by ID

`CUSTOMERS_READ`

Update Customer`square_update_customer`

Update an existing customer profile

`CUSTOMERS_WRITE`

Delete Customer`square_delete_customer`

Delete a customer profile from the business

`CUSTOMERS_WRITE`

Add Group To Customer`square_add_group_to_customer`

Add a group membership to a customer profile

`CUSTOMERS_WRITE`

Remove Group From Customer`square_remove_group_from_customer`

Remove a group membership from a customer profile

`CUSTOMERS_WRITE`

List Customer Groups`square_list_customer_groups`

Retrieve a list of all customer groups for the business

`CUSTOMERS_READ`

Create Customer Group`square_create_customer_group`

Create a new customer group for the business

`CUSTOMERS_WRITE`

Retrieve Customer Group`square_retrieve_customer_group`

Retrieve a specific customer group by ID

`CUSTOMERS_READ`

Update Customer Group`square_update_customer_group`

Update an existing customer group's name

`CUSTOMERS_WRITE`

Delete Customer Group`square_delete_customer_group`

Delete a customer group from the business

`CUSTOMERS_WRITE`

Bulk Create Customers`square_bulk_create_customers`

Create up to 100 customer profiles in a single request

`CUSTOMERS_WRITE`

Bulk Retrieve Customers`square_bulk_retrieve_customers`

Retrieve up to 100 customer profiles by ID in a single request

`CUSTOMERS_READ`

Bulk Update Customers`square_bulk_update_customers`

Update up to 100 customer profiles in a single request

`CUSTOMERS_WRITE`

Bulk Delete Customers`square_bulk_delete_customers`

Delete up to 100 customer profiles in a single request

`CUSTOMERS_WRITE`

List Customer Segments`square_list_customer_segments`

Retrieve a list of all customer segments for the business

`CUSTOMERS_READ`

Retrieve Customer Segment`square_retrieve_customer_segment`

Retrieve a specific customer segment by ID

`CUSTOMERS_READ`

List Catalog`square_list_catalog`

Retrieve a paginated list of all catalog objects for the account

`ITEMS_READ`

Search Catalog Objects`square_search_catalog_objects`

Search for catalog objects of any type (items, categories, taxes, discounts, etc.) using advanced query filters

`ITEMS_READ`

Search Catalog Items`square_search_catalog_items`

Search specifically for catalog items and item variations only (not taxes, categories, or discounts) by text, category,...

`ITEMS_READ`

Retrieve Catalog Object`square_retrieve_catalog_object`

Retrieve a single catalog object by ID

`ITEMS_READ`

Upsert Catalog Object`square_upsert_catalog_object`

Create or update a single catalog object

`ITEMS_WRITE`

Delete Catalog Object`square_delete_catalog_object`

Delete a single catalog object and its children

`ITEMS_WRITE`

Batch Upsert Catalog Objects`square_batch_upsert_catalog_objects`

Create or update up to 10,000 catalog objects in a single request

`ITEMS_WRITE`

Batch Retrieve Catalog Objects`square_batch_retrieve_catalog_objects`

Retrieve multiple catalog objects by their IDs in a single request

`ITEMS_READ`

Batch Delete Catalog Objects`square_batch_delete_catalog_objects`

Delete multiple catalog objects in a single request

`ITEMS_WRITE`

Retrieve Inventory Count`square_retrieve_inventory_count`

Retrieve current inventory counts for a specific catalog object

`INVENTORY_READ`

Batch Retrieve Inventory Counts`square_batch_retrieve_inventory_counts`

Retrieve current inventory counts for multiple catalog objects at specific locations

`INVENTORY_READ`

Batch Retrieve Inventory Changes`square_batch_retrieve_inventory_changes`

Retrieve a list of inventory changes for catalog objects at specific locations

`INVENTORY_READ`

Retrieve Inventory Adjustment`square_retrieve_inventory_adjustment`

Retrieve a specific inventory adjustment by its ID

`INVENTORY_READ`

Retrieve Inventory Physical Count`square_retrieve_inventory_physical_count`

Retrieve a specific inventory physical count record by its ID

`INVENTORY_READ`

Batch Change Inventory`square_batch_change_inventory`

Apply adjustments and counts to catalog object quantities

`INVENTORY_WRITE`

List Locations`square_list_locations`

Retrieve all seller locations for the account

`MERCHANT_PROFILE_READ`

Create Location`square_create_location`

Create a new location for the seller account

`MERCHANT_PROFILE_WRITE`

Retrieve Location`square_retrieve_location`

Retrieve details of a specific location by ID

`MERCHANT_PROFILE_READ`

Update Location`square_update_location`

Update an existing location's settings and information

`MERCHANT_PROFILE_WRITE`

List Merchants`square_list_merchants`

Retrieve the merchant profile for the account

`MERCHANT_PROFILE_READ`

Retrieve Merchant`square_retrieve_merchant`

Retrieve a specific merchant's profile by ID

`MERCHANT_PROFILE_READ`

List Payouts`square_list_payouts`

Retrieve a paginated list of all payouts for the seller's default or specified location

`PAYOUTS_READ`

Get Payout`square_get_payout`

Retrieve details of a specific payout by its ID

`PAYOUTS_READ`

List Payout Entries`square_list_payout_entries`

Retrieve all payout entries for a specific payout

`PAYOUTS_READ`

List Invoices`square_list_invoices`

Retrieve a list of invoices for a given location

`INVOICES_READ`

Create Invoice`square_create_invoice`

Create a draft invoice for an order

`INVOICES_WRITE``ORDERS_WRITE`

Search Invoices`square_search_invoices`

Search for invoices by location, customer, or status

`INVOICES_READ`

Get Invoice`square_get_invoice`

Retrieve an invoice by its ID

`INVOICES_READ`

Update Invoice`square_update_invoice`

Update a draft or scheduled invoice

`INVOICES_WRITE``ORDERS_WRITE`

Delete Invoice`square_delete_invoice`

Delete a draft invoice

`INVOICES_WRITE``ORDERS_WRITE`

Publish Invoice`square_publish_invoice`

Publish a draft invoice to send it to the customer

`INVOICES_WRITE``ORDERS_WRITE`

Cancel Invoice`square_cancel_invoice`

Cancel a published invoice

`INVOICES_WRITE``ORDERS_WRITE`

Create Subscription`square_create_subscription`

Enroll a customer in a subscription plan

`CUSTOMERS_READ``INVOICES_WRITE``ITEMS_READ``ORDERS_WRITE``PAYMENTS_WRITE``SUBSCRIPTIONS_WRITE`

Search Subscriptions`square_search_subscriptions`

Search for subscriptions by customer, location, or plan

`SUBSCRIPTIONS_READ`

Retrieve Subscription`square_retrieve_subscription`

Retrieve a specific subscription by ID

`SUBSCRIPTIONS_READ`

Update Subscription`square_update_subscription`

Modify or clear field values on an active subscription

`CUSTOMERS_READ``INVOICES_WRITE``ITEMS_READ``ORDERS_WRITE``PAYMENTS_WRITE``SUBSCRIPTIONS_WRITE`

Cancel Subscription`square_cancel_subscription`

Schedule a cancellation for an active subscription

`SUBSCRIPTIONS_WRITE`

List Subscription Events`square_list_subscription_events`

Retrieve a paginated list of events for a specific subscription

`SUBSCRIPTIONS_READ`

Resume Subscription`square_resume_subscription`

Resume a paused or canceled subscription

`SUBSCRIPTIONS_WRITE`

List Cards`square_list_cards`

Retrieve a list of saved payment cards (credit/debit cards on file, not gift cards) for the account

`PAYMENTS_READ`

Create Card`square_create_card`

Add a card on file to an existing customer or merchant

`PAYMENTS_WRITE`

Retrieve Card`square_retrieve_card`

Retrieve details of a specific card on file by ID

`PAYMENTS_READ`

Disable Card`square_disable_card`

Disable a card on file to prevent further charges

`PAYMENTS_WRITE`

List Gift Cards`square_list_gift_cards`

Retrieve a list of gift cards for the account

`GIFTCARDS_READ`

Create Gift Card`square_create_gift_card`

Create a digital gift card or register a physical gift card

`GIFTCARDS_WRITE`

Retrieve Gift Card`square_retrieve_gift_card`

Retrieve a gift card by its ID

`GIFTCARDS_READ`

Retrieve Gift Card From GAN`square_retrieve_gift_card_from_gan`

Retrieve a gift card using the gift card account number (GAN)

`GIFTCARDS_READ`

Link Customer To Gift Card`square_link_customer_to_gift_card`

Link a customer to a gift card to associate it with their account

`GIFTCARDS_WRITE`

Unlink Customer From Gift Card`square_unlink_customer_from_gift_card`

Unlink a customer from a gift card to remove the association

`GIFTCARDS_WRITE`

Create Gift Card Activity`square_create_gift_card_activity`

Create an activity (activate, load, redeem, adjust, etc.) on a gift card

`GIFTCARDS_WRITE`

List Gift Card Activities`square_list_gift_card_activities`

Retrieve a list of gift card activities for a specific gift card or across all gift cards

`GIFTCARDS_READ`

Create Team Member`square_create_team_member`

Create a new team member for the seller account

`EMPLOYEES_WRITE`

Search Team Members`square_search_team_members`

Search for team members by location, status, or other criteria

`EMPLOYEES_READ`

Retrieve Team Member`square_retrieve_team_member`

Retrieve a team member by ID

`EMPLOYEES_READ`

Update Team Member`square_update_team_member`

Update an existing team member's information

`EMPLOYEES_WRITE`

List Jobs`square_list_jobs`

Retrieve a list of all jobs defined for the seller account

`EMPLOYEES_READ`

Create Job`square_create_job`

Create a new job definition for the seller account

`EMPLOYEES_WRITE`

Retrieve Job`square_retrieve_job`

Retrieve a specific job definition by its ID

`EMPLOYEES_READ`

Update Job`square_update_job`

Update an existing job definition by its ID

`EMPLOYEES_WRITE`

Retrieve Wage Setting`square_retrieve_wage_setting`

Retrieve the wage setting for a team member

`EMPLOYEES_READ`

Update Wage Setting`square_update_wage_setting`

Create or update the wage setting for a team member

`EMPLOYEES_WRITE`

Bulk Create Team Members`square_bulk_create_team_members`

Create multiple team members in a single request

`EMPLOYEES_WRITE`

Bulk Update Team Members`square_bulk_update_team_members`

Update multiple team members in a single request

`EMPLOYEES_WRITE`

List Break Types`square_list_break_types`

Retrieve a list of all break types for the seller account

`TIMECARDS_SETTINGS_READ`

Create Break Type`square_create_break_type`

Create a new break type for team member shifts

`TIMECARDS_SETTINGS_WRITE`

Retrieve Break Type`square_get_break_type`

Retrieve a specific break type by ID

`TIMECARDS_SETTINGS_READ`

Search Timecards`square_search_timecards`

Search for timecard records with filters for team member and date range

`TIMECARDS_READ`

Retrieve Timecard`square_retrieve_timecard`

Retrieve a specific timecard by ID

`TIMECARDS_READ`

Create Timecard`square_create_timecard`

Create a new timecard for a team member at a location

`TIMECARDS_WRITE`

Update Break Type`square_update_break_type`

Update an existing break type by ID

`TIMECARDS_SETTINGS_WRITE`

Delete Break Type`square_delete_break_type`

Delete a break type by ID

`TIMECARDS_SETTINGS_WRITE`

Update Timecard`square_update_timecard`

Update an existing timecard by ID

`TIMECARDS_WRITE`

Delete Timecard`square_delete_timecard`

Delete a timecard by ID

`TIMECARDS_WRITE`

List Disputes`square_list_disputes`

Retrieve a list of disputes associated with the account

`DISPUTES_READ`

Retrieve Dispute`square_retrieve_dispute`

Retrieve details about a specific dispute by ID

`DISPUTES_READ`

Accept Dispute`square_accept_dispute`

Accept the loss on a dispute without submitting evidence

`DISPUTES_WRITE`

List Dispute Evidence`square_list_dispute_evidence`

Retrieve all evidence submitted for a dispute

`DISPUTES_READ`

Submit Evidence`square_submit_evidence`

Submit collected evidence to contest a dispute

`DISPUTES_WRITE`

List Bank Accounts`square_list_bank_accounts`

Retrieve a list of bank accounts linked to the Square account

`BANK_ACCOUNTS_READ`

Get Bank Account`square_get_bank_account`

Retrieve details of a specific bank account by ID

`BANK_ACCOUNTS_READ`

Create Dispute Evidence Text`square_create_dispute_evidence_text`

Upload text-based evidence to contest a dispute

`DISPUTES_WRITE`

Retrieve Dispute Evidence`square_retrieve_dispute_evidence`

Retrieve metadata for a specific piece of dispute evidence

`DISPUTES_READ`

Delete Dispute Evidence`square_delete_dispute_evidence`

Remove a specific piece of evidence from a dispute before submission

`DISPUTES_WRITE`

List Payment Links`square_list_payment_links`

Retrieve a list of all payment links for the account

`ORDERS_READ`

Create Payment Link`square_create_payment_link`

Create a Square-hosted checkout page with a shareable payment link

`ORDERS_WRITE``PAYMENTS_WRITE`

Retrieve Payment Link`square_retrieve_payment_link`

Retrieve a specific payment link by its token ID

`ORDERS_READ`

Update Payment Link`square_update_payment_link`

Update an existing payment link's settings

`ORDERS_WRITE``PAYMENTS_WRITE`

Delete Payment Link`square_delete_payment_link`

Delete a payment link permanently

`ORDERS_WRITE`

Get Unified Credentials`square_unified_get_me`

Return the authenticated Square connection's identity (merchant business name), granted scopes, and auth\_type ("oauth" o...

IAM Auth Test`square_auth_test`

Validate the current Square access token (OAuth or personal) and return the raw, unmapped token status payload (scopes...

List Unified Groups`square_unified_list_groups`

List Square locations mapped to the IAM unified group schema. Each location represents a physical workplace (store, mobi...

`MERCHANT_PROFILE_READ`

Get Unified Group`square_unified_get_group`

Retrieve a single Square location by id, mapped to the IAM unified group schema. Field coverage matches unified\_list\_gro...

`MERCHANT_PROFILE_READ`

List Unified Organizations`square_unified_list_organizations`

Return the Square merchant for the current connection mapped to the IAM unified organization schema. Square is single-te...

`MERCHANT_PROFILE_READ`

Get Unified Organization`square_unified_get_organization`

Retrieve a single Square merchant by id, mapped to the IAM unified organization schema. Square is single-tenant per acce...

`MERCHANT_PROFILE_READ`

List Unified Resource Types`square_unified_list_resource_types`

List unified resource types in Square.

`EMPLOYEES_READ`

List Unified Resource Users`square_unified_list_resource_users`

List Square team members assigned to a specific location (resource\_type="location"), mapped to the IAM unified user sche...

`EMPLOYEES_READ`

List Unified Roles`square_unified_list_roles`

Return the two stable workspace-level IAM roles (owner / team\_member) synthesized from Square's is\_owner flag on team me...

`EMPLOYEES_READ`

Get Unified Role`square_unified_get_role`

Retrieve a single synthesized Square IAM role by its stable key. Known keys are "owner" and "team\_member"; any other id...

`EMPLOYEES_READ`

List Unified Users`square_unified_list_users`

List Square team members mapped to the IAM unified user schema. Each member is annotated with a workspace-scoped role sy...

`EMPLOYEES_READ`

Get Unified User`square_unified_get_user`

Retrieve a single Square team member by team member id, mapped to the IAM unified user schema. Field coverage matches un...

`EMPLOYEES_READ`

## Events

Tags

Select all
|
Clear

Authorization

Bank Accounts

Bookings

Cards

Catalog

Checkout

Custom Attributes

Customers

Devices

Disputes

Gift Cards

Inventory

Invoices

Jobs

Locations

Loyalty

Orders

Payments

Payouts

Refunds

Scheduled Shifts

Subscriptions

Team Members

Terminal

Timecards

Webhooks

No tags found

96 events

EventDescriptionTags

Unmapped Event`square_unmapped_event`

Acknowledges Square events this connector does not map.

Webhooks

Payment Created`square_webhook_payment_created`

Fires when a payment is created.

PaymentsWebhooks

Payment Updated`square_webhook_payment_updated`

Fires when a payment field changes, such as status or card\_details.status.

PaymentsWebhooks

Refund Created`square_webhook_refund_created`

Fires when a refund is created.

RefundsWebhooks

Refund Updated`square_webhook_refund_updated`

Fires when a refund is updated, typically when its status changes on completion.

RefundsWebhooks

Card Created`square_webhook_card_created`

Fires when a card on file is created or imported.

CardsWebhooks

Card Automatically Updated`square_webhook_card_automatically_updated`

Fires when Square automatically updates a card expiration date or PAN, or adds or removes an issuer alert.

CardsWebhooks

Card Updated`square_webhook_card_updated`

Fires when the seller updates a card in the Square Dashboard.

CardsWebhooks

Card Disabled`square_webhook_card_disabled`

Fires when a card on file is disabled.

CardsWebhooks

Card Forgotten`square_webhook_card_forgotten`

Fires when a card is GDPR forgotten or vaulted.

CardsWebhooks

Dispute Created`square_webhook_dispute_created`

Fires when a dispute is created.

DisputesWebhooks

Dispute State Updated`square_webhook_dispute_state_updated`

Fires when the state of a dispute changes, including the WON or LOST resolution reported by the bank.

DisputesWebhooks

Dispute Evidence Created`square_webhook_dispute_evidence_created`

Fires when evidence is added to a dispute.

DisputesWebhooks

Dispute Evidence Deleted`square_webhook_dispute_evidence_deleted`

Fires when evidence is removed from a dispute.

DisputesWebhooks

Payout Sent`square_webhook_payout_sent`

Fires when a payout is sent.

PayoutsWebhooks

Payout Paid`square_webhook_payout_paid`

Fires when a payout is completed.

PayoutsWebhooks

Payout Failed`square_webhook_payout_failed`

Fires when a payout fails.

PayoutsWebhooks

Bank Account Created`square_webhook_bank_account_created`

Fires when a bank account is linked to the Square account.

Bank AccountsWebhooks

Bank Account Verified`square_webhook_bank_account_verified`

Fires when Square sets the status of a bank account to VERIFIED.

Bank AccountsWebhooks

Bank Account Disabled`square_webhook_bank_account_disabled`

Fires when Square sets the status of a bank account to DISABLED.

Bank AccountsWebhooks

Gift Card Created`square_webhook_gift_card_created`

Fires when a digital gift card is created or a physical gift card is registered.

Gift CardsWebhooks

Gift Card Updated`square_webhook_gift_card_updated`

Fires when the balance, state or linked customers of a gift card change.

Gift CardsWebhooks

Gift Card Customer Linked`square_webhook_gift_card_customer_linked`

Fires when a customer is linked to a gift card.

Gift CardsWebhooks

Gift Card Customer Unlinked`square_webhook_gift_card_customer_unlinked`

Fires when a customer is unlinked from a gift card.

Gift CardsWebhooks

Gift Card Activity Created`square_webhook_gift_card_activity_created`

Fires when a gift card activity is created.

Gift CardsWebhooks

Gift Card Activity Updated`square_webhook_gift_card_activity_updated`

Fires when a REDEEM or IMPORT gift card activity is updated.

Gift CardsWebhooks

Order Created`square_webhook_order_created`

Fires when an order is created by a Square product or an application.

OrdersWebhooks

Order Updated`square_webhook_order_updated`

Fires when an order is updated through UpdateOrder or by the seller.

OrdersWebhooks

Order Fulfillment Updated`square_webhook_order_fulfillment_updated`

Fires when an order fulfillment is created or updated.

OrdersWebhooks

Invoice Created`square_webhook_invoice_created`

Fires when a draft invoice is created.

InvoicesWebhooks

Invoice Updated`square_webhook_invoice_updated`

Fires when an invoice changes, including after it is published or canceled.

InvoicesWebhooks

Invoice Published`square_webhook_invoice_published`

Fires when an invoice is published, including invoices scheduled for later processing.

InvoicesWebhooks

Invoice Payment Made`square_webhook_invoice_payment_made`

Fires when a payment is made for an invoice.

InvoicesWebhooks

Invoice Scheduled Charge Failed`square_webhook_invoice_scheduled_charge_failed`

Fires when a scheduled automatic invoice payment fails.

InvoicesWebhooks

Invoice Canceled`square_webhook_invoice_canceled`

Fires when an invoice is canceled.

InvoicesWebhooks

Invoice Refunded`square_webhook_invoice_refunded`

Fires when a refund is processed for an invoice.

InvoicesWebhooks

Invoice Deleted`square_webhook_invoice_deleted`

Fires when a draft invoice is deleted.

InvoicesWebhooks

Subscription Created`square_webhook_subscription_created`

Fires when a subscription is created.

SubscriptionsWebhooks

Subscription Updated`square_webhook_subscription_updated`

Fires when a subscription is updated.

SubscriptionsWebhooks

Catalog Version Updated`square_webhook_catalog_version_updated`

Fires when the catalog is updated.

CatalogWebhooks

Inventory Count Updated`square_webhook_inventory_count_updated`

Fires when the quantity of a catalog item variation changes.

InventoryWebhooks

Customer Created`square_webhook_customer_created`

Fires when a customer profile is created, including when profiles are merged.

CustomersWebhooks

Customer Updated`square_webhook_customer_updated`

Fires when an attribute on a customer profile changes, except segment\_ids.

CustomersWebhooks

Customer Deleted`square_webhook_customer_deleted`

Fires when a customer profile is deleted, including when profiles are merged.

CustomersWebhooks

Location Created`square_webhook_location_created`

Fires when a location is created.

LocationsWebhooks

Location Updated`square_webhook_location_updated`

Fires when a location is updated.

LocationsWebhooks

Online Checkout Location Settings Updated`square_webhook_online_checkout_location_settings_updated`

Fires when online checkout location settings are updated.

CheckoutWebhooks

Online Checkout Merchant Settings Updated`square_webhook_online_checkout_merchant_settings_updated`

Fires when online checkout merchant settings are updated.

CheckoutWebhooks

Team Member Created`square_webhook_team_member_created`

Fires when a team member is created.

Team MembersWebhooks

Team Member Updated`square_webhook_team_member_updated`

Fires when a team member is updated.

Team MembersWebhooks

Team Member Wage Setting Updated`square_webhook_team_member_wage_setting_updated`

Fires when the wage setting of a team member is updated.

Team MembersWebhooks

Job Created`square_webhook_job_created`

Fires when a job is created.

JobsWebhooks

Job Updated`square_webhook_job_updated`

Fires when a job is updated.

JobsWebhooks

Timecard Created`square_webhook_labor_timecard_created`

Fires when a timecard is created at the start of a shift.

TimecardsWebhooks

Timecard Updated`square_webhook_labor_timecard_updated`

Fires when a timecard is updated.

TimecardsWebhooks

Timecard Deleted`square_webhook_labor_timecard_deleted`

Fires when a timecard is deleted.

TimecardsWebhooks

Scheduled Shift Created`square_webhook_labor_scheduled_shift_created`

Fires when a scheduled shift is created.

Scheduled ShiftsWebhooks

Scheduled Shift Updated`square_webhook_labor_scheduled_shift_updated`

Fires when a scheduled shift is updated.

Scheduled ShiftsWebhooks

Scheduled Shift Published`square_webhook_labor_scheduled_shift_published`

Fires when a scheduled shift is published.

Scheduled ShiftsWebhooks

Scheduled Shift Deleted`square_webhook_labor_scheduled_shift_deleted`

Fires when a scheduled shift is permanently deleted.

Scheduled ShiftsWebhooks

OAuth Authorization Revoked`square_webhook_oauth_authorization_revoked`

Fires when the seller revokes all access and refresh tokens granted to the application.

AuthorizationWebhooks

Customer Custom Attribute Definition Owned Created`square_webhook_customer_custom_attribute_definition_owned_created`

Fires when a customer custom attribute definition owned by the application is created.

Custom AttributesWebhooks

Customer Custom Attribute Definition Owned Updated`square_webhook_customer_custom_attribute_definition_owned_updated`

Fires when a customer custom attribute definition owned by the application is updated.

Custom AttributesWebhooks

Customer Custom Attribute Definition Owned Deleted`square_webhook_customer_custom_attribute_definition_owned_deleted`

Fires when a customer custom attribute definition owned by the application is deleted.

Custom AttributesWebhooks

Customer Custom Attribute Owned Updated`square_webhook_customer_custom_attribute_owned_updated`

Fires when a customer custom attribute owned by the application is created or updated.

Custom AttributesWebhooks

Customer Custom Attribute Owned Deleted`square_webhook_customer_custom_attribute_owned_deleted`

Fires when a customer custom attribute owned by the application is deleted.

Custom AttributesWebhooks

Customer Custom Attribute Definition Visible Created`square_webhook_customer_custom_attribute_definition_visible_created`

Fires when a customer custom attribute definition visible to the application is created.

Custom AttributesWebhooks

Customer Custom Attribute Definition Visible Updated`square_webhook_customer_custom_attribute_definition_visible_updated`

Fires when a customer custom attribute definition visible to the application is updated.

Custom AttributesWebhooks

Customer Custom Attribute Definition Visible Deleted`square_webhook_customer_custom_attribute_definition_visible_deleted`

Fires when a customer custom attribute definition visible to the application is deleted.

Custom AttributesWebhooks

Customer Custom Attribute Visible Updated`square_webhook_customer_custom_attribute_visible_updated`

Fires when a customer custom attribute visible to the application is created or updated.

Custom AttributesWebhooks

Customer Custom Attribute Visible Deleted`square_webhook_customer_custom_attribute_visible_deleted`

Fires when a customer custom attribute visible to the application is deleted.

Custom AttributesWebhooks

Booking Custom Attribute Definition Owned Created`square_webhook_booking_custom_attribute_definition_owned_created`

Fires when a booking custom attribute definition owned by the application is created.

Custom AttributesWebhooks

Booking Custom Attribute Definition Owned Updated`square_webhook_booking_custom_attribute_definition_owned_updated`

Fires when a booking custom attribute definition owned by the application is updated.

Custom AttributesWebhooks

Booking Custom Attribute Definition Owned Deleted`square_webhook_booking_custom_attribute_definition_owned_deleted`

Fires when a booking custom attribute definition owned by the application is deleted.

Custom AttributesWebhooks

Booking Custom Attribute Owned Updated`square_webhook_booking_custom_attribute_owned_updated`

Fires when a booking custom attribute owned by the application is created or updated.

Custom AttributesWebhooks

Booking Custom Attribute Owned Deleted`square_webhook_booking_custom_attribute_owned_deleted`

Fires when a booking custom attribute owned by the application is deleted.

Custom AttributesWebhooks

Booking Custom Attribute Definition Visible Created`square_webhook_booking_custom_attribute_definition_visible_created`

Fires when a booking custom attribute definition visible to the application is created.

Custom AttributesWebhooks

Booking Custom Attribute Definition Visible Updated`square_webhook_booking_custom_attribute_definition_visible_updated`

Fires when a booking custom attribute definition visible to the application is updated.

Custom AttributesWebhooks

Booking Custom Attribute Definition Visible Deleted`square_webhook_booking_custom_attribute_definition_visible_deleted`

Fires when a booking custom attribute definition visible to the application is deleted.

Custom AttributesWebhooks

Booking Custom Attribute Visible Updated`square_webhook_booking_custom_attribute_visible_updated`

Fires when a booking custom attribute visible to the application is created or updated.

Custom AttributesWebhooks

Booking Custom Attribute Visible Deleted`square_webhook_booking_custom_attribute_visible_deleted`

Fires when a booking custom attribute visible to the application is deleted.

Custom AttributesWebhooks

Booking Created`square_webhook_booking_created`

Fires when a booking is created.

BookingsWebhooks

Booking Updated`square_webhook_booking_updated`

Fires when a booking is updated or canceled, through the API, the Square Dashboard or the seller booking site.

BookingsWebhooks

Loyalty Account Created`square_webhook_loyalty_account_created`

Fires when a loyalty account is created for a buyer.

LoyaltyWebhooks

Loyalty Account Updated`square_webhook_loyalty_account_updated`

Fires when a loyalty account is updated, for example its phone number or point balance.

LoyaltyWebhooks

Loyalty Account Deleted`square_webhook_loyalty_account_deleted`

Fires when a loyalty account is deleted.

LoyaltyWebhooks

Loyalty Event Created`square_webhook_loyalty_event_created`

Fires when a balance-changing loyalty event occurs, such as points accumulated or a reward redeemed.

LoyaltyWebhooks

Loyalty Program Created`square_webhook_loyalty_program_created`

Fires when a loyalty program is created in the Square Dashboard.

LoyaltyWebhooks

Loyalty Program Updated`square_webhook_loyalty_program_updated`

Fires when a loyalty program is updated in the Square Dashboard.

LoyaltyWebhooks

Loyalty Promotion Created`square_webhook_loyalty_promotion_created`

Fires when a loyalty promotion is created.

LoyaltyWebhooks

Loyalty Promotion Updated`square_webhook_loyalty_promotion_updated`

Fires when a loyalty promotion is updated, for example canceled.

LoyaltyWebhooks

Terminal Checkout Created`square_webhook_terminal_checkout_created`

Fires when a Terminal checkout request is created.

TerminalWebhooks

Terminal Checkout Updated`square_webhook_terminal_checkout_updated`

Fires when the status of a Terminal checkout changes.

TerminalWebhooks

Terminal Refund Created`square_webhook_terminal_refund_created`

Fires when a Terminal refund request is created.

TerminalWebhooks

Terminal Refund Updated`square_webhook_terminal_refund_updated`

Fires when the status of a Terminal refund changes.

TerminalWebhooks

Device Code Paired`square_webhook_device_code_paired`

Fires when a Square Terminal is paired with a Terminal API device code.

DevicesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.