WebhookSubscriptions
Create, update, delete, and query Square Webhook Subscriptions. NOTE: This endpoint requires a Personal Access Token for authentication. OAuth access tokens are not supported by Square for this API.
Table Specific Information
Select
The add-in uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the add-in.
- Id supports the following operator: =.
Retrieve all webhook subscriptions:
SELECT * FROM WebhookSubscriptions
Retrieve a specific webhook subscription:
SELECT * FROM WebhookSubscriptions WHERE Id = 'subscription_id_here'
Note: This endpoint requires a Personal Access Token for authentication. OAuth access tokens are not supported by Square for this API.
Insert
To create a webhook subscription, specify the desired NotificationUrl and EventTypes columns.
INSERT INTO WebhookSubscriptions (Name, NotificationUrl, EventTypes, Enabled) VALUES ('My Webhook', 'https://example.com/webhook', '["payment.created","payment.updated"]', true)
Update
Modify the details of an existing webhook subscription by providing the Id:
UPDATE WebhookSubscriptions SET Name = 'Updated Webhook', Enabled = false WHERE Id = 'subscription_id_here'
Delete
Delete a webhook subscription by providing the Id:
DELETE FROM WebhookSubscriptions WHERE Id = 'subscription_id_here'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A Square-generated unique ID for the subscription. |
| Name | String | False |
The name of this subscription. |
| Enabled | Boolean | False |
Indicates whether the subscription is enabled (true) or not (false). |
| EventTypes | String | False |
The event types associated with this subscription. |
| NotificationUrl | String | False |
The URL to which webhooks are sent. |
| ApiVersion | String | False |
The API version of the subscription. This field is optional for CreateWebhookSubscription. The value defaults to the API version used by the application. |
| SignatureKey | String | True |
The Square-generated signature key used to validate the origin of the webhook event. |
| CreatedAt | Datetime | True |
The timestamp of when the subscription was created, in RFC 3339 format. |
| UpdatedAt | Datetime | True |
The timestamp of when the subscription was last updated, in RFC 3339 format. |
Pseudocolumns
Pseudo column fields are used in the WHERE clause of SELECT statements (unless stated otherwise) and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| IdempotencyKey | String |
A unique string that identifies the request. Supported only for INSERT operations. Maximum length is 45 characters. |