Skip to content
  • Documentation >
  • Apps >
  • Process Management >
  • Metatask

Metatask

The Metatask modules allow you to retrieve and list the templates and processes in your Metatask account.

Getting Started with Metatask

Prerequisites

  • A Metatask account

In order to use Metatask with Ibexa Connect, it is necessary to have a Metatask account. If you do not have one, you can create a Metatask account at metatask.io/team-creation/step1.

Note

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

Connecting Metatask to Ibexa Connect

To connect your Metatask account to Ibexa Connect you need to obtain the API Key from your Metatask account and insert it in the Create a connection dialog in the Ibexa Connect module.

  1. Login to your Metatask account.

    Note

  2. Click Your Profile Icon > Ibexa Connect Settings > Integrations > Generate API Key. Copy the API key to your clipboard.

    61f27372c3ba1.gif

  3. Go to Ibexa Connect and open the Metatask module's Create a connection dialog.

    61f273752c056.gif

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

  5. In the API Key field, enter the API key copied in step 2 and click Continue.

The connection has been established.

Templates

Search Templates

Get a list of all available templates sorted by title.
Limit Set the maximum number of templates Ibexa Connect should return during one scenario execution cycle.

Get a Template

Get a template with data form and tasks by ID.
Template ID Select the Template ID whose details you want to retrieve.

Process

Search Process

Gets a list of processes by params.

Limit

Set the maximum number of processes Ibexa Connect should return during one scenario execution cycle.

Start Date From

Enter the date to search process started on or after the specified date. If no date is specified, the module returns the process started during the last 24 hours.

Start Date To

Enter the date to search process started on or before the specified date. If no date is specified, the module returns the process started during the last 24 hours. The maximum allowed days is 30.

Statuses

Select the status of the process you are searching for:

  • Active

  • All

  • Completed

  • Rejected

Templates

Add the Template IDs whose processes you want to search or list. You can add multiple Template IDs.

Starters

Add the User IDs whose processes you are searching for. You can add multiple User IDs.

Get a Process

Gets a process by ID.
Process ID Select the Process ID whose details you want to retrieve.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://metatask.io/external_api. For example: /v1/processes

For the list of available endpoints, refer to the Metatask 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 Templates

The following API call returns all the templates from your Metatask account:

URL:

/v1/templates

Method:

GET

61f2737769444.png

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

In our example, 2 templates were returned:

61f273786f32b.png