> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/sysaid.md).

# SysAid

SysAid is an IT service management platform for service records, users, assets, and support operations.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| SysAid    | Credentials    |

### SysAid

Connect to SysAid with an application key to generate access tokens for API requests.

#### Set up in SysAid

1. Sign in to your SysAid administration and obtain the application/API key used to generate access tokens for API requests.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **SysAid**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                          |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Account ID    | Yes      | Your SysAid account ID. This is the subdomain in https\://\<account-id>.sysaidit.com.                                                  |
| Client ID     | Yes      | Client ID from your SysAid application key. [Provider instructions](https://developers.sysaid.com/reference/createapplicationkey).     |
| Client Secret | Yes      | Client secret from your SysAid application key. [Provider instructions](https://developers.sysaid.com/reference/createapplicationkey). |

**Provider documentation:** [Setup reference](https://documentation.sysaid.com/docs/rest-api).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **SysAid** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create Service Record

Open a SysAid service record for a new IT issue.

#### Inputs

| Field            | Type     | Required | Description                                                                   |
| ---------------- | -------- | -------- | ----------------------------------------------------------------------------- |
| Type             | string   | No       | Service record type: incident, problem, request, or change. Default: request. |
| Title            | string   | Yes      | Short title for the IT issue.                                                 |
| Description      | textarea | Yes      | Detailed description of the IT issue.                                         |
| Request User     | string   | No       | Requester username, if known.                                                 |
| Due Date         | string   | No       | Expected resolution date-time in ISO 8601 format.                             |
| Impact           | integer  | No       | Impact level ID for the service record.                                       |
| Priority         | integer  | No       | Priority level ID for the service record.                                     |
| Urgency          | integer  | No       | Urgency level ID for the service record.                                      |
| Primary Category | integer  | No       | First-level category ID.                                                      |
| Assigned Group   | string   | No       | Administrative group responsible for the service record.                      |
| Assignee         | string   | No       | Username assigned to the service record.                                      |

#### Outputs

| Field        | Type   | Description                                         |
| ------------ | ------ | --------------------------------------------------- |
| Record ID    | string | Identifier returned for the created service record. |
| Title        | string | Title of the created service record.                |
| Status       | string | Status returned by SysAid, if present.              |
| Raw Response | object | Raw SysAid response body.                           |
| Message      | string | Human-readable creation result.                     |

### Add Service Record Message

Send a message from an existing SysAid service record.

#### Inputs

| Field             | Type     | Required | Description                                                                                                                                                                  |
| ----------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Service Record ID | integer  | Yes      | SysAid service record ID to send the message from.                                                                                                                           |
| Recipients        | array    | Yes      | The unique SysAid IDs of the users and/or groups to receive this message. Each ID must be prefixed with "u" for a user or "g" for a group, for example "u12345" or "g67890". |
| Subject           | string   | Yes      | Subject of the message.                                                                                                                                                      |
| Body              | textarea | Yes      | Body of the message.                                                                                                                                                         |
| CC Recipients     | array    | No       | Optional unique SysAid IDs of the users and/or groups to CC. Each ID must be prefixed with "u" for a user or "g" for a group, for example "u23456" or "g78901".              |

#### Outputs

| Field        | Type    | Description                                |
| ------------ | ------- | ------------------------------------------ |
| Success      | boolean | Whether the message was sent successfully. |
| Raw Response | object  | Raw SysAid response body.                  |
| Message      | string  | Human-readable result.                     |

### Update Service Record

Update an existing SysAid service record.

#### Inputs

| Field             | Type     | Required | Description                                               |
| ----------------- | -------- | -------- | --------------------------------------------------------- |
| Service Record ID | integer  | Yes      | SysAid service record ID to update.                       |
| Title             | string   | No       | Updated title for the service record.                     |
| Description       | textarea | No       | Updated detailed description.                             |
| Status            | integer  | No       | Status ID for the service record.                         |
| Priority          | integer  | No       | Priority level ID for the service record.                 |
| Urgency           | integer  | No       | Urgency level ID for the service record.                  |
| Impact            | integer  | No       | Impact level ID for the service record.                   |
| Due Date          | string   | No       | Updated expected resolution date-time in ISO 8601 format. |
| Primary Category  | integer  | No       | First-level category ID.                                  |
| Assigned Group    | string   | No       | Administrative group responsible for the service record.  |
| Assignee          | string   | No       | Username assigned to the service record.                  |
| Request User      | string   | No       | Requester username, if it needs to be updated.            |
| Custom Notes      | textarea | No       | Custom notes to set on the service record.                |

#### Outputs

| Field        | Type   | Description                                   |
| ------------ | ------ | --------------------------------------------- |
| Record ID    | string | Identifier of the updated service record.     |
| Title        | string | Updated title returned by SysAid, if present. |
| Status       | string | Status returned by SysAid, if present.        |
| Raw Response | object | Raw SysAid response body.                     |
| Message      | string | Human-readable update result.                 |

### List Service Records

Search and list SysAid service records.

#### Inputs

| Field                   | Type    | Required | Description                                                                                        |
| ----------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------- |
| Query                   | string  | No       | Free-text or SysAid search criteria.                                                               |
| Fields                  | array   | No       | Fields to return for each service record.                                                          |
| Offset                  | integer | No       | Number of matching service records to skip.                                                        |
| Limit                   | integer | No       | Maximum number of service records to return, up to 100. Default: 100.                              |
| Sort By                 | array   | No       | Fields to sort by.                                                                                 |
| Sort Direction          | string  | No       | Sort direction, either "asc" or "desc".                                                            |
| Expand                  | array   | No       | Related service record properties to expand, such as company, requestUser, ci, asset, or category. |
| Status Filter           | string  | No       | Status filter value or comma-separated values.                                                     |
| Priority Filter         | string  | No       | Priority filter value or comma-separated values.                                                   |
| Assigned Group Filter   | string  | No       | Assigned group filter value or comma-separated values.                                             |
| Assignee Filter         | string  | No       | Assignee filter value or comma-separated values.                                                   |
| Request User Filter     | string  | No       | Request user filter value or comma-separated values.                                               |
| Primary Category Filter | string  | No       | Primary category filter value or comma-separated values.                                           |

#### Outputs

| Field        | Type    | Description                         |
| ------------ | ------- | ----------------------------------- |
| Records      | array   | Service records returned by SysAid. |
| Count        | integer | Number of service records returned. |
| Raw Response | object  | Raw SysAid response body.           |
| Message      | string  | Human-readable list result.         |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/sysaid.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
