headless lms

Invoke one of a connection's actions

POST /api/integrations/{id}/actions/{actionId}. Invoke one of a connection's actions. Headless LMS Integrations API reference.

POST
/api/integrations/{id}/actions/{actionId}

Requires integrations:write. Runs the action, such as a listing that feeds a picker, with input checked against its input schema. 400 when the action fails or rejects the input; 404 when the connection or action does not exist; 409 when the connection is inactive.

Path Parameters

id*string
actionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/integrations/string/actions/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "output": {    "property1": null,    "property2": null  }}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}