List workflow trigger events

Returns the catalog of events a workflow event trigger can subscribe to: event_type (use as trigger.eventName), name, description, payload_schema_ref (resolve via GET /api/workflow/registry/schemas/{schemaRef}), payload_schema_ref_status, source (system|tenant), and status. Supports search, source, status, and limit query filters.

RBAC · workflow

Query parameters

searchstringOptional

Case-insensitive match on event type, name, and description.

sourcestringOptional

statusstringOptional

limitintegerOptional

Response body

Success response 200 · schema WorkflowRegistryEventsResponse

eventsarray of objectRequired

itemsobject

event_idstringRequired

event_typestringRequired

Use this as trigger.eventName.

namestringRequired

descriptionstringNullable

categorystringNullable

payload_schema_refstringNullable

Event payload schema reference; resolve via the schemas endpoint.

payload_schema_ref_statusstringRequired

Enum: knownunknownmissing

sourcestringRequired

Enum: systemtenant

statusstringRequired

Enum: activebetadraftdeprecated

Response codes

200

Trigger event catalog.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

500

Unexpected error.

GET /api/workflow/registry/events

cURL

curl -X GET "https://algapsa.com/api/workflow/registry/events?search=string&source=all&status=all&limit=1" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/workflow/registry/events?search=string&source=all&status=all&limit=1", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/workflow/registry/events?search=string&source=all&status=all&limit=1");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "events": [
    {
      "event_id": "string",
      "event_type": "string",
      "name": "string",
      "description": "string",
      "category": "string",
      "payload_schema_ref": "string",
      "payload_schema_ref_status": "known",
      "source": "system",
      "status": "active"
    }
  ]
}