• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List webhook event types BETA

GET /v2/webhooks/event-types

Lists all webhook event types that can be subscribed to.

Name Description
api_version
string

The API version for which to list event types. Setting this field overrides the default version used by the application.

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

event_types
string [ ]

The list of event types.

metadata
EventTypeMetadata [ ]

Contains the metadata of a webhook event type. For more information, see EventTypeMetadata.

Examples

You are viewing an old version of the API
GET /v2/webhooks/event-types
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/webhooks/event-types \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "event_types": [
    "inventory.count.updated"
  ],
  "metadata": [
    {
      "event_type": "inventory.count.updated",
      "api_version_introduced": "2018-07-12",
      "release_status": "PUBLIC"
    }
  ]
}