Actions API

Execute and manage workflow actions programmatically.

Overview

The Actions API provides endpoints for managing and executing workflow actions within mindzieStudio. Actions are automated workflow components that can be executed on demand or on schedule.

Base URL Structure

All Action API endpoints follow this pattern:

/api/{tenantId}/{projectId}/action/...

Path Parameters:

Parameter Type Description
tenantId GUID Your tenant identifier
projectId GUID Your project identifier

Available Endpoints

Health Monitoring

Test connectivity and validate authentication.

  • GET /api/{tenantId}/{projectId}/action/unauthorized-ping - Basic connectivity test (no auth required)
  • GET /api/{tenantId}/{projectId}/action/ping - Authenticated connectivity test

View Ping Documentation

Action Management

List and retrieve action details.

  • GET /api/{tenantId}/{projectId}/action - List all actions for a project
  • GET /api/{tenantId}/{projectId}/action/{actionId} - Get specific action details

View Action Management Documentation

Execute Actions

Trigger action execution programmatically.

  • GET /api/{tenantId}/{projectId}/action/execute/{actionId} - Execute an action

View Execute Documentation

Authentication

Most endpoints require authentication via Bearer token or API key. The only exception is the unauthorized-ping endpoint which can be called without authentication.

Example authenticated request:

GET https://your-mindzie-instance.com/api/{tenantId}/{projectId}/action/ping
Authorization: Bearer {your-access-token}

Common Use Cases

  • Health Monitoring: Use ping endpoints to verify API connectivity and authentication
  • Automation: Execute actions programmatically as part of ETL pipelines or scheduled jobs
  • Integration: Trigger mindzieStudio workflows from external systems
  • Monitoring: List and inspect actions to track workflow status

Error Responses

All endpoints return standard HTTP status codes:

Status Description
200 Success
401 Unauthorized - invalid or missing authentication
404 Not found - action or resource does not exist

Get Started

  1. Start with Ping Endpoints to test connectivity
  2. Use Action Management to discover available actions
  3. Execute Actions to trigger workflows