Square WebhookSubscriptions API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Webhook Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
8 operations
across 5 paths,
and defines 19 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://connect.squareup.com.
8 operations5 paths19 schemas1 DELETE3 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Square WebhookSubscriptions API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes.
An API key is passed in the header as Authorization (oauth2ClientSecret).
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are WebhookSubscription (9 properties), SubscriptionTestResult (5 properties), Error (4 properties), ListWebhookEventTypesResponse (3 properties). Each schema is shown below with its type and property counts.
EventTypeMetadata
object
Contains the metadata of a webhook event type.
3 properties
TestWebhookSubscriptionResponse
object
Defines the fields that are included in the response body of a request to the [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscripti…
2 properties
WebhookSubscription
object
Represents the details of a webhook subscription, including notification URL, event types, and signature key.
9 properties
ListWebhookSubscriptionsResponse
object
Defines the fields that are included in the response body of a request to the [ListWebhookSubscriptions](api-endpoint:WebhookSubscriptions-ListWebhookSubscript…
3 properties
RetrieveWebhookSubscriptionResponse
object
Defines the fields that are included in the response body of a request to the [RetrieveWebhookSubscription](api-endpoint:WebhookSubscriptions-RetrieveWebhookSu…
2 properties
SubscriptionTestResult
object
Represents the details of a webhook subscription, including notification URL, event types, and signature key.
5 properties
UpdateWebhookSubscriptionResponse
object
Defines the fields that are included in the response body of a request to the [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscr…
2 properties
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
ListWebhookEventTypesResponse
object
Defines the fields that are included in the response body of a request to the [ListWebhookEventTypes](api-endpoint:WebhookSubscriptions-ListWebhookEventTypes)…
3 properties
CreateWebhookSubscriptionRequest
object
Creates a [Subscription](entity:WebhookSubscription).
2 properties1 required
UpdateWebhookSubscriptionSignatureKeyRequest
object
Updates a [Subscription](entity:WebhookSubscription) by replacing the existing signature key with a new one.
1 property
TestWebhookSubscriptionRequest
object
Tests a [Subscription](entity:WebhookSubscription) by sending a test event to its notification URL.
1 property
UpdateWebhookSubscriptionRequest
object
Updates a [Subscription](entity:WebhookSubscription).
1 property
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
CreateWebhookSubscriptionResponse
object
Defines the fields that are included in the response body of a request to the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscr…
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
UpdateWebhookSubscriptionSignatureKeyResponse
object
Defines the fields that are included in the response body of a request to the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateW…
2 properties
DeleteWebhookSubscriptionResponse
object
Defines the fields that are included in the response body of a request to the [DeleteWebhookSubscription](api-endpoint:WebhookSubscriptions-DeleteWebhookSubscr…
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Square WebhookSubscriptions API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
