overlane webhook list | Overlane Docs

Lists the team’s outbound webhooks with their endpoint, events and status.

Usage

overlane webhook list [--service URL] [--team TENANT_ID]

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no		The team (tenant) to act on (default: the one your token belongs to)

Examples

overlane webhook list

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema webhook list.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "webhooks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "webhookId": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "type": "string"
          },
          "keyVersion": {
            "type": "number"
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "webhookId",
          "url",
          "events",
          "status",
          "keyVersion",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "webhooks"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.