Skip to content

Commit 3c8bb40

Browse files
authored
v0.6.33: polling improvements, jsm forms tools, credentials reactquery invalidation, HITL docs
2 parents f8f3758 + c393791 commit 3c8bb40

File tree

42 files changed

+4104
-454
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+4104
-454
lines changed

apps/docs/content/docs/en/blocks/human-in-the-loop.mdx

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,26 +126,38 @@ Access resume data in downstream blocks using `<blockId.fieldName>`.
126126

127127
- **Stream mode** (`stream: true` on the original execute call) — The resume response streams SSE events with `selectedOutputs` chunks, just like the initial execution.
128128

129-
- **Async mode** (`X-Execution-Mode: async` on the original execute call) — The resume dispatches execution to a background worker and returns immediately with `202`:
129+
- **Async mode** (`X-Execution-Mode: async` on the original execute call) — The resume dispatches execution to a background worker and returns immediately with `202`, including a `jobId` and `statusUrl` for polling:
130130

131131
```json
132132
{
133-
"status": "started",
133+
"success": true,
134+
"async": true,
135+
"jobId": "<jobId>",
134136
"executionId": "<resumeExecutionId>",
135-
"message": "Resume execution started asynchronously."
137+
"message": "Resume execution queued",
138+
"statusUrl": "/api/jobs/<jobId>"
136139
}
137140
```
138141

139142
#### Polling execution status
140143

141-
To check on a paused execution or poll for completion after an async resume:
144+
Poll the `statusUrl` from the async response to check when the resume completes:
145+
146+
```bash
147+
GET /api/jobs/{jobId}
148+
X-API-Key: your-api-key
149+
```
150+
151+
Returns job status and, when completed, the full workflow output.
152+
153+
To check on a paused execution's pause points and resume links:
142154

143155
```bash
144156
GET /api/resume/{workflowId}/{executionId}
145157
X-API-Key: your-api-key
146158
```
147159

148-
Returns the full paused execution detail with all pause points, their statuses, and resume links. Returns `404` when the execution has completed and is no longer paused.
160+
Returns the paused execution detail with all pause points, their statuses, and resume links. Returns `404` when the execution has completed and is no longer paused.
149161
</Tab>
150162
<Tab>
151163
### Webhook

apps/docs/content/docs/en/tools/jira_service_management.mdx

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -678,4 +678,84 @@ Get the fields required to create a request of a specific type in Jira Service M
678678
|`defaultValues` | json | Default values for the field |
679679
|`jiraSchema` | json | Jira field schema with type, system, custom, customId |
680680

681+
### `jsm_get_form_templates`
682+
683+
List forms (ProForma/JSM Forms) in a Jira project to discover form IDs for request types
684+
685+
#### Input
686+
687+
| Parameter | Type | Required | Description |
688+
| --------- | ---- | -------- | ----------- |
689+
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
690+
| `cloudId` | string | No | Jira Cloud ID for the instance |
691+
| `projectIdOrKey` | string | Yes | Jira project ID or key \(e.g., "10001" or "SD"\) |
692+
693+
#### Output
694+
695+
| Parameter | Type | Description |
696+
| --------- | ---- | ----------- |
697+
| `ts` | string | Timestamp of the operation |
698+
| `projectIdOrKey` | string | Project ID or key |
699+
| `templates` | array | List of forms in the project |
700+
|`id` | string | Form template ID \(UUID\) |
701+
|`name` | string | Form template name |
702+
|`updated` | string | Last updated timestamp \(ISO 8601\) |
703+
|`issueCreateIssueTypeIds` | json | Issue type IDs that auto-attach this form on issue create |
704+
|`issueCreateRequestTypeIds` | json | Request type IDs that auto-attach this form on issue create |
705+
|`portalRequestTypeIds` | json | Request type IDs that show this form on the customer portal |
706+
|`recommendedIssueRequestTypeIds` | json | Request type IDs that recommend this form |
707+
| `total` | number | Total number of forms |
708+
709+
### `jsm_get_form_structure`
710+
711+
Get the full structure of a ProForma/JSM form including all questions, field types, choices, layout, and conditions
712+
713+
#### Input
714+
715+
| Parameter | Type | Required | Description |
716+
| --------- | ---- | -------- | ----------- |
717+
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
718+
| `cloudId` | string | No | Jira Cloud ID for the instance |
719+
| `projectIdOrKey` | string | Yes | Jira project ID or key \(e.g., "10001" or "SD"\) |
720+
| `formId` | string | Yes | Form ID \(UUID from Get Form Templates\) |
721+
722+
#### Output
723+
724+
| Parameter | Type | Description |
725+
| --------- | ---- | ----------- |
726+
| `ts` | string | Timestamp of the operation |
727+
| `projectIdOrKey` | string | Project ID or key |
728+
| `formId` | string | Form ID |
729+
| `design` | json | Full form design with questions \(field types, labels, choices, validation\), layout \(field ordering\), and conditions |
730+
| `updated` | string | Last updated timestamp |
731+
| `publish` | json | Publishing and request type configuration |
732+
733+
### `jsm_get_issue_forms`
734+
735+
List forms (ProForma/JSM Forms) attached to a Jira issue with metadata (name, submitted status, lock)
736+
737+
#### Input
738+
739+
| Parameter | Type | Required | Description |
740+
| --------- | ---- | -------- | ----------- |
741+
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
742+
| `cloudId` | string | No | Jira Cloud ID for the instance |
743+
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., "SD-123", "10001"\) |
744+
745+
#### Output
746+
747+
| Parameter | Type | Description |
748+
| --------- | ---- | ----------- |
749+
| `ts` | string | Timestamp of the operation |
750+
| `issueIdOrKey` | string | Issue ID or key |
751+
| `forms` | array | List of forms attached to the issue |
752+
|`id` | string | Form instance ID \(UUID\) |
753+
|`name` | string | Form name |
754+
|`updated` | string | Last updated timestamp \(ISO 8601\) |
755+
|`submitted` | boolean | Whether the form has been submitted |
756+
|`lock` | boolean | Whether the form is locked |
757+
|`internal` | boolean | Whether the form is internal-only |
758+
|`formTemplateId` | string | Source form template ID \(UUID\) |
759+
| `total` | number | Total number of forms |
760+
681761

0 commit comments

Comments
 (0)