Square API
You are viewing an old version of the API
Webhook Subscriptions
Square API
Create and manage webhook subscriptions.
The Webhook Subscriptions API allows you to create, retrieve, update, and delete webhook subscriptions.
Guides: Webhook Subscriptions
Endpoints
-
List webhook event types
GET /v2/webhooks/event-types - Lists all webhook event types that can be subscribed to.
BETA -
List webhook subscriptions
GET /v2/webhooks/subscriptions - Lists all webhook subscriptions owned by your application.
BETA -
Create webhook subscription
POST /v2/webhooks/subscriptions - Creates a webhook subscription.
BETA -
Delete webhook subscription
DELETE /v2/webhooks/subscriptions/{subscription_id} - Deletes a webhook subscription.
BETA -
Retrieve webhook subscription
GET /v2/webhooks/subscriptions/{subscription_id} - Retrieves a webhook subscription identified by its ID.
BETA -
Update webhook subscription
PUT /v2/webhooks/subscriptions/{subscription_id} - Updates a webhook subscription.
BETA -
Update webhook subscription signature key
POST /v2/webhooks/subscriptions/{subscription_id}/signature-key - Updates a webhook subscription by replacing the existing signature key with a new one.
BETA -
Test webhook subscription
POST /v2/webhooks/subscriptions/{subscription_id}/test - Tests a webhook subscription by sending a test event to the notification URL.
BETA