Skip to content
  • Documentation >
  • Apps >
  • Productivity >
  • Neaktor

Neaktor

With Neaktor modules in Ibexa Connect, you can create, update, monitor, and delete your tasks in your Neaktor account and make API calls.

To get started with Neaktor, create an account at app.neaktor.com.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory.

Connecting Neaktor to Ibexa Connect

To make a connection to Neaktor you need to obtain a Client ID and Client Secret from your Neaktor account.

  1. Log in to your Neaktor account.

  2. Click the 3-line menu icon at the top of the page, then click Integrations.

    neaktor_1.png

  3. Click API keys.

  4. Click Generate new key.

  5. From the two options, select OAuth2 keychain. Click Create API key.

  6. Change the API key status to Read and write.

    neaktor_2.png

  7. Copy the both the Client ID and Secret Key to your clipboard.

  8. Go to your Ibexa Connect scenario and select the Neaktor module you want to use.

  9. Under Connection, click Add.

  10. Give your new connection a name.

  11. Paste the Client ID and Client secret in the fields below.

  12. Click Save.

  13. A prompt appears asking to grant Ibexa Connect read and write access to your Neaktor account data. Click allow.

You have successfully established the connection.

Tasks

Watch Tasks

Triggers when a task is created or deleted.

Note

See Setting up a Neaktor webhook to add the webhook to your Neaktor account.

Webhook

Choose an existing webhook or add a new one.
Webhook name Give your webhook a name.
Event Type Select whether you want to be notified when a task is created, deleted, or both.

Search Tasks

Search for tasks by specified parameters.
Project ID Enter or select the ID of the project you want to retrieve tasks from.
Model ID Enter or select the ID of the process model you want to retrieve tasks from.
Last Modified Date Search for tasks that have been edited after the date you provide here. See the list of supported date formats.
Start Date Search for tasks that started after the date you provide here. See the list of supported date formats.
End Date Search for tasks that finished before the date you provide here. See the list of supported date formats.
Created Date Search for tasks that were created after the date you provide here. See the list of supported date formats.
Limit Enter the maximum number of tasks Ibexa Connect returns during one scenario execution cycle.

Get a Task

Gets a task.
Task ID Enter or select the ID of the task you want to retrieve.

Create a Task

Creates a task.

Assignee
Performer Type Enter or select the type of entity to perform the task.

* User

* Group
Performer ID Enter or select the ID of the task performer.

Model ID

Enter or select the ID of the process model you want to create a task for.

Parent ID

Enter or select the ID of the parent task.

Task Links

Enter or select any task links to include.

Description

Add a text description for the task.

End date

Enter the end date of the task. See the list of supported date formats.

Priority

Select a priority level.

  • Low

  • Medium

  • High

Start date

Enter the start date of the task. See the list of supported date formats.

Subject

Enter a subject.

Tags

Add any tags to the task.

Update a Task

Updates a task.
Task ID Enter or select the ID of the task you want to update.
Model ID Enter or select the ID of the process model in which you want to update a task.
Description Add a text description for the task.
End date Enter the end date of the task. See the list of supported date formats.
Priority Select a priority level.

* Low

* Medium

* High
Start date Enter the start date of the task. See the list of supported date formats.
Subject Enter a subject.
Tags Add any tags to the task.
Performer ID Enter or select the ID of the task performer.
Performer Type Enter or select the type of entity to perform the task.

* User

* Group
Task Links Enter or select any task links to include.
Parent ID Enter or select the ID of the parent task.

Delete a Task

Deletes a task.
Task ID Enter or select the ID of the task you want to delete.

Other

Make an API Call

Performs an arbitrary authorized API call.
URL Enter a path relative to https://api.neaktor.com. For example: /v1/tasks

For the list of available endpoints, refer to the Neaktor 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 - List tasks

The following API call returns a list of all the tasks in your Neaktor account.

URL: /v1/tasks

Method: GET

neaktor_3.png

Matches of the search can be found in the module's Output under Bundle > Body > data. Our example returned 5 tasks:

neaktor_4.png

Setting up a Neaktor webhook

Note

Only the account owner or a user with administrator rights can create webhooks in Neaktor.

  1. In your Ibexa Connect scenario, select the Neaktor Watch Tasks module.

  2. Under Webhook, click Add.

  3. Give your new webhook a name, then select the connection you want to use.

  4. Click Save.

  5. Copy the webhook URL address to your clipboard.

  6. Log in to your Neaktor account.

  7. Click the plus icon at the top of the page, then click Integration.

    neaktor_5.png

  8. Click Webhooks.

  9. Click Add Webhook.

  10. Give your webhook a anme in the box provided.

  11. Enter the webhook URL in the Callback URL box.

    neaktor_6.png

  12. Configure the rest of you webhook how you would like.

  13. Click Save.

You have successfully set up the webhook.