Proxy Endpoint

This document may be out of date.
All APIEase documentation has moved to https://docs.apiease.com

A Proxy Endpoint Trigger lets you create your own public API endpoint that runs an APIEase request whenever it is called. This allows external systems to trigger your workflows without needing any custom backend code or servers.

A Proxy Endpoint is a URL you define, such as:

When someone calls this URL using the method you specify (GET, POST, etc.), APIEase executes the associated request and returns the request’s final response back to the caller.

Use this to create lightweight APIs, receive events, or integrate with external systems.

1. The first path segment after /proxy/ identifies your shop.

2. The rest of the path is the custom endpoint path you choose.

3. APIEase matches the incoming request to your Proxy Endpoint Trigger.

4. APIEase runs your configured request with the incoming data.

5. The result of your request is sent back to the caller.

You can choose whether the endpoint requires authentication:

• Authenticated: caller must use the same authentication scheme as Remote API Calls.

• Unauthenticated: open access to anyone with the URL.

1. Open any APIEase Request.

2. Go to Triggers.

3. Add Proxy Endpoint Trigger.

4. Set:

   • Request Path (your public endpoint path)

   • HTTP Method

   • Authenticated true or false

5. Save the request.

Your public API endpoint is now ready.