Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
Connector package documentation:
System documentation:
Setting up HTTP Client Act-On
Steps
-
In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Act-On HTTP Client as the prototype of the HTTP Client.
-
Fill in the Base URI, Client ID, Client Secret, Username, and Password.
-
Scopes is optional.
-
Choose Content-Type (Explained at Important Notes Below)
Subscribing to Entities from Act-On
Steps
-
Go to Connections → Incoming and create a new incoming configuration and select Act-On Subscriber as the subscriber.
-
Select the entity you want to subscribe from Act-On.
-
Add any request parameters needed to subscribe to the entity (optional).
-
You can optionally add a transformer to transform the request parameters into something you need.
-
Select the Act-On HTTP Client to use
General Concept
We follow Act-On documentation on building this connector so you can easily use the connector based on Act-On API Reference.
Entity
It’s the entity you want to subscribe from Act-On. Please refer to the entities in Management APIs from Act-On API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on Act-On API Reference. Please look at the example below on how to fill Request Parameters field when subscribing Single Request entity
That’s why we need to define the listid, and recordid property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such a Request Parameters field.
/api/1/list/123/record/123/facts
Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Act-On.
Publishing Entity to Act-On
**Steps**-
Go to Connections → Outgoing, create a new outgoing configuration, and select Act-On Publisher as the publisher.
-
Select the action that you want the publisher to do with the data.
-
Select the Act-On entity you want the data to be published.
-
You can optionally add any query parameters to the request.
-
You can also optionally add any transformers to transform the data into anything you need before submitting it to Act-On.
-
Select the HTTP Client to use.
General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.
Action
Currently, we support Create (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method).
Entity
We support publishing to most Act-On endpoints but not with publishing binary files at the moment. Please refer to the entities in Management APIs from the Act-On API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require an object as the request payload, please look at the example below. For example, we want to Create a User. Please select “Create” as the action and “Create Bew Account User(s)” as the entity of the publisher.
You can put the payload you want to send to Act-On into the payload property in the data. Here is an example of the Possible Response after Creation.
Alumio will send an API request to Act-On with URL /api/1/user
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Act-On.
Important Notes
On the endpoints, we do not support query on Input
see that the Endpoint is
/api/1/list/{listid}/record?email={emailaddress}.
In Alumio we make it like this.
/api/1/list/{listid}/record
we didn’t insert any query on this one, in this case, you have to insert manually on the parameter like this.
{
"path": [],
"query": {
"email": "emailAdressHere"
},
"payload": []
}
We Currently are not supporting File (-F) type of Payload in Alumio.
ex :
For the Data Payload,
ex :
In this case, you have to create another Client and Publisher for it.
Please look at the Publisher I’ve created.
See that the Content-Type is form-urlencoded.
Take a look at the Client, and see the Content Type is form-urlencoded.
In this case, you have to create 2 clients and 2 publishers for Json and URL-encoded and use it differently.