subscriptionCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/acculynx/json-schema/acculynx-subscription-collection-schema.json",
  "title": "subscriptionCollection",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/acculynx-webhooks-api-openapi.yml#/components/schemas/subscriptionCollection",
  "allOf": [
    {
      "$ref": "#/$defs/baseCollection"
    },
    {
      "description": "A paginated collection of webhook subscriptions.\nContains both pagination metadata and the list of subscriptions.\n",
      "properties": {
        "items": {
          "description": "The list of subscription objects for this page of results.\nEach item contains complete subscription details.\n",
          "items": {
            "$ref": "#/$defs/subscription"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  ],
  "$defs": {
    "baseCollection": {
      "description": "Base structure for all paginated collection responses.\nThis provides consistent pagination metadata across all collection endpoints.\n",
      "properties": {
        "count": {
          "description": "The total number of items available across all pages.\nUse this to calculate the total number of pages available.\n",
          "type": "integer"
        },
        "pageSize": {
          "description": "The number of items per page in this response.\nThis reflects either your requested page size or the default value.\n",
          "type": "integer"
        },
        "pageStartIndex": {
          "description": "The starting index of this page of results.\nUse with pageSize to track your position in the overall result set.\n",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "subscription": {
      "allOf": [
        {
          "$ref": "#/$defs/subscriptionLink"
        },
        {
          "description": "Complete subscription details.\nContains all information about a webhook subscription including its configuration and status.\n",
          "properties": {
            "consumerUrl": {
              "description": "The URL where webhook events are sent for this subscription.\nAll webhook events will be sent as POST requests to this URL.\n",
              "type": "string"
            },
            "createdDate": {
              "description": "The date and time when this subscription was created.\nAlways provided in UTC format.\n",
              "format": "date-time",
              "type": "string"
            },
            "modifiedDate": {
              "description": "The date and time when this subscription was last modified.\nAlways provided in UTC format.\nUpdates when any subscription property changes.\n",
              "format": "date-time",
              "type": "string"
            },
            "status": {
              "description": "The current status of the subscription. - enabled: The subscription is active and will receive webhook events - disabled: The subscription is inactive and will not receive webhook events\n",
              "enum": [
                "enabled",
                "disabled"
              ],
              "type": "string"
            },
            "tech_contact": {
              "description": "The technical contact email address for this subscription.\nAccuLynx will use this email to communicate important information about the subscription.\n",
              "format": "email",
              "type": "string"
            },
            "topicNames": {
              "description": "List of event topics this subscription is listening for.\nOnly events matching these topic names will be sent to the consumer URL.\n",
              "items": {
                "type": "string"
              },
              "minItems": 1,
              "type": "array",
              "uniqueItems": true
            },
            "integrationType": {
              "description": "The current integration type of the subscription.\n",
              "enum": [
                "Api",
                "Zapier"
              ],
              "type": "string"
            }
          },
          "type": "object"
        }
      ]
    },
    "subscriptionLink": {
      "description": "Basic subscription reference information.\nContains identifiers that can be used to reference a specific subscription.\n",
      "properties": {
        "_link": {
          "description": "The full URI that can be used to access this subscription.\nThis is a convenience to avoid having to construct the URL yourself.\n",
          "type": "string",
          "format": "uri"
        },
        "id": {
          "description": "The unique identifier of the subscription.\nUse this ID in path parameters when working with specific subscriptions.\n",
          "format": "uuid",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}