Skip to content

overlane connector approval

Post an approval request to a chat connector's channel

Updated View as MarkdownOpen in ChatGPTOpen in Claude

Posts a pending approval (from overlane autonomy approvals request) to a channel in a connected chat service (Slack, or Microsoft Teams as an Adaptive Card) with Approve and Deny buttons. A person answers there; the signed answer comes back through the connector’s webhook and counts when the chat user is mapped to a team member (overlane connector chat-user) who is not the one who asked.

Usage

overlane connector approval provider [--service URL] [--team TENANT_ID] --approval-id ID --channel ID --summary TEXT [--dry-run]

Arguments

Argument Required Description
provider yes The connector, such as slack or linear (see overlane connector list)

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)
--approval-id string yes The pending approval to post
--channel string yes The channel ID to post it in
--summary string yes What is being approved, in a sentence
--dry-run boolean no Print the requests and file changes this command would make, then stop. Needs no credentials.

Examples

overlane connector approval slack --approval-id aut_123 --channel C01GENERAL --summary 'Promote release 1.2.3'
overlane connector approval teams --approval-id aut_123 --channel '19:abc@thread.tacv2' --summary 'Promote release 1.2.3'

Behavior

  • Effect: write (changes local or hosted state).
  • Needs credentials: yes. Uses the network: yes.
  • Supports --dry-run: yes. Accepts --force: no.
  • Machine-readable description: overlane schema connector approval.

Result

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

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "provider": {
          "type": "string"
        },
        "approvalId": {
          "type": "string"
        },
        "posted": {
          "type": "boolean",
          "const": true
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "provider",
        "approvalId",
        "posted",
        "next"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.