# Mindtickle

> Manage people, groups and training invitations in Mindtickle, and follow learners' progress.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/mindtickle

## Actions

### Add groups to series

Invite everyone in up to 20 groups to a series, or to one module in it.

**Inputs**

- Series (`series_id`, text, required): The series, Mindtickle's name for a training program that holds modules.
- Module (`module_id`, text): Only this module of the series. Leave empty for the whole series.
- Groups (`group_ids`, list, required): The groups to add. Up to 20.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "processIds": [
      "example"
    ],
    "status": "example"
  }
}
```

### Add user to groups

Put a person into one or more groups.

**Inputs**

- User (`learner_id`, text, required): The person in Mindtickle.
- Groups (`group_ids`, list, required): The groups to add. Up to 20.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "processIds": [
      "example"
    ],
    "status": "example"
  }
}
```

### Check job status

Check whether changes Mindtickle queued have finished. Other Mindtickle steps return job IDs when they're still running.

**Inputs**

- Job IDs (`process_ids`, list, required): The job IDs another Mindtickle step returned.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "jobs": [
      {
        "processId": "example",
        "status": "example"
      }
    ]
  }
}
```

### Create group

Create a group of people in Mindtickle.

**Inputs**

- Name (`name`, text, required): The group's name, 3 to 50 characters.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "id": "example",
    "name": "example"
  }
}
```

### Create user

Add a person to Mindtickle, optionally into groups and series. If someone with the same email address or username is already there, Mindtickle updates them instead. Waits briefly for Mindtickle to finish and returns the person.

**Inputs**

- Name (`name`, text): The person's full name.
- Email (`email`, text): The person's email address. Mindtickle sends invitations and reminders here.
- Username (`username`, text): Only for Mindtickle sites that sign people in with a username instead of an email address.
- Time zone (`timezone`, text): The person's time zone in Mindtickle.
- Groups (`group_ids`, list): Groups to put the person in.
- Series (`series_ids`, list): Series to invite the person to.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "processIds": [
      "example"
    ],
    "status": "example",
    "user": {
      "email": "example",
      "groupIds": [
        "example"
      ],
      "id": "example",
      "managers": [
        {
          "email": "example",
          "key": "example",
          "username": "example"
        }
      ],
      "name": "example",
      "profile": {},
      "seriesEntities": [
        {
          "entities": [
            "example"
          ],
          "seriesId": "example"
        }
      ],
      "source": "example",
      "timezone": "example",
      "userState": "example",
      "username": "example"
    }
  }
}
```

### Deactivate user

Deactivate a person so they can no longer use Mindtickle. Updating them later makes them active again.

**Inputs**

- User (`learner_id`, text, required): The person in Mindtickle.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "processIds": [
      "example"
    ],
    "status": "example"
  }
}
```

### Delete group

Delete a group from Mindtickle. The people in it stay.

**Inputs**

- Group (`group_id`, text, required): The group in Mindtickle.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "deleted": true
  }
}
```

### Get learner progress

Read where a person is in each of their modules: not started, in progress or completed, and when.

**Inputs**

- User (`learner_id`, text, required): The person in Mindtickle.
- Status (`status`, text): Only modules in this state. One of: `not_started` (Not started), `in_progress` (In progress), `completed`.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "statements": [
      {
        "actor": {
          "mbox": "example",
          "name": "example"
        },
        "id": "example",
        "object": {
          "definition": {},
          "id": "example"
        },
        "stored": "example",
        "timestamp": "example",
        "verb": {
          "display": {},
          "id": "example"
        }
      }
    ]
  }
}
```

### Get user

Read a person's details, status, groups and series.

**Inputs**

- User (`learner_id`, text, required): The person in Mindtickle.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "email": "example",
    "groupIds": [
      "example"
    ],
    "id": "example",
    "managers": [
      {
        "email": "example",
        "key": "example",
        "username": "example"
      }
    ],
    "name": "example",
    "profile": {},
    "seriesEntities": [
      {
        "entities": [
          "example"
        ],
        "seriesId": "example"
      }
    ],
    "source": "example",
    "timezone": "example",
    "userState": "example",
    "username": "example"
  }
}
```

### Invite users to module

Invite up to 500 people to one module of a series.

**Inputs**

- Series (`series_id`, text, required): The series, Mindtickle's name for a training program that holds modules.
- Module (`module_id`, text, required): The module in the chosen series.
- Users (`learner_ids`, list, required): The people to invite. Up to 500.
- Relevance (`relevance`, text): Whether the module is required or optional for these people. One of: `required`, `optional`, `unmarked`.
- Invited on (`invited_on`, date and time): Record the invitation as made at this earlier time, so past completions count. Leave empty to invite now.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "message": "example",
    "success": true
  }
}
```

