You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/apps/components/api-proxy.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: API Proxies
2
+
title: API Proxy
3
3
hide_title: true
4
-
sidebar_position: 7
4
+
sidebar_position: 6
5
5
---
6
6
7
-
# API Proxies
7
+
# API Proxy
8
8
9
-
API Proxies let your app call external APIs without exposing credentials to the browser. The proxy runs server-side — API keys, OAuth tokens, and secrets never reach the client.
9
+
API Proxy components let your app call external APIs without exposing credentials to the browser. The proxy runs server-side — API keys, OAuth tokens, and secrets never reach the client.
10
10
11
11
This is especially useful for **client-facing components** like journey blocks, portal blocks, and capabilities that need to call external APIs.
12
12
@@ -29,9 +29,9 @@ External API (https://api.example.com/products)
29
29
30
30
## Quick start
31
31
32
-
### 1. Configure a proxy in the App Builder
32
+
### 1. Add an API Proxy component to your app
33
33
34
-
Go to your app's **Proxies**section and add a target:
34
+
In the App Builder, add a new **API Proxy**component and configure:
35
35
36
36
-**Name** — a unique identifier (e.g. `products-api`)
37
37
-**Target URL** — the base URL of the external API (must be HTTPS)
The epilot platform continues to evolve, with new component types planned for future releases:
56
+
Custom Workflow Tasks extend epilot's automation engine with your own logic. You can either call an external endpoint (webhook-style) or run TypeScript code in a sandboxed environment directly within a workflow task.
57
+
58
+
```
59
+
Use cases: Third-party integrations, data syncing, custom processing steps in workflows
60
+
```
61
+
62
+
### [API Proxy](/docs/apps/components/api-proxy)
63
+
64
+
API Proxy components let your app call external APIs without exposing credentials to the browser. The proxy runs server-side, injecting authentication and signing requests so secrets never reach the client.
65
+
66
+
```
67
+
Use cases: Secure external API calls, OAuth integrations, credential-protected endpoints
68
+
```
57
69
58
-
### Custom Automation Tasks
70
+
##On the Horizon
59
71
60
-
These will allow you to define specialized tasks that can be triggered within epilot's automation workflows, enabling custom processing or integration steps in automated sequences.
72
+
The epilot platform continues to evolve, with new component types planned for future releases:
61
73
62
74
### Custom Journey Design Elements
63
75
@@ -71,7 +83,7 @@ Have an idea for a new component type? We welcome feedback from the developer co
71
83
1.**Evaluate Your Need**: Consider if existing component types could address your use case
72
84
2.**Define the Integration Point**: Identify where in epilot your component would integrate
73
85
3.**Describe the Value**: Outline the problems it would solve for epilot users
74
-
4.**Submit a Request**: [Contact us](https://developers.epilot.cloud/contact) with your proposal
86
+
4.**Submit a Request**: [Contact us](mailto:support@epilot.cloud) with your proposal
75
87
76
88
Our product team regularly reviews component requests and prioritizes them based on community interest and platform direction.
77
89
@@ -83,7 +95,28 @@ Learn more about [App Surfaces](/docs/apps/app-surfaces) to understand how your
83
95
84
96
## Building Your First Component
85
97
86
-
Ready to create your own component? Each component type has specific requirements and capabilities, but they all follow similar development patterns.
98
+
Ready to create your own component? The fastest way to get started is with the **epilot CLI**:
0 commit comments