Square

Square Webhook Subscriptions API

The Webhook Subscriptions API from Square — 5 operation(s) for webhook subscriptions.

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/webhooks/event-types List subscribable webhook event types · Square List Webhook Event Types #
Ask an LLM
“Which webhook events can my app subscribe to?”
“Are the available webhook event types different by API version?”
Tell an agent
List all webhook event types.
Show webhook event types available in API version {api_version}.
GET /v2/webhooks/subscriptions List my webhook subscriptions · Square List Webhook Subscriptions #
Ask an LLM
“What webhook subscriptions does my application have?”
“Can I include disabled webhook subscriptions in the list?”
Tell an agent
List my webhook subscriptions.
Show webhook subscriptions including disabled ones: {include_disabled}.
POST /v2/webhooks/subscriptions Subscribe to webhook events · Square Create Webhook Subscription #
Ask an LLM
“How do I start receiving Square webhook notifications at my URL?”
“Can I create a webhook subscription for specific event types?”
Tell an agent
Create webhook subscription {subscription}.
Subscribe my endpoint to these webhook events: {subscription}.
DELETE /v2/webhooks/subscriptions/{subscription_id} Delete a webhook subscription · Square Delete Webhook Subscription #
Ask an LLM
“How do I stop a webhook subscription for good?”
“What's the way to remove a webhook endpoint I no longer use?”
Tell an agent destructive · confirm first
Delete webhook subscription {subscription_id}.
Remove webhook subscription {subscription_id} permanently.
GET /v2/webhooks/subscriptions/{subscription_id} Get a webhook subscription · Square Retrieve Webhook Subscription #
Ask an LLM
“What events and URL does a given webhook subscription use?”
“How can I check if one webhook subscription is enabled?”
Tell an agent
Get webhook subscription {subscription_id}.
Show the settings of webhook subscription {subscription_id}.
PUT /v2/webhooks/subscriptions/{subscription_id} Update a webhook subscription · Square Update Webhook Subscription #
Ask an LLM
“How do I change the notification URL or events of a webhook subscription?”
“Can I disable a webhook subscription without deleting it?”
Tell an agent
Update webhook subscription {subscription_id} with {subscription}.
Change the events on webhook subscription {subscription_id}.
POST /v2/webhooks/subscriptions/{subscription_id}/signature-key Rotate a webhook signature key · Square Update Webhook Subscription Signature Key #
Ask an LLM
“How do I rotate the signing key used to verify my webhooks?”
“Can I replace a webhook subscription's signature key if it leaked?”
Tell an agent
Rotate the signature key for webhook subscription {subscription_id}.
Generate a new signing key on webhook subscription {subscription_id}.
POST /v2/webhooks/subscriptions/{subscription_id}/test Send a test webhook event · Square Test Webhook Subscription #
Ask an LLM
“How can I check that my webhook endpoint is receiving events?”
“Can I send a test event of a particular type to my notification URL?”
Tell an agent
Send a test event to webhook subscription {subscription_id}.
Test webhook subscription {subscription_id} with a {event_type} event.

Documentation

