Skip to content
Developers

Build on GUIDSE.

Connect client systems to governed processes, and find the concepts behind every integration.

API

The API extends the process. It does not replace the operating design.

Use the API to connect intake, external systems and downstream actions to a GUIDSE operation. Agent teams, pipeline logic, approvals, permissions and execution records remain governed inside the platform.

Typical integration patterns
  • Trigger a pipeline from an external application
  • Submit structured case data or document references
  • Retrieve execution status and controlled outputs
  • Connect client portals and internal systems
  • Receive approved process events
  • Build partner-specific implementation layers
  • Access

    Access follows organizations, roles and approved scopes.

    Credentials, permissions, usage limits, data handling and environment access are defined for the implementation. Client organizations should use controlled scopes rather than shared unrestricted credentials.

  • Errors

    Integration failures remain connected to the operation.

    Requests, validation errors, execution states and downstream failures can be correlated with the process instance so teams can investigate, retry or escalate without losing context.

Documentation

Begin with the operating model, not the endpoint list.

Define the process owner, input, expected output, human review points, exception path, data requirements and success metric before implementation. The integration should support that operating design.

Documentation areas
  • Platform concepts
  • Organizations and access
  • Squads and qualifications
  • Pipelines and triggers
  • Approvals and exceptions
  • API authentication
  • Integrations and webhooks
  • Executions and error handling
  • Budgets and usage
  • Template Builder

Credentials, environment details and implementation-specific references are shared with approved partners and client teams.

Designing an integration for a partner or client process?