cliDeterministic

List webhook endpoints

Name: Pipeline
Price: 99 USD

pipeline list-webhook-endpoints

List outbound webhook endpoints in the workspace, including subscriptions, filters, status, health, and recent delivery state. Secrets are never returned.

Parameters

workspaceId

string

No description.

Example

CLI commandbash

pipeline list-webhook-endpoints

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "endpoints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "workspaceId": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "eventTypes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "filters": {
            "type": "object"
          },
          "apiVersion": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused",
              "auto_paused"
            ]
          },
          "pauseReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "health": {
            "type": "string",
            "enum": [
              "never_delivered",
              "healthy",
              "failing"
            ]
          },
          "destinationAuth": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "headerName": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "configured": {
                "type": "boolean"
              }
            },
            "required": [
              "type",
              "headerName",
              "configured"
            ]
          },
          "consecutiveFailures": {
            "type": "number"
          },
          "lastSuccessAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastFailureAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastError": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "workspaceId",
          "name",
          "url",
          "eventTypes",
          "filters",
          "apiVersion",
          "status",
          "pauseReason",
          "health",
          "destinationAuth",
          "consecutiveFailures",
          "lastSuccessAt",
          "lastFailureAt",
          "lastError",
          "createdAt",
          "updatedAt"
        ]
      }
    }
  },
  "required": [
    "endpoints"
  ]
}

Exit codes

1: Invalid input or local configuration.
2: The API or tool returned an error.
3: Authentication failed.
4: A network request failed.