List webhook event types BETA
GET
/v2/webhooks/event-types
Lists all webhook event types that can be subscribed to.
Name | Description |
---|---|
api_
|
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
|
Information on errors encountered during the request. |
event_
|
The list of event types. |
metadata
|
Contains the metadata of a webhook event type. For more information, see EventTypeMetadata. |
Examples
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: 2023-01-19' \
-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"
}
]
}