Requirements:

  • Activepieces version 0.34.5 or higher
  • SDK version 0.3.6 or higher

You can use the embedded SDK to send requests to your instance and retrieve data.

1

Initialize the SDK

Follow the instructions in the Embed Builder to initialize the SDK.

2

Call (request) Method

<script> 
activepieces.request({path:'/flows',method:'GET'}).then(console.log);
</script>

Request Parameters:

Parameter NameRequiredTypeDescription
path✅stringThe path within your instance you want to hit (we prepend the path with your_instance_url/api/v1)
method✅stringThe http method to use ‘GET’, ‘POST’,‘PUT’, ‘DELETE’, ‘OPTIONS’, ‘PATCH’ and ‘HEAD
body❌JSON objectThe json body of your request
queryParams❌Record<string,string>The query params to include in your request
Suggest editsRaise issue