The linear connector reads issues from the Linear workspace your key can see.
| Connector name | linear |
| Products | Records, episodes |
| Credentials | A personal API key, or an OAuth access token |
| Permissions | Read access to the teams you pull |
What it pulls
Records. One issue record per issue updated in the window, archived issues included: ID, team key, title, description, priority, estimate, state and state type, assignee, creator, project, cycle number, labels, and the created, updated, started, completed, canceled and due dates.
Episodes. For each issue, its creation, then every history entry split into one event per change: state, assignee, priority, estimate, title, due date, and labels added or removed, each with its time and actor. Comments follow with their author and time.
Assignee and creator names become tokens. Titles, descriptions and comments are free text and are redacted.
Credentials
- In Linear, go to Settings → Account → Security & access and create a personal API key.
- Give it to the SDK as
apiKey.
The key reads whatever its owner can read. Use an account that only belongs to the teams you mean to share, or limit the teams with the teams option. You can pass an OAuth accessToken with the read scope instead of apiKey.
Connect
datayield connect linear -o teams=ENG,OPS -o apiKey=env:LINEAR_API_KEYSecret options passed directly are saved to ~/.datayield/credentials. Values written as env:NAME are read from the environment at run time, which suits CI. See CLI reference.
Options
| Option | Required | Meaning |
|---|---|---|
apiKey |
one of these two | A personal API key. Stored as a secret. |
accessToken |
one of these two | An OAuth token. Stored as a secret. |
teams |
no | Team keys to include, such as ENG,OPS. Defaults to every team the key can read. |
New records on each run
Issues are filtered by updatedAt between the last successful run and now. An issue updated again later is sent again, and its episode is rebuilt from the full history.