Execute an action

Executes an action, which is defined by its own schema. To obtain the schema and data for any action within XPipe, use the action shortcut menu.

Authorization

AuthorizationRequiredBearer <token>

The bearer token used is the session token that you receive from the handshake exchange.

In: header

Request Body

application/jsonRequired

actionRequiredobject

The raw action data in json form. The best way to obtain this data is to use the action shortcut creation functionality.

confirmRequiredboolean

If the action is modifying something and the category has been configured to confirm all modifications, a confirmation dialog will be shown if this is is true.

curl -X POST "http://localhost:21721/action" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "action": {
      "ref": "f0ec68aa-63f5-405c-b178-9a4454556d6b",
      "id": "launch"
    },
    "confirm": false
  }'

The action was executed successfully.