AidaForm¶
The AidaForm modules allow you to watch new payments, new files, and new responses for your forms in your AidaForm account.
Getting Started with AidaForm¶
Prerequisites
- An AidaForm account
In order to use AidaForm with Ibexa Connect, it is necessary to have an AidaForm account. If you do not have one, you can create an AidaForm account at aidaform.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting AidaForm to Ibexa Connect¶
To connect your AidaForm account to Ibexa Connect you need to obtain the API Key from your AidaForm account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your AidaForm account.
2. Click Your Profile Account > My Account > Settings.
3. Copy the API Key to your clipboard.
Note
If you do not see the API Key details, click Get/Update API Key > Update.
4. Go to Ibexa Connect and open the AidaForm module's Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the API Key field, enter the API key copied in step 3, and click Continue.
The connection has been established.
Triggers¶
See setting up the AidaForm webhooks to add the webhook in your AidaForm account.
Watch New File¶
Triggers when your specified form receives every single uploaded file.
| Webhook Name | Enter a name for the webhook. |
Watch New Payment¶
Triggers when AidaForm receives a payment notification for the specified form.
| Webhook Name | Enter a name for the webhook. |
Watch New Response¶
Triggers when your specified form receives a new response.
| Webhook Name | Enter a name for the webhook. |
Actions¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the AidaForm 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 have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - Get Forms¶
The following API call returns all the forms from your AidaForm account:
URL: /v1/forms
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body > items. In our example, 2 forms were returned:
Setting Up the AidaForm Webhooks¶
1. Open any Watch module, enter a name for the webhook, click Save and copy the URL address to your clipboard.
2. Log in to your AidaForm account.
3. Open the form for which you want to add webhook, click Set up > Third Party Integrations > Webhook.
4. In the Webhook URL field, enter the URL address copied in step 1 and click Create.
You have successfully added the webhook.