List webhooks

The addresses this account sends events to, and how each is doing.

GET/api/v1/webhooks

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the webhooks:manage scope — add, change and delete webhooks.

webhooks:manageRead onlyMCP tool: list_webhooks

Parameters

Named placeholders go in the path; the rest in the query string.

No parameters.

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/webhooks' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{}

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "site": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "name"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ],
            "description": "The one site whose events it hears; null = every site (and your shop orders)."
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "secret_prefix": {
            "type": "string",
            "description": "The first characters of the signing secret, to tell secrets apart."
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused"
            ]
          },
          "paused_reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "failures_in_a_row": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "last_success_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "last_failure_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "is_sample": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "url",
          "events",
          "site",
          "description",
          "secret_prefix",
          "status",
          "paused_reason",
          "failures_in_a_row",
          "last_success_at",
          "last_failure_at",
          "is_sample",
          "created_at"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}