{ "info": { "_postman_id": "616c3020-5354-422a-a814-afeea2f6ef4e", "name": "Square ApplePay WebhookSubscriptions API", "description": "Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. \n\nContact Support:\n Name: Square Developer Platform\n Email: developers@squareup.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "lastUpdatedBy": "35240", "uid": "35240-616c3020-5354-422a-a814-afeea2f6ef4e" }, "item": [ { "name": "v2", "item": [ { "name": "webhooks", "item": [ { "name": "event-types", "item": [ { "name": "Square List Webhook Event Types", "id": "04a424e8-2e09-408a-b80e-ccc2ac3b7a2f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/event-types?api_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "event-types" ], "query": [ { "description": "The API version for which to list event types. Setting this field overrides the default version used by the application.", "key": "api_version", "value": "" } ] }, "description": "Lists all webhook event types that can be subscribed to." }, "response": [ { "id": "9d1dd9df-b047-4d2b-9f52-4f90dfdf0fac", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/event-types?api_version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "event-types" ], "query": [ { "description": "The API version for which to list event types. Setting this field overrides the default version used by the application.", "key": "api_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"CARD_MISMATCH\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"EXPECTED_BOOLEAN\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"metadata\": [\n {\n \"event_type\": \"\",\n \"api_version_introduced\": \"\",\n \"release_status\": \"\"\n },\n {\n \"event_type\": \"\",\n \"api_version_introduced\": \"\",\n \"release_status\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-9d1dd9df-b047-4d2b-9f52-4f90dfdf0fac" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-04a424e8-2e09-408a-b80e-ccc2ac3b7a2f" } ], "id": "70938e19-1a77-4d7c-a260-47c748615419", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-70938e19-1a77-4d7c-a260-47c748615419" }, { "name": "subscriptions", "item": [ { "name": "{subscription_id}", "item": [ { "name": "signature-key", "item": [ { "name": "Square Update Webhook Subscription Signature Key", "id": "8e5119fd-9f2e-4d05-95f4-43fe3bb4ac3f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id/signature-key", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id", "signature-key" ], "variable": [ { "id": "98103a67-2e99-4e1e-9d2f-6ffc086e3c54", "key": "subscription_id", "value": "", "description": "(Required) [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update." } ] }, "description": "Updates a webhook subscription by replacing the existing signature key with a new one." }, "response": [ { "id": "e4e0d99b-e9d5-4eb6-b96f-8bd3587ef766", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id/signature-key", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id", "signature-key" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"INVALID_EXPIRATION\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CARD_EXPIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"signature_key\": \"\"\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-e4e0d99b-e9d5-4eb6-b96f-8bd3587ef766" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-8e5119fd-9f2e-4d05-95f4-43fe3bb4ac3f" } ], "id": "274fc1df-eda8-4282-a58e-b55866844240", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-274fc1df-eda8-4282-a58e-b55866844240" }, { "name": "test", "item": [ { "name": "Square Test Webhook Subscription", "id": "8342e539-0342-4e71-95fc-1c2a5046da85", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"event_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id/test", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id", "test" ], "variable": [ { "id": "3b0bb533-73a2-4021-8a71-74e541da28d9", "key": "subscription_id", "value": "", "description": "(Required) [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test." } ] }, "description": "Tests a webhook subscription by sending a test event to the notification URL." }, "response": [ { "id": "e6671672-fab4-4825-8084-91206794c486", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"event_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id/test", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id", "test" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"INVALID_CURSOR\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"INSUFFICIENT_SCOPES\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription_test_result\": {\n \"id\": \"\",\n \"status_code\": \"\",\n \"payload\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-e6671672-fab4-4825-8084-91206794c486" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-8342e539-0342-4e71-95fc-1c2a5046da85" } ], "id": "a13f1197-3c89-4cd2-9e82-02273e6088b1", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-a13f1197-3c89-4cd2-9e82-02273e6088b1" }, { "name": "Square Delete Webhook Subscription", "id": "8f88da66-95cf-4663-96f1-3e4a1c0cd044", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id" ], "variable": [ { "id": "f80f5529-1b19-4f8a-8c4b-9da778aaa22a", "key": "subscription_id", "value": "", "description": "(Required) [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete." } ] }, "description": "Deletes a webhook subscription." }, "response": [ { "id": "a92cfca3-a8be-4321-97c8-0f897fd52c59", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"BUYER_REFUSED_PAYMENT\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"CARD_DECLINED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-a92cfca3-a8be-4321-97c8-0f897fd52c59" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-8f88da66-95cf-4663-96f1-3e4a1c0cd044" }, { "name": "Square Retrieve Webhook Subscription", "id": "f3338823-a79e-4d68-9582-7dc7e19f5be6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id" ], "variable": [ { "id": "3388abff-772f-44a2-a53c-e7885de6cf1f", "key": "subscription_id", "value": "", "description": "(Required) [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve." } ] }, "description": "Retrieves a webhook subscription identified by its ID." }, "response": [ { "id": "5fc98053-ee5d-479c-9177-84e52f1aeeb6", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"UNAUTHORIZED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CARD_PROCESSING_NOT_ENABLED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-5fc98053-ee5d-479c-9177-84e52f1aeeb6" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-f3338823-a79e-4d68-9582-7dc7e19f5be6" }, { "name": "Square Update Webhook Subscription", "id": "63edb516-a068-453b-a65a-0f285e41a725", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id" ], "variable": [ { "id": "3453ea27-1fc1-4636-aad4-cd2049536c0c", "key": "subscription_id", "value": "", "description": "(Required) [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update." } ] }, "description": "Updates a webhook subscription." }, "response": [ { "id": "c3cea58d-3ea6-4d81-8c4b-b2ef70c08335", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions/:subscription_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions", ":subscription_id" ], "variable": [ { "key": "subscription_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"API_VERSION_INCOMPATIBLE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"INVALID_ENCRYPTED_CARD\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-c3cea58d-3ea6-4d81-8c4b-b2ef70c08335" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-63edb516-a068-453b-a65a-0f285e41a725" } ], "id": "7f9826f6-45f6-4c75-a18b-ad570d43246a", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-7f9826f6-45f6-4c75-a18b-ad570d43246a" }, { "name": "Square List Webhook Subscriptions", "id": "a1422b54-5f5c-49de-bca1-6349cfa64804", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions?cursor=&include_disabled=false&sort_order=ASC&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "Includes disabled [Subscription](entity:WebhookSubscription)s.\nBy default, all enabled [Subscription](entity:WebhookSubscription)s are returned.", "key": "include_disabled", "value": "false" }, { "description": "Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", "key": "sort_order", "value": "ASC" }, { "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100", "key": "limit", "value": "" } ] }, "description": "Lists all webhook subscriptions owned by your application." }, "response": [ { "id": "3374a3ef-1200-431d-93eb-32e66e0fb7f9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions?cursor=&include_disabled=false&sort_order=ASC&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "description": "Includes disabled [Subscription](entity:WebhookSubscription)s.\nBy default, all enabled [Subscription](entity:WebhookSubscription)s are returned.", "key": "include_disabled", "value": "false" }, { "description": "Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.\nThis field defaults to ASC.", "key": "sort_order", "value": "ASC" }, { "description": "The maximum number of results to be returned in a single page.\nIt is possible to receive fewer results than the specified limit on a given page.\nThe default value of 100 is also the maximum allowed value.\n\nDefault: 100", "key": "limit", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_EMAIL_ADDRESS\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"UNKNOWN_BODY_PARAMETER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscriptions\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-3374a3ef-1200-431d-93eb-32e66e0fb7f9" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-a1422b54-5f5c-49de-bca1-6349cfa64804" }, { "name": "Square Create Webhook Subscription", "id": "dfbe3fcf-25ef-4bdc-9e78-9e6570791b21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions" ] }, "description": "Creates a webhook subscription." }, "response": [ { "id": "c28d3af2-94ef-488e-a3c1-5b7b40985bcd", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"subscription\": {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/webhooks/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v2", "webhooks", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"ONE_INSTRUMENT_EXPECTED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_POSTAL_CODE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"subscription\": {\n \"id\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"notification_url\": \"\",\n \"api_version\": \"\",\n \"signature_key\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-c28d3af2-94ef-488e-a3c1-5b7b40985bcd" } ], "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-dfbe3fcf-25ef-4bdc-9e78-9e6570791b21" } ], "id": "5e6efe51-7036-46c1-b9c9-ea160fd737e8", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-5e6efe51-7036-46c1-b9c9-ea160fd737e8" } ], "id": "20e84bb2-69e6-4c8e-9279-44b3bbabb146", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-20e84bb2-69e6-4c8e-9279-44b3bbabb146" } ], "id": "dfeda9c3-f75a-4231-aa9e-9d1c54e35f0f", "createdAt": "2026-07-28T03:04:51.000Z", "updatedAt": "2026-07-28T03:04:51.000Z", "uid": "35240-dfeda9c3-f75a-4231-aa9e-9d1c54e35f0f" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }