Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/apps/components/external-product-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: External Product Catalog
hide_title: true
sidebar_position: 7
description: "Integrate an external product catalog with epilot by adding an External Product Catalog component to your App and configuring its hooks in the component editor."
---

<h1 align="center">External Product Catalog</h1>
Expand Down
1 change: 1 addition & 0 deletions docs/apps/components/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Overview
hide_title: true
sidebar_position: 1
description: "Components are the building blocks of every epilot App. Each component type extends a specific part of the platform, such as entity pages, journeys, portals or flows."
---

<p>&nbsp;</p>
Expand Down
1 change: 1 addition & 0 deletions docs/apps/components/portal-extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Portal Extensions
hide_title: true
sidebar_position: 6
description: "Extend epilot portals with custom functionality and third-party integrations, from seamless links to hooks for data retrieval, validation and export."
---

<h1 align="center">Portal Extensions</h1>
Expand Down
1 change: 1 addition & 0 deletions docs/apps/functions/deploy-and-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Deploying & Updating
hide_title: true
sidebar_position: 5
description: "Add, deploy and update App functions with the epilot CLI: scaffold workflow or scheduled functions, deploy them and learn how updates reach installations."
---

# Deploying & Updating Functions
Expand Down
1 change: 1 addition & 0 deletions docs/apps/how-to-guides/build-a-custom-jb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "How to build a custom Journey block"
hide_title: true
sidebar_position: 1
description: "Step-by-step guide to building a custom Journey block as an epilot App: a block that shows the address entered in the journey as a marker on an OpenStreetMap map."
---

## How to build a custom Journey block
Expand Down
2 changes: 1 addition & 1 deletion docs/apps/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import DocCards from '@site/src/components/DocCards';

# Build Apps for epilot

epilot is the Energy XRM that Apps extend. Add custom UI to entity pages, journeys, and portals, run your own code inside flows, and connect external systems — then install your App privately or publish it to the epilot Marketplace.
epilot is the energy XRM that Apps extend. Add custom UI to entity pages, journeys, and portals, run your own code inside flows, and connect external systems — then install your App privately or publish it to the epilot Marketplace.

## Get started

Expand Down
1 change: 1 addition & 0 deletions docs/audit-logs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 14
description: "Audit logs are a tamper-resistant record of who did what, when and on which resource in your epilot organization, for security reviews, compliance and troubleshooting."
---

# Audit Logs
Expand Down
1 change: 1 addition & 0 deletions docs/auth/access-tokens.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 2
description: "Authorize epilot API calls with Access Tokens: create, restrict (read-only or anonymized), use and revoke tokens for integrations and scripts."
---

# Access Tokens
Expand Down
1 change: 1 addition & 0 deletions docs/auth/anonymization.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 2.5
title: PII Anonymization
description: "epilot can mask personal data (PII) in API responses so AI assistants, analytics and integrations get the shape and relations of your data without personal identifiers."
---

# PII Anonymization
Expand Down
1 change: 1 addition & 0 deletions docs/auth/permissions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 4
description: "epilot permissions use role-based access control (RBAC) with attribute-based conditions, inspired by AWS IAM policies, for fine-grained control by role, resource and attribute."
---

# Permissions
Expand Down
1 change: 1 addition & 0 deletions docs/automation/architecture.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 10
description: "How the epilot automation engine works: a serverless, event-driven pipeline on AWS Lambda, DynamoDB, EventBridge and SQS that matches entity events to flows and runs their actions."
---

# Architecture
Expand Down
1 change: 1 addition & 0 deletions docs/automation/automation-executions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 3
description: "Every time an Automation Flow is triggered, epilot creates an Automation Execution. Learn how executions run their actions and which execution statuses exist."
---

# Automation Executions
Expand Down
1 change: 1 addition & 0 deletions docs/automation/automation-flows.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 2
description: "Automation Flows are epilot's automation configurations: the triggers that start them and the actions they run on entities."
---

# Automation Flows
Expand Down
1 change: 1 addition & 0 deletions docs/automation/entity-mapping.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 4
description: "Use the Create/Edit Entity (Advanced) automation action to map data from one entity into new or existing entities, with attribute mappings and mapping operations."
---

# Entity Mapping
Expand Down
1 change: 1 addition & 0 deletions docs/automation/event-catalog-trigger.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 5
title: Event Catalog Trigger
description: "The Event Catalog trigger starts an Automation Flow whenever a Core Event, such as CustomerRequestSubmitted or MeterReadingAdded, is published in your organization."
---

# Event Catalog Trigger
Expand Down
1 change: 1 addition & 0 deletions docs/automation/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Overview
sidebar_position: 1
description: "epilot automation is a general-purpose framework for executing actions on entities in response to events."
---

# Automation
Expand Down
1 change: 1 addition & 0 deletions docs/blueprints/editing-and-synchronizing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 3
title: Editing and synchronizing
hide_title: true
description: "Edit a Blueprint in the Blueprint overview (rename it, add or remove resources, download or delete it) and synchronize it with another organization."
---

## Editing Blueprints
Expand Down
1 change: 1 addition & 0 deletions docs/blueprints/installing-a-blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_position: 2
title: Installing a Blueprint
hide_title: true
description: "Install a Blueprint from the epilot Marketplace with a one-click or advanced install, configure it after installation, or create your own custom Blueprint."
---


Expand Down
1 change: 1 addition & 0 deletions docs/blueprints/intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Blueprints
sidebar_position: 1
description: "Blueprints from the epilot Marketplace bundle journeys, automations, entity schemas, templates and more, so companies can launch energy use cases in a few clicks."
---

# Blueprints
Expand Down
1 change: 1 addition & 0 deletions docs/blueprints/sandboxes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 5
title: Sandboxes
description: "A Sandbox is a separate epilot organization for safely testing configurations without affecting production. Validated changes can be promoted to production."
---

# Sandboxes
Expand Down
1 change: 1 addition & 0 deletions docs/blueprints/supported-resources.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_position: 10
title: Supported Resources
description: "Resource types that Blueprints support, each corresponding to a ResourceNodeType in the Blueprint Manifest API."
---

# Supported Resources
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/access-token.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Access Token API"
description: "epilot CLI commands for the Access Token API: quick start, common flags and every operation, callable from the command line."
---

# Access Token API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/address-suggestions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Address Suggestions API"
description: "epilot CLI commands for the Address Suggestions API: quick start, common flags and every operation, callable from the command line."
---

# Address Suggestions API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/address.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Address API"
description: "epilot CLI commands for the Address API: quick start, common flags and every operation, callable from the command line."
---

# Address API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/ai-agents.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "AI Agents API - OpenAPI 3.0"
description: "epilot CLI commands for the AI Agents API - OpenAPI 3.0: quick start, common flags and every operation, callable from the command line."
---

# AI Agents API - OpenAPI 3.0
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/app.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "App API"
description: "epilot CLI commands for the App API: quick start, common flags and every operation, callable from the command line."
---

# App API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/audit-logs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Audit Log"
description: "epilot CLI commands for the Audit Log: quick start, common flags and every operation, callable from the command line."
---

# Audit Log
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/automation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Automation API"
description: "epilot CLI commands for the Automation API: quick start, common flags and every operation, callable from the command line."
---

# Automation API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/billing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Billing API"
description: "epilot CLI commands for the Billing API: quick start, common flags and every operation, callable from the command line."
---

# Billing API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/blueprint-manifest.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Blueprint Manifest API"
description: "epilot CLI commands for the Blueprint Manifest API: quick start, common flags and every operation, callable from the command line."
---

# Blueprint Manifest API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/consent.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Consent API"
description: "epilot CLI commands for the Consent API: quick start, common flags and every operation, callable from the command line."
---

# Consent API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/customer-portal.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Portal API"
description: "epilot CLI commands for the Portal API: quick start, common flags and every operation, callable from the command line."
---

# Portal API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/dashboard.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Dashboard API"
description: "epilot CLI commands for the Dashboard API: quick start, common flags and every operation, callable from the command line."
---

# Dashboard API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/data-governance.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Data Governance API"
description: "epilot CLI commands for the Data Governance API: quick start, common flags and every operation, callable from the command line."
---

# Data Governance API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/deduplication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Deduplication API"
description: "epilot CLI commands for the Deduplication API: quick start, common flags and every operation, callable from the command line."
---

# Deduplication API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/design.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Design Builder API v2"
description: "epilot CLI commands for the Design Builder API v2: quick start, common flags and every operation, callable from the command line."
---

# Design Builder API v2
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/document.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Document API"
description: "epilot CLI commands for the Document API: quick start, common flags and every operation, callable from the command line."
---

# Document API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/email-settings.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Messaging Settings API"
description: "epilot CLI commands for the Messaging Settings API: quick start, common flags and every operation, callable from the command line."
---

# Messaging Settings API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/email-template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Email template API"
description: "epilot CLI commands for the Email template API: quick start, common flags and every operation, callable from the command line."
---

# Email template API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/entity-mapping.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Entity Mapping API"
description: "epilot CLI commands for the Entity Mapping API: quick start, common flags and every operation, callable from the command line."
---

# Entity Mapping API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/entity.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Entity API"
description: "epilot CLI commands for the Entity API: quick start, common flags and every operation, callable from the command line."
---

# Entity API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/environments.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Environments API"
description: "epilot CLI commands for the Environments API: quick start, common flags and every operation, callable from the command line."
---

# Environments API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/erp-integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "ERP Integration API"
description: "epilot CLI commands for the ERP Integration API: quick start, common flags and every operation, callable from the command line."
---

# ERP Integration API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/event-catalog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Event Catalog API"
description: "epilot CLI commands for the Event Catalog API: quick start, common flags and every operation, callable from the command line."
---

# Event Catalog API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/file.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "File API"
description: "epilot CLI commands for the File API: quick start, common flags and every operation, callable from the command line."
---

# File API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/iban.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Iban API"
description: "epilot CLI commands for the Iban API: quick start, common flags and every operation, callable from the command line."
---

# Iban API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/journey.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Journey API"
description: "epilot CLI commands for the Journey API: quick start, common flags and every operation, callable from the command line."
---

# Journey API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/kanban.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Kanban API"
description: "epilot CLI commands for the Kanban API: quick start, common flags and every operation, callable from the command line."
---

# Kanban API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/message.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Message API"
description: "epilot CLI commands for the Message API: quick start, common flags and every operation, callable from the command line."
---

# Message API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/metering.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Metering API"
description: "epilot CLI commands for the Metering API: quick start, common flags and every operation, callable from the command line."
---

# Metering API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Notes API"
description: "epilot CLI commands for the Notes API: quick start, common flags and every operation, callable from the command line."
---

# Notes API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/notification.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Notification API"
description: "epilot CLI commands for the Notification API: quick start, common flags and every operation, callable from the command line."
---

# Notification API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/organization.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Organization API"
description: "epilot CLI commands for the Organization API: quick start, common flags and every operation, callable from the command line."
---

# Organization API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/partner-directory.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Partner API"
description: "epilot CLI commands for the Partner API: quick start, common flags and every operation, callable from the command line."
---

# Partner API
Expand Down
1 change: 1 addition & 0 deletions docs/cli/commands/permissions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Permissions API"
description: "epilot CLI commands for the Permissions API: quick start, common flags and every operation, callable from the command line."
---

# Permissions API
Expand Down
Loading
Loading