ListWebhooksResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bendigo-and-adelaide-bank/main/json-schema/bendigo-and-adelaide-bank-list-webhooks-response-schema.json",
  "title": "ListWebhooksResponse",
  "description": "Successful response to get all webhooks. This returns a paginated list of\nwebhooks, which can be scrolled by following the `prev` and `next` links\nif present.\n",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/bendigo-and-adelaide-bank-webhooks-api-openapi.yml#/components/schemas/ListWebhooksResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/WebhookResource"
      },
      "description": "The list of webhooks returned in this response.\n"
    },
    "links": {
      "type": "object",
      "properties": {
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "The link to the previous page in the results. If this value is `null`\nthere is no previous page.\n"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "The link to the next page in the results. If this value is `null`\nthere is no next page.\n"
        }
      },
      "required": [
        "prev",
        "next"
      ]
    }
  },
  "required": [
    "data",
    "links"
  ],
  "$defs": {
    "WebhookResource": {
      "type": "object",
      "description": "Provides information about a webhook.\n",
      "properties": {
        "type": {
          "type": "string",
          "description": "The type of this resource: `webhooks`"
        },
        "id": {
          "type": "string",
          "description": "The unique identifier for this webhook.\n"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "url": {
              "type": "string",
              "description": "The URL that this webhook is configured to `POST` events to.\n"
            },
            "description": {
              "type": [
                "string",
                "null"
              ],
              "description": "An optional description that was provided at the time the webhook was\ncreated.\n"
            },
            "secretKey": {
              "type": "string",
              "description": "A shared secret key used to sign all webhook events sent to the\nconfigured webhook URL. This field is returned only once, upon the\ninitial creation of the webhook. If lost, create a new webhook and\ndelete this webhook.\n\nThe webhook URL receives a request with a\n`X-Up-Authenticity-Signature` header, which is the SHA-256 HMAC of\nthe entire raw request body signed using this `secretKey`. It is\nadvised to compute and check this signature to verify the\nauthenticity of requests sent to the webhook URL. See\n[Handling webhook events](#callback_post_webhookURL) for full\ndetails.\n"
            },
            "createdAt": {
              "type": "string",
              "format": "date-time",
              "description": "The date-time at which this webhook was created.\n"
            }
          },
          "required": [
            "url",
            "description",
            "createdAt"
          ]
        },
        "relationships": {
          "type": "object",
          "properties": {
            "logs": {
              "type": "object",
              "properties": {
                "links": {
                  "type": "object",
                  "properties": {
                    "related": {
                      "type": "string",
                      "description": "The link to retrieve the related resource(s) in this relationship.\n"
                    }
                  },
                  "required": [
                    "related"
                  ]
                }
              }
            }
          },
          "required": [
            "logs"
          ]
        },
        "links": {
          "type": "object",
          "properties": {
            "self": {
              "type": "string",
              "description": "The canonical link to this resource within the API.\n"
            }
          },
          "required": [
            "self"
          ]
        }
      },
      "required": [
        "type",
        "id",
        "attributes",
        "relationships"
      ]
    }
  }
}