{
  "opencollection": "1.0.0",
  "info": {
    "name": "papi alert-query-proxy workflows API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "workflows",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List workflows for a workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v3/workspaces/:workspace_short_name/workflows",
            "params": [
              {
                "name": "workspace_short_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of results to skip"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List all workflows for a workspace.\n\nArgs:\n    request: The HTTP request.\n    workspace_short_name: The short name of the workspace.\n    limit: Maximum number of results to return.\n    offset: Number of results to skip.\n    session: Database session.\n    current_user: The authenticated user.\n\nReturns:\n    Paginated list of workflows.\n\nRaises:\n    HTTPException: 404 if workspace not found."
        },
        {
          "info": {
            "name": "Get a workflow by short name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v3/workspaces/:workspace_short_name/workflows/:workflow_short_name",
            "params": [
              {
                "name": "workspace_short_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "workflow_short_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get a workflow by its short name.\n\nArgs:\n    workspace_short_name: The short name of the workspace.\n    workflow_short_name: The short name of the workflow.\n    session: Database session.\n    current_user: The authenticated user.\n\nReturns:\n    The workflow details.\n\nRaises:\n    HTTPException: 404 if workspace or workflow not found."
        },
        {
          "info": {
            "name": "Get workflow webhook URL",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v3/workspaces/:workspace_short_name/workflows/:workflow_short_name/webhook-url",
            "params": [
              {
                "name": "workspace_short_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "workflow_short_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get the webhook URL for a workflow.\n\nArgs:\n    workspace_short_name: The workspace name.\n    workflow_short_name: The workflow short name.\n    session: Database session.\n    current_user: The authenticated user.\n\nReturns:\n    Webhook URL."
        },
        {
          "info": {
            "name": "Get workflow webhook token (admin only)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v3/workspaces/:workspace_short_name/workflows/:workflow_short_name/token",
            "params": [
              {
                "name": "workspace_short_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "workflow_short_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get the webhook token for a workflow.\n\nThis endpoint can only be called once. After the token is retrieved,\nyou must rotate it to get a new one.\n\nArgs:\n    workspace_short_name: The workspace name.\n    workflow_short_name: The workflow short name.\n    session: Database session.\n    current_user: The authenticated user.\n\nReturns:\n    Webhook URL and token."
        },
        {
          "info": {
            "name": "Rotate workflow webhook token (admin only)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v3/workspaces/:workspace_short_name/workflows/:workflow_short_name/rotate-token",
            "params": [
              {
                "name": "workspace_short_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "workflow_short_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Rotate the webhook token for a workflow.\n\nThis triggers regeneration of the webhook token.\n\nArgs:\n    workspace_short_name: The workspace name.\n    workflow_short_name: The workflow short name.\n    session: Database session.\n    current_user: The authenticated user."
        },
        {
          "info": {
            "name": "Run a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v3/workspaces/:workspace_short_name/workflows/:workflow_short_name/run",
            "params": [
              {
                "name": "workspace_short_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "workflow_short_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Run a workflow by sending a webhook event.\n\nArgs:\n    workspace_short_name: The workspace name.\n    workflow_short_name: The workflow short name.\n    request: The HTTP request containing run parameters.\n    session: Database session.\n    current_user: The authenticated user."
        }
      ]
    }
  ],
  "bundled": true
}