api-request-to-external-app Function Type

The api-request-to-external-app function type makes arbitrary API requests to the API of the current external app with authentication applied automatically.

Usage

This function type is used in Actions to make authenticated API requests to external applications.

Configuration Example

name: Create Issue
key: create-issue
inputSchema:
  type: object
  properties:
    projectId:
      type: string
    title:
      type: string
    priority:
      type: string
type: api-request-to-external-app
config:
  request:
    path: /projects/{projectId}/issues
    method: POST
    pathParameters:
      projectId:
        $var: $.input.projectId
    query:
      notify: true
    data:
      summary:
        $var: $.input.title
      priority:
        $var: $.input.priority
    headers:
      X-API-Version: "2025-01-01"
      Content-Type: application/json
  responseSchema:
    type: object
    properties:
      id:
        type: string
      key:
        type: string
  allowNon2xx: false

Configuration Parameters

request.path - API endpoint path (supports {paramName} substitution)
request.method - HTTP method (GET, POST, PUT, DELETE, etc.) - defaults to GET
request.pathParameters - Path parameter substitutions
request.query - Query parameters
request.data - Request body
request.headers - Additional headers
responseSchema - Expected response schema (optional)
allowNon2xx - Allow non-200 responses (default: false)

Output Schema

type: object
properties:
  status:
    type: number
  data:
    # Based on responseSchema or generic object