elements-sync

Create Requirements and Stories in Elements.cloud via its REST API.

Updated Dec 1, 2025
One-click install
npx skills add https://github.com/jterratsdev/smart-deployment --skill elements-sync-jterratsdev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: elements-sync
Source: https://github.com/jterratsdev/smart-deployment/tree/main/.setup-agents/skills/elements-sync
Command: npx skills add https://github.com/jterratsdev/smart-deployment --skill elements-sync-jterratsdev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? Manually transcribing story maps and backlog documents into Elements.cloud is repetitive and error-prone. This Skill automates the creation of Requirements and Stories through the Elements REST API, keeping parent-child links intact. ## Core Features & Use Cases - Requirement Creation: Push Epics as Requirements with priority, impact, risk, tags, release, and assignee fields via POST /requirements. - Story Creation with Linking: Create Stories with acceptance criteria and external IDs, linked to parent Requirements by ID. - Field Mapping Guidance: Built-in mapping table converts story map fields (Epic title, US IDs, P1/P2/P3 priorities) into Elements API fields. - Use Case: A business analyst finishes a story map workshop and pushes 5 Epics as Requirements and 20 user stories as linked Stories into their Elements Space in one session, with per-item success reporting. ## Quick Start Push the story map in this document to Elements.cloud, creating one Requirement per Epic and linking each user story to its parent Requirement.

Frequently Asked Questions about elements-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a story in Elements.cloud via API?

Send a POST request to https://api.elements.cloud/v1/stories with an X-API-KEY header and a JSON body containing at least a summary field. You can also include description, acceptanceCriteria, risk, and a requirement field to link it to a parent Requirement.

How do I push a story map to Elements.cloud?

Map each Epic to a Requirement (summary, whatIsRequired, priority) and each user story to a Story (summary, acceptanceCriteria, externalId). Create Requirements first, record their returned IDs, then create Stories with the requirement field set to the parent ID.

What environment variables does the Elements.cloud API need?

You need ELEMENTS_API_KEY, obtained from Elements Space Management under Developer > API Tokens, and ELEMENTS_SPACE_NAME, which is your Space name shown in the app URL. Both should be exported in your shell profile and never committed to version control.

Why does the Elements.cloud API return 401 or 429 errors?

A 401 means the ELEMENTS_API_KEY is missing or invalid, so verify the token in your Space's Developer settings. A 429 means you hit the rate limit of 100 requests per second or 5000 per month; wait until the X-RateLimit-Reset time before retrying.

What fields are required to create a Requirement in Elements.cloud?

Requirements need summary, priority, impact, and risk, where the numeric fields are integers typically from 1 to 3 with 1 being highest. Optional fields include whatIsRequired, howItMightBeImplemented, requiredBy date, tags, release, and assignee.