### Invite users to series

Invite up to 40 people to a series.

**Inputs**

- Series (`series_id`, text, required): The series, Mindtickle's name for a training program that holds modules.
- Users (`learner_ids`, list, required): The people to invite. Up to 40.
- Invited on (`invited_on`, date and time): Record the invitation as made at this earlier time, so past completions count. Leave empty to invite now.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "message": "example",
    "success": true
  }
}
```

### List groups

List groups in Mindtickle, or find groups by their exact names.

**Inputs**

- Names (`names`, list): Only groups with exactly these names.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "groups": [
      {
        "id": "example",
        "name": "example"
      }
    ]
  }
}
```

### List modules

List the modules in a series, such as courses, quick updates and assessments.

**Inputs**

- Series (`series_id`, text, required): The series, Mindtickle's name for a training program that holds modules.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "modules": [
      {
        "description": "example",
        "id": "example",
        "moduleType": "example",
        "name": "example",
        "thumbnailUrl": "example"
      }
    ]
  }
}
```

### List series

List the series, Mindtickle's training programs, on your site.

**Inputs**: None.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "series": [
      {
        "description": "example",
        "id": "example",
        "moduleType": "example",
        "name": "example"
      }
    ]
  }
}
```

### List users

List the people in Mindtickle, optionally only those with given email addresses or in given groups or series. Returns up to 2,000 people.

**Inputs**

- Email addresses (`emails`, list): Only these email addresses.
- Usernames (`usernames`, list): Only these usernames, on sites that sign people in with a username.
- Groups (`group_ids`, list): Only people in these groups.
- Series (`series_ids`, list): Only people invited to these series.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "done": true,
    "totalSize": 1,
    "users": [
      {
        "email": "example",
        "groupIds": [
          "example"
        ],
        "id": "example",
        "managers": [
          {
            "email": "example",
            "key": "example",
            "username": "example"
          }
        ],
        "name": "example",
        "profile": {},
        "seriesEntities": [
          {
            "entities": [
              "example"
            ],
            "seriesId": "example"
          }
        ],
        "source": "example",
        "timezone": "example",
        "userState": "example",
        "username": "example"
      }
    ]
  }
}
```

### Mark module complete

Mark a course, quick update or assessment as complete for a person, with a full score. The person must already be invited to the series.

**Inputs**

- Series (`series_id`, text, required): The series, Mindtickle's name for a training program that holds modules.
- Module (`module_id`, text, required): The module in the chosen series.
- User (`learner_id`, text, required): The person in Mindtickle.
- Completed on (`completed_on`, date and time): When the person finished. Leave empty for now. It can't be in the future or before they were invited.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "completionStatus": true,
    "requestId": "example"
  }
}
```

### Remove groups from series

Take up to 20 groups off a series, or off one module in it.

**Inputs**

- Series (`series_id`, text, required): The series, Mindtickle's name for a training program that holds modules.
- Module (`module_id`, text): Only this module of the series. Leave empty for the whole series.
- Groups (`group_ids`, list, required): The groups to remove. Up to 20.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "processIds": [
      "example"
    ],
    "status": "example"
  }
}
```

### Remove users from group

Take one or more people out of a group. Up to 500 at a time.

**Inputs**

- Group (`group_id`, text, required): The group in Mindtickle.
- Users (`learner_ids`, list, required): The people in Mindtickle.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "message": "example",
    "success": true
  }
}
```

### Remove users from series

Take up to 500 people off a series.

**Inputs**

- Series (`series_id`, text, required): The series, Mindtickle's name for a training program that holds modules.
- Users (`learner_ids`, list, required): The people to remove. Up to 500.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "message": "example",
    "success": true
  }
}
```

### Update user

Change a person's name or time zone. Anything left empty stays as it is. Updating someone who was deactivated makes them active again.

**Inputs**

- User (`learner_id`, text, required): The person in Mindtickle.
- Name (`name`, text): The person's new full name.
- Time zone (`timezone`, text): The person's time zone in Mindtickle.

**Outputs**

- `data` (object): The response from Mindtickle.

**Example output**

```json
{
  "data": {
    "processIds": [
      "example"
    ],
    "status": "example"
  }
}
```