📖
Documentation
https://developer.squareup.com/docs/payments-overview
📖
APIReference
https://developer.squareup.com/reference/square/payments-api
📖
Documentation
https://developer.squareup.com/docs/orders-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/orders-api
📖
Documentation
https://developer.squareup.com/docs/catalog-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/catalog-api
📖
Documentation
https://developer.squareup.com/docs/inventory-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/inventory-api
📖
Documentation
https://developer.squareup.com/docs/customers
📖
APIReference
https://developer.squareup.com/reference/square/customers-api
📖
Documentation
https://developer.squareup.com/docs/locations-api
📖
APIReference
https://developer.squareup.com/reference/square/locations-api
📖
Documentation
https://developer.squareup.com/docs/team/overview
📖
APIReference
https://developer.squareup.com/reference/square/team-api
📖
Documentation
https://developer.squareup.com/docs/labor-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/labor-api
📖
Documentation
https://developer.squareup.com/docs/bookings-api/what-it-is
📖
APIReference
https://developer.squareup.com/reference/square/bookings-api
📖
Documentation
https://developer.squareup.com/docs/loyalty-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/loyalty-api
📖
Documentation
https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
📖
APIReference
https://developer.squareup.com/reference/square/gift-cards-api
📖
Documentation
https://developer.squareup.com/docs/invoices-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/invoices-api
📖
Documentation
https://developer.squareup.com/docs/subscriptions-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/subscriptions-api
📖
Documentation
https://developer.squareup.com/docs/checkout-api
📖
APIReference
https://developer.squareup.com/reference/square/checkout-api
📖
Documentation
https://developer.squareup.com/docs/terminal-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/terminal-api
📖
Documentation
https://developer.squareup.com/docs/payments-refunds
📖
APIReference
https://developer.squareup.com/reference/square/refunds-api
📖
Documentation
https://developer.squareup.com/docs/disputes-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/disputes-api
📖
Documentation
https://developer.squareup.com/docs/merchants-api
📖
APIReference
https://developer.squareup.com/reference/square/merchants-api
📖
Documentation
https://developer.squareup.com/docs/cards-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/cards-api
📖
Documentation
https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps
📖
APIReference
https://developer.squareup.com/reference/square/vendors-api
📖
Documentation
https://developer.squareup.com/docs/cashdrawershift-api/reporting
📖
APIReference
https://developer.squareup.com/reference/square/cash-drawers-api
📖
Documentation
https://developer.squareup.com/docs/bank-accounts-api
📖
APIReference
https://developer.squareup.com/reference/square/bank-accounts-api
📖
Documentation
https://developer.squareup.com/docs/payouts-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/payouts-api
📖
Documentation
https://developer.squareup.com/docs/web-payments/apple-pay
📖
APIReference
https://developer.squareup.com/reference/square/apple-pay-api
📖
Documentation
https://developer.squareup.com/docs/sites-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/sites-api
📖
Documentation
https://developer.squareup.com/docs/snippets-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/snippets-api
📖
Documentation
https://developer.squareup.com/docs/oauth-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/oauth-api
📖
Documentation
https://developer.squareup.com/docs/webhooks/overview
📖
APIReference
https://developer.squareup.com/reference/square/webhook-subscriptions-api
📖
Documentation
https://developer.squareup.com/docs/events-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/events-api
📖
Documentation
https://developer.squareup.com/docs/devices-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/devices-api
📖
Documentation
https://developer.squareup.com/docs/customer-groups-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/customer-groups-api
📖
Documentation
https://developer.squareup.com/docs/customer-segments-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/customer-segments-api
📖
Documentation
https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api
📖
APIReference
https://developer.squareup.com/reference/square/gift-card-activities-api
📖
Documentation
https://developer.squareup.com/docs/customer-custom-attributes-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/customer-custom-attributes-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-webhook-subscriptions-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/asyncapi/square-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-register-domain-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-register-domain-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-bank-accounts-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-get-bank-account-by-v1-id-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-get-bank-account-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-cash-drawer-shift-events-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-retrieve-cash-drawer-shift-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-customer-groups-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-customer-group-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-update-customer-group-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-retrieve-customer-group-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-customer-group-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-update-customer-group-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-customer-segments-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-retrieve-customer-segment-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-gift-card-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-gift-cards-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-unlink-customer-from-gift-card-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-link-customer-to-gift-card-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-retrieve-gift-card-from-ganresponse-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-retrieve-gift-card-from-nonce-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-test-webhook-subscription-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-webhook-subscriptions-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-retrieve-webhook-subscription-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-webhook-subscription-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-update-webhook-subscription-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-webhook-event-types-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/square:square-webhook-subscriptions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

square-webhook-subscriptions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2.0'
  title: Square Webhook Subscriptions API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-webhook-subscriptions-api-openapi.yml