Simplesat¶
With the Simplesat modules in Ibexa Connect you can:
-
create or update a customer
-
watch and list answers
To get started with Simplesat, create an account at Simplesat.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Simplesat to Ibexa Connect¶
To connect your Simplesat account to Ibexa Connect you need to obtain the API Key from your Simplesat account and insert it in the Create a connection dialog in the Ibexa Connect module.
-
Log in to your Simplesat account.
-
Click Admin > Account Settings.
-
Copy the Account Key to the clipboard.
-
Log in to your Ibexa Connect account, add a module from the Simplesat app into an Ibexa Connect scenario.
-
Click Add next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the details copied in step 3 and click Continue.
You have successfully connected Simplesat app with Ibexa Connect and can now create scenarios.
Customer¶
You can create or update the customers.
Create or Update Customer¶
Creates a new or updates an existing customer.
Enter (map) the customer's email address.
Name
Enter (map) the customer's name.
Company Name
Enter (map) the customer's company name.
Custom Attributes
You can include multiple custom attributes with each customer record to use as rules for your audience. For example, person type, company status, and user role.
Simplesat checks whether the custom attribute exists:
-
If the specified custom attribute exists, the record will be updated,
-
If the specified customer attribute does not exist, a new custom attribute will be created.
Item
Enter the customer attributes details.
| Key | Enter (map) the attribute name. For example, company. |
| Value | Enter (map) the attribute value. For example, company name. |
Answer¶
You can create and run the following answer modules.
Watch Answers¶
Triggers when an answer is created and updated.
| Limit | Set the maximum number of answers Ibexa Connect will return during one execution cycle. The default value is 2. |
List Answers¶
Returns a list of all answers.
| Limit | Set the maximum number of answers Ibexa Connect will return during one execution cycle. The default value is 2. |
Other¶
You can call APIs using the Make an API Call module.
Make an API Call¶
Performs an arbitrary authorized API call.
| URL | Enter a path relative to https://api.simplesat.io/api. For example: /answers. Note: For the list of available endpoints, refer to the Simplesat API Documentation.. |
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't need to add authorization headers; we've already added those for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Posts¶
The following API call creates or updates the customer in your Simplesat account:
URL:
/customers/create-or-update/
** Method: **
POST
Headers:
Key: X-Simplesat-Token
Value: {{your access token}}
The result can be found in the module's Output under Bundle > Body.
In our example, a new customer is created with the specified details:
