Invoke Function
Overview
Calls a connected function deployed to this tenant
Category: Integration
Use this action to call a connected function that a package has deployed to this tenant. The request is authenticated with a platform-issued token for the tenant, the same way the data actions authenticate, so no API token has to be created and stored in a configuration variable.
Request
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
packageName |
string | Yes | The name of the installed package the function belongs to | simulator |
functionName |
string | Yes | The name of the function within the package | simulator |
route |
string | No | The route passed to the function’s handler, for example /actions/tick. Defaults to the function’s root route | /actions/tick |
method |
string | No | Values: GET, POST, PUT, PATCH, DELETEDefault: POST |
|
queryString |
object | No | Query string parameters appended to the request, as string key/value pairs | {"region":"auckland"} |
body |
any | No | JSON body to send with the request | {"mode":"tick"} |
Response
This action’s output is available as $invokeFunction in JSONata expressions. See Response format for the standard result.data / result.errors structure and error handling patterns.
| Field | Type | Description |
|---|---|---|
result.data.* |
object | The function’s JSON response body, or null when the function returns no body |
statusCode |
integer | HTTP status code returned by the function |
Example output:
{
"processed": 3
}
Feedback
Was this page helpful?