Skip to main content
The api-request-to-your-app function type makes API requests to your Internal API.

​
Usage

This function type is used in Actions to make requests to your own application’s API endpoints.

​
Configuration Example

name: Notify Internal System
key: notify-internal
inputSchema:
  type: object
  properties:
    userId:
      type: string
    message:
      type: string
type: api-request-to-your-app
config:
  request:
    uri: /notifications
    method: POST
    body:
      userId:
        $var: $.input.userId
      message:
        $var: $.input.message
    headers:
      Content-Type: application/json
  batchSize: 10

​
Configuration Parameters

  • request.uri - Internal API endpoint URI
  • request.method - HTTP method (defaults to GET)
  • request.body - Request body
  • request.query - Query parameters
  • request.headers - HTTP headers
  • batchSize - Batch processing size (optional)
  • responseSchema - Expected response schema (optional)
  • allowNon2xx - Allow non-200 responses (optional)

​
Output Schema

type: object
properties:
  response:
    type: object
    properties:
      status:
        type: integer
      data:
        # Based on responseSchema