{
  "opencollection": "1.0.0",
  "info": {
    "name": "Square ApplePay WebhookSubscriptions API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "WebhookSubscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Square List Webhook Event Types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/webhooks/event-types",
            "params": [
              {
                "name": "api_version",
                "value": "",
                "type": "query",
                "description": "The API version for which to list event types. Setting this field overrides the default version used by the application."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Lists all webhook event types that can be subscribed to."
        },
        {
          "info": {
            "name": "Square List Webhook Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/webhooks/subscriptions",
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "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)."
              },
              {
                "name": "include_disabled",
                "value": "",
                "type": "query",
                "description": "Includes disabled [Subscription](entity:WebhookSubscription)s.\nBy default, all enabled [Subscription](entity:WebhookSubscription)s are returned."
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query",
                "description": "Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.\nThis field defaults to ASC."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "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"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Lists all webhook subscriptions owned by your application."
        },
        {
          "info": {
            "name": "Square Create Webhook Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/webhooks/subscriptions",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a webhook subscription."
        },
        {
          "info": {
            "name": "Square Retrieve Webhook Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves a webhook subscription identified by its ID."
        },
        {
          "info": {
            "name": "Square Update Webhook Subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates a webhook subscription."
        },
        {
          "info": {
            "name": "Square Delete Webhook Subscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes a webhook subscription."
        },
        {
          "info": {
            "name": "Square Update Webhook Subscription Signature Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id/signature-key",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates a webhook subscription by replacing the existing signature key with a new one."
        },
        {
          "info": {
            "name": "Square Test Webhook Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/webhooks/subscriptions/:subscription_id/test",
            "params": [
              {
                "name": "subscription_id",
                "value": "",
                "type": "path",
                "description": "[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Tests a webhook subscription by sending a test event to the notification URL."
        }
      ]
    }
  ],
  "bundled": true
}