• Documentation >
• Apps >
• Education >
• Innform

Innform

With Innform modules in Ibexa Connect, you can watch, create, update, search, retrieve, and delete:

• list, retrieve, invite, update, freeze, unfreeze, and delete users

• watch overdue and completed assignments

To get started with Innform, create an account at innform.io.

Connect Innform to Ibexa Connect

To connect Innform app, you need to obtain the API Key from your Innform account and insert it in the module scenario.

1. Log in to your Innform account.

2. Click Profile icon > Account Settings.

   

3. Click Integrations.

   

4. Copy the API key to a safe place.

   

5. In your Ibexa Connect account, insert an Innform module in your scenario and click the Add button next to the Connection field.

   

6. In the Connection name field, enter a name for the connection.

7. In the API Key fields, enter the details copied in step 4 and click Save.

You have successfully connected the Innform app and can now build scenarios.

Users

You can list, retrieve, invite, update, freeze, unfreeze, and delete users using the following modules.

List Users

List all existing users.

Limit	Set the maximum number of users Ibexa Connect will return during one execution cycle.

Get a User

Returns information about the selected user.

User ID	Select or map the User ID whose details you want to retrieve.

Invite a User

Invites a new user.

For field descriptions, see the Innform API reference.

Update a User

Updates the selected user.

User ID	Select or map the User ID whose details you want to update.

For field descriptions, see the Innform API reference.

Freeze a User

Freezers the selected user.

User ID	Select or map the User ID whom you want to freeze.

Unfreeze a User

Unfreeze the selected user.

User Email	Enter the User Email whom you want to unfreeze.

Delete a User

Deletes the selected user.

User ID	Select or map the User ID you want to delete.

Assignments

You can watch overdue and completed assignments using the following modules.

Watch Overdue Assignments

Triggers when an assignment is overdue.

Limit	Set the maximum number of overdue assignments Ibexa Connect will return during one execution cycle.

Watch Completed Assignment

Triggers when an assignment is completed.

Limit	Set the maximum number of completed assignments Ibexa Connect will return during one execution cycle.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Innform API documentation.

URL	Enter a path relative to https://api.innform.io. For example /v1/users.
Method	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 - List users

The following API call returns all users from your account.

URL: /v1/users

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body.

In our example 11 users were returned: