Connector capabilities

Connector Push Stories Push Test Cases Pull Documents Import Epics Sprint Export
GitHub
GitLab (wiki)
Jira
Azure DevOps
Confluence
GitHub Wiki
GitLab Wiki
Notion
GitBook
Google Drive
SharePoint
Slab
Coda
Nuclino
Xray
TestRail
ZephyrScale

Adding a connector

  1. 1

    Navigate to Connectors

    Click Connectors in the sidebar. You need the MANAGE_CONNECTORS permission (Member role or above).

  2. 2

    Click "New Connector"

    Select the connector type from the dropdown. The form adapts to show the fields required for that connector.

  3. 3

    Fill in credentials

    Enter the required fields. See the connector-specific sections below for what each field means.

  4. 4

    Test the connection

    Click Test Connection before saving. Storymate makes a lightweight API call to verify credentials and permissions.

GitHub

FieldDescription
Personal Access TokenA GitHub PAT with repo scope. Create at Settings → Developer settings → Personal access tokens.
OwnerGitHub username or organization name that owns the repository.
RepositoryRepository name (not the full URL — just the repo slug).
LabelsOptional comma-separated labels to apply to pushed issues (e.g. user-story,storymate).

GitLab

FieldDescription
Base URLLeave blank to use https://gitlab.com. For self-hosted: https://gitlab.yourcompany.com.
Private TokenA GitLab personal access token with api scope.
Project ID or PathEither the numeric project ID or the path like group/project.
LabelsOptional comma-separated labels to apply to pushed issues.

Jira

FieldDescription
Base URLYour Atlassian URL, e.g. https://yourorg.atlassian.net.
EmailThe email of the Jira user whose API token you are using.
API TokenCreate at id.atlassian.com → Security → API tokens.
Project KeyThe Jira project key (e.g. PROJ).
Issue TypeDefaults to Story. Change to match your Jira workflow (e.g. User Story).

Azure DevOps

FieldDescription
OrganizationYour ADO organization name (the part after dev.azure.com/).
ProjectThe ADO project name.
Personal Access TokenA PAT with Work Items (Read & Write) scope.
Work Item TypeDefaults to User Story. Change to Product Backlog Item for Scrum templates.

Confluence

FieldDescription
Base URLYour Atlassian URL, e.g. https://yourorg.atlassian.net.
EmailEmail of the Confluence user whose API token you are using.
API TokenSame token as Jira — Atlassian tokens are shared across products.
Space KeyThe Confluence space key from which pages will be pulled as documents.

Xray

FieldDescription
Base URLFor Xray Cloud: https://xray.cloud.getxray.app. For Server/DC, your instance URL.
Client IDFrom Xray → Settings → API Keys.
Client SecretFrom Xray → Settings → API Keys.
Jira Project KeyThe key of the Jira project where test cases will be created.

TestRail

FieldDescription
Base URLYour TestRail URL, e.g. https://yourorg.testrail.io.
EmailEmail of the TestRail user.
API KeyGenerate in TestRail under your profile → API Keys.
Project IDThe numeric TestRail project ID (visible in the URL when on the project page).

ZephyrScale

FieldDescription
Base URLhttps://api.zephyrscale.smartbear.com for cloud, or your server URL.
API TokenGenerate from Zephyr Scale → API access tokens.
Jira Project KeyThe Jira project where Zephyr Scale test cases will be created.

Notion

FieldDescription
Integration TokenCreate a Notion integration and use the internal integration token. See Notion's My Integrations page.
Database or Page IDThe ID of the Notion database or page to pull content from.

GitBook

FieldDescription
API TokenGenerate from GitBook → Developer settings → API tokens.
Space IDThe GitBook space ID from which pages will be pulled.

Google Drive

FieldDescription
OAuth Client IDFrom Google Cloud Console → APIs & Services → Credentials.
OAuth Client SecretCorresponding client secret for the OAuth 2.0 application.
Folder ID (optional)Restrict document pulling to a specific Drive folder.

SharePoint

FieldDescription
Site URLYour SharePoint site URL, e.g. https://yourorg.sharepoint.com/sites/YourSite.
Client IDFrom Azure AD app registration.
Client SecretCorresponding secret for the app registration.

GitHub Wiki

FieldDescription
Personal Access TokenSame GitHub PAT used for issue push, requiring repo scope.
OwnerGitHub username or organization that owns the wiki repository.
RepositoryRepository name (the wiki is typically repo.wiki.git).

Pushing estimates to connectors

When a story has an estimate assigned (story points, T-shirt size, or hours), the estimate is included in the push payload to ticketing connectors that support custom fields:

  • Jira — estimate is set on the Story Points or custom estimation field.
  • GitHub — estimate is appended to the issue body as a label or metadata.
  • GitLab — estimate is set as the weight field or appended to the description.
  • Azure DevOps — estimate is set on the Effort or Story Points field.

Jira connector improvements

The Jira connector uses the Jira API v3 (platform REST API). Key improvements:

  • Configurable issue type — set the issue type (Story, User Story, Feature, etc.) in connector settings.
  • Epic import — imports the epic's title, description, and linked issues.
  • External ref tracking — pushed stories are tracked by their Jira issue key for status sync.

Auto-sync

Connectors that support document pull (all wiki and documentation connectors) can be configured with Auto-Sync. Enable it on the connector and set a sync interval (in hours). Storymate will automatically re-pull documents on schedule and update the organization's document library.