DocsCall action
Call an action on an installed app
Bearer token authentication. Use your API key as the bearer token.
In: header
Call action input
ActionIdentifier is the unique identifier for the action to be called. Format: "blueprint_uid@v/actions/action_uid" if blueprint context is available.
BlueprintID is the specific blueprint ID to use. If set, overrides the blueprint derived from ActionIdentifier. Useful for calling actions from draft blueprints or specific blueprint versions.
ConnectionID is the ID of the connection to use for the action. If not set, the default connection will be used if the action requires a connection and a common connection is available in the matrix. If the action does not require a connection, this field will be ignored.
FlowMode indicates whether the action is called as part of a flow execution. When true, step output options will be processed and flow-specific behavior is enabled.
Input contains the input data to pass to the action. The structure depends on the specific action being called.
ParentTaskID is the ID of the parent task if this action is being called as a subtask. Used for task hierarchy and tracking purposes.
WaitForResult controls whether the call should wait for the action to complete. If true or not set, the call blocks until the action completes and returns the result. If false, the call returns immediately with the task info, and the action executes asynchronously.
Response Body
curl -X POST "https://eu1.api.bivariant.com/v1/apps/actions/call" \ -H "Content-Type: application/json" \ -d '{ "actionIdentifier": "string" }'{
"data": null,
"error": {
"code": "string",
"message": "string"
},
"options": [
"string"
],
"task": {
"appId": "string",
"authorId": "string",
"children": [
{
"appId": "string",
"authorId": "string",
"children": [],
"createdAt": "string",
"description": "string",
"endedAt": "string",
"errors": [
{
"code": "string",
"message": "string"
}
],
"executorId": "string",
"id": "string",
"input": null,
"kind": "default",
"organizationId": "string",
"output": null,
"params": {
"property1": null,
"property2": null
},
"parentId": "string",
"startedAt": "string",
"stateId": "string",
"status": "created",
"targetId": "string",
"title": "string",
"updatedAt": "string"
}
],
"createdAt": "string",
"description": "string",
"endedAt": "string",
"errors": [
{
"code": "string",
"message": "string"
}
],
"executorId": "string",
"id": "string",
"input": null,
"kind": "default",
"organizationId": "string",
"output": null,
"params": {
"property1": null,
"property2": null
},
"parentId": "string",
"startedAt": "string",
"stateId": "string",
"status": "created",
"targetId": "string",
"title": "string",
"updatedAt": "string"
}
}{
"code": "string",
"message": "string"
}{
"code": "string",
"message": "string"
}{
"code": "string",
"message": "string"
}{
"code": "string",
"message": "string"
}