@zapier/zapier-sdk 0.70.3 → 0.70.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +115 -80
  3. package/dist/experimental.cjs +110 -35
  4. package/dist/experimental.d.mts +158 -2
  5. package/dist/experimental.d.ts +156 -0
  6. package/dist/experimental.d.ts.map +1 -1
  7. package/dist/experimental.mjs +110 -35
  8. package/dist/{index-rIzBEINC.d.mts → index-BNaiNmM-.d.mts} +71 -2
  9. package/dist/{index-rIzBEINC.d.ts → index-BNaiNmM-.d.ts} +71 -2
  10. package/dist/index.cjs +1 -1
  11. package/dist/index.d.mts +1 -1
  12. package/dist/index.mjs +1 -1
  13. package/dist/plugins/codeSubstrate/deleteWorkflow/index.d.ts +9 -0
  14. package/dist/plugins/codeSubstrate/deleteWorkflow/index.d.ts.map +1 -1
  15. package/dist/plugins/codeSubstrate/disableWorkflow/index.d.ts +9 -0
  16. package/dist/plugins/codeSubstrate/disableWorkflow/index.d.ts.map +1 -1
  17. package/dist/plugins/codeSubstrate/enableWorkflow/index.d.ts +9 -0
  18. package/dist/plugins/codeSubstrate/enableWorkflow/index.d.ts.map +1 -1
  19. package/dist/plugins/codeSubstrate/getDurableRun/schemas.d.ts +1 -1
  20. package/dist/plugins/codeSubstrate/getTriggerRun/schemas.d.ts +1 -1
  21. package/dist/plugins/codeSubstrate/getWorkflow/index.d.ts +31 -0
  22. package/dist/plugins/codeSubstrate/getWorkflow/index.d.ts.map +1 -1
  23. package/dist/plugins/codeSubstrate/getWorkflow/schemas.d.ts +42 -0
  24. package/dist/plugins/codeSubstrate/getWorkflow/schemas.d.ts.map +1 -1
  25. package/dist/plugins/codeSubstrate/getWorkflow/schemas.js +20 -0
  26. package/dist/plugins/codeSubstrate/getWorkflowRun/index.d.ts +9 -0
  27. package/dist/plugins/codeSubstrate/getWorkflowRun/index.d.ts.map +1 -1
  28. package/dist/plugins/codeSubstrate/getWorkflowRun/schemas.d.ts +1 -1
  29. package/dist/plugins/codeSubstrate/getWorkflowVersion/index.d.ts +35 -0
  30. package/dist/plugins/codeSubstrate/getWorkflowVersion/index.d.ts.map +1 -1
  31. package/dist/plugins/codeSubstrate/getWorkflowVersion/schemas.d.ts +13 -0
  32. package/dist/plugins/codeSubstrate/getWorkflowVersion/schemas.d.ts.map +1 -1
  33. package/dist/plugins/codeSubstrate/getWorkflowVersion/schemas.js +10 -0
  34. package/dist/plugins/codeSubstrate/listDurableRuns/schemas.d.ts +3 -3
  35. package/dist/plugins/codeSubstrate/listWorkflowRuns/index.d.ts +9 -0
  36. package/dist/plugins/codeSubstrate/listWorkflowRuns/index.d.ts.map +1 -1
  37. package/dist/plugins/codeSubstrate/listWorkflowRuns/schemas.d.ts +3 -3
  38. package/dist/plugins/codeSubstrate/listWorkflowVersions/index.d.ts +22 -0
  39. package/dist/plugins/codeSubstrate/listWorkflowVersions/index.d.ts.map +1 -1
  40. package/dist/plugins/codeSubstrate/listWorkflowVersions/schemas.d.ts +26 -0
  41. package/dist/plugins/codeSubstrate/listWorkflowVersions/schemas.d.ts.map +1 -1
  42. package/dist/plugins/codeSubstrate/listWorkflowVersions/schemas.js +10 -0
  43. package/dist/plugins/codeSubstrate/listWorkflows/index.d.ts +9 -0
  44. package/dist/plugins/codeSubstrate/listWorkflows/index.d.ts.map +1 -1
  45. package/dist/plugins/codeSubstrate/listWorkflows/schemas.d.ts +32 -0
  46. package/dist/plugins/codeSubstrate/listWorkflows/schemas.d.ts.map +1 -1
  47. package/dist/plugins/codeSubstrate/listWorkflows/schemas.js +11 -0
  48. package/dist/plugins/codeSubstrate/publishWorkflowVersion/index.d.ts +22 -0
  49. package/dist/plugins/codeSubstrate/publishWorkflowVersion/index.d.ts.map +1 -1
  50. package/dist/plugins/codeSubstrate/publishWorkflowVersion/schemas.d.ts +14 -1
  51. package/dist/plugins/codeSubstrate/publishWorkflowVersion/schemas.d.ts.map +1 -1
  52. package/dist/plugins/codeSubstrate/publishWorkflowVersion/schemas.js +11 -44
  53. package/dist/plugins/codeSubstrate/runDurable/index.d.ts +6 -0
  54. package/dist/plugins/codeSubstrate/runDurable/index.d.ts.map +1 -1
  55. package/dist/plugins/codeSubstrate/runDurable/index.js +3 -0
  56. package/dist/plugins/codeSubstrate/runDurable/schemas.d.ts +12 -0
  57. package/dist/plugins/codeSubstrate/runDurable/schemas.d.ts.map +1 -1
  58. package/dist/plugins/codeSubstrate/runDurable/schemas.js +33 -0
  59. package/dist/plugins/codeSubstrate/shared-schemas.d.ts +37 -0
  60. package/dist/plugins/codeSubstrate/shared-schemas.d.ts.map +1 -0
  61. package/dist/plugins/codeSubstrate/shared-schemas.js +69 -0
  62. package/dist/plugins/codeSubstrate/triggerWorkflow/index.d.ts +9 -0
  63. package/dist/plugins/codeSubstrate/triggerWorkflow/index.d.ts.map +1 -1
  64. package/dist/plugins/codeSubstrate/updateWorkflow/index.d.ts +11 -0
  65. package/dist/plugins/codeSubstrate/updateWorkflow/index.d.ts.map +1 -1
  66. package/dist/plugins/codeSubstrate/updateWorkflow/schemas.d.ts +2 -0
  67. package/dist/plugins/codeSubstrate/updateWorkflow/schemas.d.ts.map +1 -1
  68. package/dist/plugins/codeSubstrate/updateWorkflow/schemas.js +7 -0
  69. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # @zapier/zapier-sdk
2
2
 
3
+ ## 0.70.4
4
+
5
+ ### Patch Changes
6
+
7
+ - a790695: Response-field parity audit for the experimental code-substrate
8
+ plugins. Restores fields the backend returns that were silently
9
+ stripped by the SDK's Zod schemas after the port from
10
+ `@zapier/zapier-sdk-code-substrate`.
11
+ - `updateWorkflow`, `getWorkflow`, `listWorkflows` responses now
12
+ include `is_private`, `created_by_user_id`, and (where applicable)
13
+ `triggers` with live claim status.
14
+ - `publishWorkflowVersion`, `getWorkflowVersion`, `listWorkflowVersions`
15
+ responses now include `trigger`, `connections`, and `app_versions`.
16
+ - `runDurable` input accepts `notifications` (webhook subscribers for
17
+ run lifecycle events).
18
+
19
+ Shared schemas (`ConnectionBindingSchema`, `AppVersionBindingSchema`,
20
+ `WorkflowVersionTriggerConfigSchema`, `WorkflowTriggerSchema`) live in
21
+ a new `shared-schemas.ts` for reuse across the workflow plugins.
22
+
3
23
  ## 0.70.3
4
24
 
5
25
  ### Patch Changes
package/README.md CHANGED
@@ -1326,24 +1326,35 @@ Get a durable workflow with its current version details and trigger claim status
1326
1326
 
1327
1327
  **Returns:** `Promise<WorkflowItem>`
1328
1328
 
1329
- | Name | Type | Required | Possible Values | Description |
1330
- | ------------------------------ | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
1331
- | `data` | `object` | ✅ | — | |
1332
- | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1333
- | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1334
- | ​ ↳ `description` | `string` | ✅ | — | Optional workflow description (null if unset) |
1335
- | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1336
- | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1337
- | ​ ↳ `current_version` | `object` | | — | The currently published version, if any. Absent for workflows with no version published yet. |
1338
- | ​   ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1339
- | ​   ↳ `workflow_id` | `string` | | — | Parent workflow ID |
1340
- | ​   ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1341
- | ​   ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1342
- | ​   ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1343
- | ​   ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1344
- | ​   ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1345
- | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1346
- | ​ ↳ `updated_at` | `string` | ✅ | — | When the workflow was last modified (ISO-8601) |
1329
+ | Name | Type | Required | Possible Values | Description |
1330
+ | ------------------------------ | ---------- | -------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
1331
+ | `data` | `object` | ✅ | — | |
1332
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1333
+ | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1334
+ | ​ ↳ `description` | `string` | ✅ | — | Optional workflow description (null if unset) |
1335
+ | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1336
+ | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1337
+ | ​ ↳ `is_private` | `boolean` | | — | Whether the workflow is private to the creating user. False means account-visible. |
1338
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1339
+ | ​ ↳ `current_version` | `object` | | — | The currently published version, if any. Absent for workflows with no version published yet. |
1340
+ | ​   ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1341
+ | ​   ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID |
1342
+ | ​   ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename contents |
1343
+ | ​   ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1344
+ | ​   ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1345
+ | ​   ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1346
+ | ​   ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1347
+ | ​   ↳ `trigger` | `object` | ✅ | — | Trigger configuration persisted on this version, or null for webhook-only workflows. |
1348
+ | ​   ↳ `connections` | `object` | ✅ | — | Connection aliases bound on this version (or null). |
1349
+ | ​   ↳ `app_versions` | `object` | ✅ | — | App-version pins bound on this version (or null). |
1350
+ | ​ ↳ `triggers[]` | `object[]` | ✅ | — | Trigger configurations from the current version, with live claim status. Empty array when the workflow has no triggers. |
1351
+ | ​   ↳ `selected_api` | `string` | ✅ | — | Zapier app/API identifier (e.g. 'GoogleSheetsAPI') |
1352
+ | ​   ↳ `action` | `string` | ✅ | — | Trigger action key (e.g. 'new_row') |
1353
+ | ​   ↳ `authentication_id` | `string` | ❌ | — | Connection ID for the trigger source. Null for no-auth triggers. |
1354
+ | ​   ↳ `params` | `object` | ❌ | — | Trigger parameters as a JSON object |
1355
+ | ​   ↳ `status` | `string` | ✅ | `unclaimed`, `pending`, `active`, `releasing`, `released`, `failed` | Live trigger claim status — whether the trigger is currently subscribed to its source. |
1356
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1357
+ | ​ ↳ `updated_at` | `string` | ✅ | — | When the workflow was last modified (ISO-8601) |
1347
1358
 
1348
1359
  **Example:**
1349
1360
 
@@ -1403,16 +1414,19 @@ Get full details of a workflow version including source files
1403
1414
 
1404
1415
  **Returns:** `Promise<WorkflowVersionItem>`
1405
1416
 
1406
- | Name | Type | Required | Possible Values | Description |
1407
- | ---------------------------- | -------- | -------- | --------------- | ------------------------------------------------------------------- |
1408
- | `data` | `object` | ✅ | — | |
1409
- | ​ ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1410
- | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1411
- | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1412
- | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1413
- | ​ ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1414
- | ​ ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1415
- | ​ ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1417
+ | Name | Type | Required | Possible Values | Description |
1418
+ | ---------------------------- | -------- | -------- | --------------- | ------------------------------------------------------------------------------------ |
1419
+ | `data` | `object` | ✅ | — | |
1420
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1421
+ | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1422
+ | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1423
+ | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1424
+ | ​ ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1425
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1426
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1427
+ | ​ ↳ `trigger` | `object` | ✅ | — | Trigger configuration persisted on this version, or null for webhook-only workflows. |
1428
+ | ​ ↳ `connections` | `object` | ✅ | — | Connection aliases bound on this version (or null). |
1429
+ | ​ ↳ `app_versions` | `object` | ✅ | — | App-version pins bound on this version (or null). |
1416
1430
 
1417
1431
  **Example:**
1418
1432
 
@@ -1541,16 +1555,19 @@ List published versions for a workflow, newest first
1541
1555
 
1542
1556
  **Returns:** `Promise<PaginatedResult<WorkflowVersionItem>>`
1543
1557
 
1544
- | Name | Type | Required | Possible Values | Description |
1545
- | ---------------------------- | ---------- | -------- | --------------- | ------------------------------------------------------------------- |
1546
- | `data[]` | `object[]` | ✅ | — | |
1547
- | ​ ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1548
- | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1549
- | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1550
- | ​ ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1551
- | ​ ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1552
- | ​ ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1553
- | `nextCursor` | `string` | | — | Cursor for the next page; omitted when there are no more pages |
1558
+ | Name | Type | Required | Possible Values | Description |
1559
+ | ---------------------------- | ---------- | -------- | --------------- | ------------------------------------------------------------------------------------ |
1560
+ | `data[]` | `object[]` | ✅ | — | |
1561
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1562
+ | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1563
+ | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1564
+ | ​ ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1565
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1566
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1567
+ | ​ ↳ `trigger` | `object` | | — | Trigger configuration persisted on this version, or null for webhook-only workflows. |
1568
+ | ​ ↳ `connections` | `object` | ✅ | — | Connection aliases bound on this version (or null). |
1569
+ | ​ ↳ `app_versions` | `object` | ✅ | — | App-version pins bound on this version (or null). |
1570
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1554
1571
 
1555
1572
  **Example:**
1556
1573
 
@@ -1593,18 +1610,26 @@ List all active durable workflows for the authenticated account
1593
1610
 
1594
1611
  **Returns:** `Promise<PaginatedResult<WorkflowItem>>`
1595
1612
 
1596
- | Name | Type | Required | Possible Values | Description |
1597
- | ------------------------ | ---------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
1598
- | `data[]` | `object[]` | ✅ | — | |
1599
- | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1600
- | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1601
- | ​ ↳ `description` | `string` | ✅ | — | Optional workflow description (null if unset) |
1602
- | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1603
- | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1604
- | ​ ↳ `current_version_id` | `string` | ✅ | — | ID of the workflow version that runs handle. Null until a version is published. |
1605
- | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1606
- | ​ ↳ `updated_at` | `string` | ✅ | — | When the workflow was last modified (ISO-8601) |
1607
- | `nextCursor` | `string` | | — | Cursor for the next page; omitted when there are no more pages |
1613
+ | Name | Type | Required | Possible Values | Description |
1614
+ | ------------------------- | ---------- | -------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
1615
+ | `data[]` | `object[]` | ✅ | — | |
1616
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1617
+ | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1618
+ | ​ ↳ `description` | `string` | ✅ | — | Optional workflow description (null if unset) |
1619
+ | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1620
+ | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1621
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1622
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1623
+ | ​ ↳ `current_version_id` | `string` | ✅ | — | ID of the workflow version that runs handle. Null until a version is published. |
1624
+ | ​ ↳ `triggers[]` | `object[]` | | — | Trigger configurations from the current version, with live claim status. Empty array when the workflow has no triggers. |
1625
+ | ​   ↳ `selected_api` | `string` | ✅ | — | Zapier app/API identifier (e.g. 'GoogleSheetsAPI') |
1626
+ | ​   ↳ `action` | `string` | ✅ | — | Trigger action key (e.g. 'new_row') |
1627
+ | ​   ↳ `authentication_id` | `string` | ❌ | — | Connection ID for the trigger source. Null for no-auth triggers. |
1628
+ | ​   ↳ `params` | `object` | ❌ | — | Trigger parameters as a JSON object |
1629
+ | ​   ↳ `status` | `string` | ✅ | `unclaimed`, `pending`, `active`, `releasing`, `released`, `failed` | Live trigger claim status — whether the trigger is currently subscribed to its source. |
1630
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1631
+ | ​ ↳ `updated_at` | `string` | ✅ | — | When the workflow was last modified (ISO-8601) |
1632
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1608
1633
 
1609
1634
  **Example:**
1610
1635
 
@@ -1647,16 +1672,19 @@ Publish a new version of a durable workflow. Enables the workflow by default.
1647
1672
 
1648
1673
  **Returns:** `Promise<WorkflowVersionItem>`
1649
1674
 
1650
- | Name | Type | Required | Possible Values | Description |
1651
- | ---------------------------- | -------- | -------- | --------------- | ------------------------------------------------------------------- |
1652
- | `data` | `object` | ✅ | — | |
1653
- | ​ ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1654
- | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1655
- | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1656
- | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1657
- | ​ ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1658
- | ​ ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1659
- | ​ ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1675
+ | Name | Type | Required | Possible Values | Description |
1676
+ | ---------------------------- | -------- | -------- | --------------- | ------------------------------------------------------------------------------------ |
1677
+ | `data` | `object` | ✅ | — | |
1678
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow version ID (UUID) |
1679
+ | ​ ↳ `workflow_id` | `string` | ✅ | — | Parent workflow ID (UUID) |
1680
+ | ​ ↳ `source_files` | `object` | ✅ | — | Source files keyed by filename → contents |
1681
+ | ​ ↳ `zapier_durable_version` | `string` | ✅ | — | Pinned semver of @zapier/zapier-durable used by this version's runs |
1682
+ | ​ ↳ `dependencies` | `object` | ✅ | — | Additional npm dependencies pinned for this version (or null) |
1683
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | ID of the user who published this version |
1684
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the version was published (ISO-8601) |
1685
+ | ​ ↳ `trigger` | `object` | ✅ | — | Trigger configuration persisted on this version, or null for webhook-only workflows. |
1686
+ | ​ ↳ `connections` | `object` | ✅ | — | Connection aliases bound on this version (or null). |
1687
+ | ​ ↳ `app_versions` | `object` | ✅ | — | App-version pins bound on this version (or null). |
1660
1688
 
1661
1689
  **Example:**
1662
1690
 
@@ -1673,16 +1701,21 @@ Run a workflow source file as a run-once durable run on sdkdurableapi (no deploy
1673
1701
 
1674
1702
  **Parameters:**
1675
1703
 
1676
- | Name | Type | Required | Default | Possible Values | Description |
1677
- | ---------------------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------- |
1678
- | `options` | `object` | ✅ | — | — | |
1679
- | ​ ↳ `source_files` | `object` | ✅ | — | — | Source files keyed by filename → contents |
1680
- | ​ ↳ `input` | `unknown` | ❌ | — | — | Input data passed to the run |
1681
- | ​ ↳ `dependencies` | `object` | ❌ | — | — | Optional npm package dependencies |
1682
- | ​ ↳ `zapier_durable_version` | `string` | ❌ | — | — | Exact semver of @zapier/zapier-durable to use (e.g. "1.2.3"). Defaults to server-configured version if omitted. |
1683
- | ​ ↳ `connections` | `object` | ❌ | — | — | Named connection aliases. Maps alias names to Zapier connection IDs. |
1684
- | ​ ↳ `app_versions` | `object` | ❌ | — | — | Pinned app versions. Maps app keys (slugs) to implementation names and versions. |
1685
- | ​ ↳ `private` | `boolean` | ❌ | — | — | Only the creating user can see the run (default false) |
1704
+ | Name | Type | Required | Default | Possible Values | Description |
1705
+ | ---------------------------- | ---------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------- |
1706
+ | `options` | `object` | ✅ | — | — | |
1707
+ | ​ ↳ `source_files` | `object` | ✅ | — | — | Source files keyed by filename → contents |
1708
+ | ​ ↳ `input` | `unknown` | ❌ | — | — | Input data passed to the run |
1709
+ | ​ ↳ `dependencies` | `object` | ❌ | — | — | Optional npm package dependencies |
1710
+ | ​ ↳ `zapier_durable_version` | `string` | ❌ | — | — | Exact semver of @zapier/zapier-durable to use (e.g. "1.2.3"). Defaults to server-configured version if omitted. |
1711
+ | ​ ↳ `connections` | `object` | ❌ | — | — | Named connection aliases. Maps alias names to Zapier connection IDs. |
1712
+ | ​ ↳ `app_versions` | `object` | ❌ | — | — | Pinned app versions. Maps app keys (slugs) to implementation names and versions. |
1713
+ | ​ ↳ `private` | `boolean` | ❌ | — | — | Only the creating user can see the run (default false) |
1714
+ | ​ ↳ `notifications[]` | `object[]` | ❌ | — | — | Webhook subscribers for run lifecycle events. Each entry specifies a URL and the events it subscribes to. |
1715
+ | ​   ↳ `type` | `string` | ❌ | — | `webhook` | Notification transport. Webhook is the only supported type. |
1716
+ | ​   ↳ `url` | `string` | ✅ | — | — | URL to POST event notifications to. Payload is `{run_id, event}`. |
1717
+ | ​   ↳ `max_retries` | `number` | ❌ | — | — | Max delivery attempts with exponential backoff. Defaults to 3 server-side. |
1718
+ | ​   ↳ `events` | `array` | ✅ | — | — | One or more lifecycle events to subscribe this URL to. |
1686
1719
 
1687
1720
  **Returns:** `Promise<DurableRunItem>`
1688
1721
 
@@ -1746,16 +1779,18 @@ Update a durable workflow's name and/or description
1746
1779
 
1747
1780
  **Returns:** `Promise<WorkflowItem>`
1748
1781
 
1749
- | Name | Type | Required | Possible Values | Description |
1750
- | ----------------- | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
1751
- | `data` | `object` | ✅ | — | |
1752
- | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1753
- | ​ ↳ `name` | `string` | ✅ | — | Workflow name (post-update) |
1754
- | ​ ↳ `description` | `string` | ✅ | — | Workflow description, post-update (null if unset) |
1755
- | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1756
- | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1757
- | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1758
- | ​ ↳ `updated_at` | `string` | ✅ | — | When this update was applied (ISO-8601) |
1782
+ | Name | Type | Required | Possible Values | Description |
1783
+ | ------------------------ | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
1784
+ | `data` | `object` | ✅ | — | |
1785
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1786
+ | ​ ↳ `name` | `string` | ✅ | — | Workflow name (post-update) |
1787
+ | ​ ↳ `description` | `string` | ✅ | — | Workflow description, post-update (null if unset) |
1788
+ | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1789
+ | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1790
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1791
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1792
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1793
+ | ​ ↳ `updated_at` | `string` | ✅ | — | When this update was applied (ISO-8601) |
1759
1794
 
1760
1795
  **Example:**
1761
1796
 
@@ -3188,7 +3188,7 @@ function createSseParserStream() {
3188
3188
  }
3189
3189
 
3190
3190
  // src/sdk-version.ts
3191
- var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.70.3" : void 0) || "unknown";
3191
+ var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.70.4" : void 0) || "unknown";
3192
3192
 
3193
3193
  // src/utils/open-url.ts
3194
3194
  var nodePrefix = "node:";
@@ -11197,6 +11197,52 @@ var codeSubstrateDefaults = {
11197
11197
  categories: ["code-workflow"],
11198
11198
  experimental: true
11199
11199
  };
11200
+ var ConnectionBindingSchema = zod.z.object({
11201
+ connection_id: zod.z.union([
11202
+ zod.z.number().int().positive(),
11203
+ zod.z.string().regex(/^[1-9][0-9]*$/, "must be a positive integer string"),
11204
+ zod.z.string().uuid("must be a UUID")
11205
+ ]).describe(
11206
+ "Zapier connection ID. Positive integer (legacy) or UUID string (newer)."
11207
+ )
11208
+ }).describe(
11209
+ "Connection binding: maps a single alias to a concrete connection."
11210
+ );
11211
+ var AppVersionBindingSchema = zod.z.object({
11212
+ implementation_name: zod.z.string().describe("App implementation identifier (e.g. 'SlackCLIAPI')"),
11213
+ version: zod.z.string().optional().describe("App implementation version (e.g. '1.27.1')")
11214
+ }).describe("App-version binding: maps a single alias to an app version.");
11215
+ var WorkflowVersionTriggerConfigSchema = zod.z.object({
11216
+ selected_api: zod.z.string().describe("Zapier app/API identifier (e.g. 'GoogleSheetsAPI')"),
11217
+ action: zod.z.string().describe("Trigger action key (e.g. 'new_row')"),
11218
+ authentication_id: zod.z.string().nullish().describe(
11219
+ "Connection ID for the trigger source. Omit or pass null for no-auth triggers (e.g. Schedule by Zapier)."
11220
+ ),
11221
+ params: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe("Trigger parameters as a JSON object")
11222
+ }).describe("Trigger configuration persisted on a workflow version.");
11223
+ var WorkflowTriggerStatusSchema = zod.z.enum([
11224
+ "unclaimed",
11225
+ "pending",
11226
+ "active",
11227
+ "releasing",
11228
+ "released",
11229
+ "failed"
11230
+ ]);
11231
+ var WorkflowTriggerSchema = zod.z.object({
11232
+ selected_api: zod.z.string().describe("Zapier app/API identifier (e.g. 'GoogleSheetsAPI')"),
11233
+ action: zod.z.string().describe("Trigger action key (e.g. 'new_row')"),
11234
+ authentication_id: zod.z.string().nullish().describe(
11235
+ "Connection ID for the trigger source. Null for no-auth triggers."
11236
+ ),
11237
+ params: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe("Trigger parameters as a JSON object"),
11238
+ status: WorkflowTriggerStatusSchema.describe(
11239
+ "Live trigger claim status \u2014 whether the trigger is currently subscribed to its source."
11240
+ )
11241
+ }).describe(
11242
+ "Trigger from a workflow's current version, combined with the live claim status."
11243
+ );
11244
+
11245
+ // src/plugins/codeSubstrate/listWorkflows/schemas.ts
11200
11246
  var WorkflowItemSchema = zod.z.object({
11201
11247
  id: zod.z.string().describe("Workflow ID (UUID)"),
11202
11248
  name: zod.z.string().describe("Workflow name"),
@@ -11205,9 +11251,16 @@ var WorkflowItemSchema = zod.z.object({
11205
11251
  "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
11206
11252
  ),
11207
11253
  enabled: zod.z.boolean().describe("Whether the workflow currently accepts triggers"),
11254
+ is_private: zod.z.boolean().describe(
11255
+ "Whether the workflow is private to the creating user. False means account-visible."
11256
+ ),
11257
+ created_by_user_id: zod.z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
11208
11258
  current_version_id: zod.z.string().nullable().describe(
11209
11259
  "ID of the workflow version that runs handle. Null until a version is published."
11210
11260
  ),
11261
+ triggers: zod.z.array(WorkflowTriggerSchema).describe(
11262
+ "Trigger configurations from the current version, with live claim status. Empty array when the workflow has no triggers."
11263
+ ),
11211
11264
  created_at: zod.z.string().describe("When the workflow was created (ISO-8601)"),
11212
11265
  updated_at: zod.z.string().describe("When the workflow was last modified (ISO-8601)")
11213
11266
  });
@@ -11266,7 +11319,12 @@ var WorkflowVersionSchema = zod.z.object({
11266
11319
  // Backend column is NOT NULL (see durableworkflowzaps prisma schema:
11267
11320
  // workflow_versions.created_by_user_id), so this is always emitted.
11268
11321
  created_by_user_id: zod.z.string().describe("ID of the user who published this version"),
11269
- created_at: zod.z.string().describe("When the version was published (ISO-8601)")
11322
+ created_at: zod.z.string().describe("When the version was published (ISO-8601)"),
11323
+ trigger: WorkflowVersionTriggerConfigSchema.nullable().describe(
11324
+ "Trigger configuration persisted on this version, or null for webhook-only workflows."
11325
+ ),
11326
+ connections: zod.z.record(zod.z.string(), ConnectionBindingSchema).nullable().describe("Connection aliases bound on this version (or null)."),
11327
+ app_versions: zod.z.record(zod.z.string(), AppVersionBindingSchema).nullable().describe("App-version pins bound on this version (or null).")
11270
11328
  });
11271
11329
  var GetWorkflowOptionsSchema = zod.z.object({
11272
11330
  workflow: zod.z.string().uuid().describe("Durable workflow ID")
@@ -11281,9 +11339,16 @@ var GetWorkflowResponseSchema = zod.z.object({
11281
11339
  "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
11282
11340
  ),
11283
11341
  enabled: zod.z.boolean().describe("Whether the workflow currently accepts triggers"),
11342
+ is_private: zod.z.boolean().describe(
11343
+ "Whether the workflow is private to the creating user. False means account-visible."
11344
+ ),
11345
+ created_by_user_id: zod.z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
11284
11346
  current_version: WorkflowVersionSchema.optional().describe(
11285
11347
  "The currently published version, if any. Absent for workflows with no version published yet."
11286
11348
  ),
11349
+ triggers: zod.z.array(WorkflowTriggerSchema).describe(
11350
+ "Trigger configurations from the current version, with live claim status. Empty array when the workflow has no triggers."
11351
+ ),
11287
11352
  created_at: zod.z.string().describe("When the workflow was created (ISO-8601)"),
11288
11353
  updated_at: zod.z.string().describe("When the workflow was last modified (ISO-8601)")
11289
11354
  });
@@ -11379,6 +11444,10 @@ var UpdateWorkflowResponseSchema = zod.z.object({
11379
11444
  "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
11380
11445
  ),
11381
11446
  enabled: zod.z.boolean().describe("Whether the workflow currently accepts triggers"),
11447
+ is_private: zod.z.boolean().describe(
11448
+ "Whether the workflow is private to the creating user. False means account-visible."
11449
+ ),
11450
+ created_by_user_id: zod.z.string().nullable().describe("User ID of the workflow creator (null in legacy data)"),
11382
11451
  created_at: zod.z.string().describe("When the workflow was created (ISO-8601)"),
11383
11452
  updated_at: zod.z.string().describe("When this update was applied (ISO-8601)")
11384
11453
  });
@@ -11714,6 +11783,19 @@ var AppVersionMapEntrySchema = zod.z.object({
11714
11783
  implementation_name: zod.z.string().min(1).describe("Zapier app implementation name (e.g. `SlackCLIAPI`)"),
11715
11784
  version: zod.z.string().optional().describe("Pinned app version (e.g. `1.27.1`). Latest if omitted.")
11716
11785
  });
11786
+ var RunNotificationEventSchema = zod.z.enum(["started", "progress", "completed", "error", "cancelled"]).describe("Run lifecycle event this notification subscribes to");
11787
+ var RunNotificationSchema = zod.z.object({
11788
+ type: zod.z.literal("webhook").optional().describe("Notification transport. Webhook is the only supported type."),
11789
+ url: zod.z.string().url().describe(
11790
+ "URL to POST event notifications to. Payload is `{run_id, event}`."
11791
+ ),
11792
+ max_retries: zod.z.number().int().min(0).max(10).optional().describe(
11793
+ "Max delivery attempts with exponential backoff. Defaults to 3 server-side."
11794
+ ),
11795
+ events: zod.z.array(RunNotificationEventSchema).min(1).describe("One or more lifecycle events to subscribe this URL to.")
11796
+ }).describe(
11797
+ "Webhook subscriber for run lifecycle events. Server POSTs `{run_id, event}` on each subscribed transition."
11798
+ );
11717
11799
  var RunDurableOptionsSchema = zod.z.object({
11718
11800
  source_files: zod.z.record(zod.z.string(), zod.z.string()).refine((files) => Object.keys(files).length > 0, {
11719
11801
  message: "source_files must contain at least one file"
@@ -11729,7 +11811,10 @@ var RunDurableOptionsSchema = zod.z.object({
11729
11811
  app_versions: zod.z.record(zod.z.string(), AppVersionMapEntrySchema).optional().describe(
11730
11812
  "Pinned app versions. Maps app keys (slugs) to implementation names and versions."
11731
11813
  ),
11732
- private: zod.z.boolean().optional().describe("Only the creating user can see the run (default false)")
11814
+ private: zod.z.boolean().optional().describe("Only the creating user can see the run (default false)"),
11815
+ notifications: zod.z.array(RunNotificationSchema).optional().describe(
11816
+ "Webhook subscribers for run lifecycle events. Each entry specifies a URL and the events it subscribes to."
11817
+ )
11733
11818
  }).describe(
11734
11819
  "Run a workflow source file as a run-once durable run on sdkdurableapi (no deployed workflow required). Returns the run ID immediately; poll via getDurableRun for terminal status."
11735
11820
  );
@@ -11775,6 +11860,9 @@ var runDurablePlugin = definePlugin(
11775
11860
  if (options.private !== void 0) {
11776
11861
  body.is_private = options.private;
11777
11862
  }
11863
+ if (options.notifications !== void 0) {
11864
+ body.notifications = options.notifications;
11865
+ }
11778
11866
  const raw = await sdk2.context.api.post(
11779
11867
  "/sdkdurableapi/api/v0/runs",
11780
11868
  body,
@@ -11822,34 +11910,6 @@ var cancelDurableRunPlugin = definePlugin(
11822
11910
  }
11823
11911
  })
11824
11912
  );
11825
- var CONNECTION_ID_PATTERN = /^([1-9][0-9]*|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$/;
11826
- var ConnectionBindingSchema = zod.z.object({
11827
- connection_id: zod.z.union([
11828
- zod.z.number().int().positive(),
11829
- zod.z.string().regex(
11830
- CONNECTION_ID_PATTERN,
11831
- "connection_id must be a positive integer string or UUID"
11832
- )
11833
- ]).describe(
11834
- "Zapier connection ID. Positive integer (legacy) or UUID string (newer)."
11835
- )
11836
- }).describe(
11837
- "Connection binding: maps a single alias to a concrete connection."
11838
- );
11839
- var AppVersionBindingSchema = zod.z.object({
11840
- implementation_name: zod.z.string().describe("App implementation identifier (e.g. 'SlackCLIAPI')"),
11841
- version: zod.z.string().optional().describe("App implementation version (e.g. '1.27.1')")
11842
- }).describe("App-version binding: maps a single alias to an app version.");
11843
- var TriggerConfigSchema = zod.z.object({
11844
- selected_api: zod.z.string().describe("Zapier app/API identifier (e.g. 'GoogleSheetsAPI')"),
11845
- action: zod.z.string().describe("Trigger action key (e.g. 'new_row')"),
11846
- authentication_id: zod.z.string().nullish().describe(
11847
- "Connection ID for the trigger source. Omit or pass null for no-auth triggers (e.g. Schedule by Zapier)."
11848
- ),
11849
- params: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe("Trigger parameters as a JSON object")
11850
- }).describe(
11851
- "Zapier trigger configuration. When set, the workflow subscribes to trigger events."
11852
- );
11853
11913
  var PublishWorkflowVersionOptionsSchema = zod.z.object({
11854
11914
  workflow: zod.z.string().uuid().describe("Durable workflow ID"),
11855
11915
  source_files: zod.z.record(zod.z.string(), zod.z.string()).refine((files) => Object.keys(files).length > 0, {
@@ -11868,7 +11928,7 @@ var PublishWorkflowVersionOptionsSchema = zod.z.object({
11868
11928
  app_versions: zod.z.record(zod.z.string(), AppVersionBindingSchema).nullish().describe(
11869
11929
  "Map of app keys to pinned app implementation/version used by the workflow. Pass `null` to clear an existing binding."
11870
11930
  ),
11871
- trigger: TriggerConfigSchema.optional().describe(
11931
+ trigger: WorkflowVersionTriggerConfigSchema.optional().describe(
11872
11932
  "Trigger configuration. When provided, the workflow subscribes to a Zapier trigger; omit for webhook-only workflows."
11873
11933
  )
11874
11934
  }).describe(
@@ -11883,7 +11943,12 @@ var PublishWorkflowVersionResponseSchema = zod.z.object({
11883
11943
  ),
11884
11944
  dependencies: zod.z.record(zod.z.string(), zod.z.string()).nullable().describe("Additional npm dependencies pinned for this version (or null)"),
11885
11945
  created_by_user_id: zod.z.string().describe("ID of the user who published this version"),
11886
- created_at: zod.z.string().describe("When the version was published (ISO-8601)")
11946
+ created_at: zod.z.string().describe("When the version was published (ISO-8601)"),
11947
+ trigger: WorkflowVersionTriggerConfigSchema.nullable().describe(
11948
+ "Trigger configuration persisted on this version, or null for webhook-only workflows."
11949
+ ),
11950
+ connections: zod.z.record(zod.z.string(), ConnectionBindingSchema).nullable().describe("Connection aliases bound on this version (or null)."),
11951
+ app_versions: zod.z.record(zod.z.string(), AppVersionBindingSchema).nullable().describe("App-version pins bound on this version (or null).")
11887
11952
  });
11888
11953
 
11889
11954
  // src/plugins/codeSubstrate/publishWorkflowVersion/index.ts
@@ -11939,7 +12004,12 @@ var WorkflowVersionListItemSchema = zod.z.object({
11939
12004
  ),
11940
12005
  dependencies: zod.z.record(zod.z.string(), zod.z.string()).nullable().describe("Additional npm dependencies pinned for this version (or null)"),
11941
12006
  created_by_user_id: zod.z.string().describe("ID of the user who published this version"),
11942
- created_at: zod.z.string().describe("When the version was published (ISO-8601)")
12007
+ created_at: zod.z.string().describe("When the version was published (ISO-8601)"),
12008
+ trigger: WorkflowVersionTriggerConfigSchema.nullable().describe(
12009
+ "Trigger configuration persisted on this version, or null for webhook-only workflows."
12010
+ ),
12011
+ connections: zod.z.record(zod.z.string(), ConnectionBindingSchema).nullable().describe("Connection aliases bound on this version (or null)."),
12012
+ app_versions: zod.z.record(zod.z.string(), AppVersionBindingSchema).nullable().describe("App-version pins bound on this version (or null).")
11943
12013
  });
11944
12014
  var ListWorkflowVersionsOptionsSchema = zod.z.object({
11945
12015
  workflow: zod.z.string().uuid().describe("Durable workflow ID"),
@@ -12007,7 +12077,12 @@ var GetWorkflowVersionResponseSchema = zod.z.object({
12007
12077
  ),
12008
12078
  dependencies: zod.z.record(zod.z.string(), zod.z.string()).nullable().describe("Additional npm dependencies pinned for this version (or null)"),
12009
12079
  created_by_user_id: zod.z.string().describe("ID of the user who published this version"),
12010
- created_at: zod.z.string().describe("When the version was published (ISO-8601)")
12080
+ created_at: zod.z.string().describe("When the version was published (ISO-8601)"),
12081
+ trigger: WorkflowVersionTriggerConfigSchema.nullable().describe(
12082
+ "Trigger configuration persisted on this version, or null for webhook-only workflows."
12083
+ ),
12084
+ connections: zod.z.record(zod.z.string(), ConnectionBindingSchema).nullable().describe("Connection aliases bound on this version (or null)."),
12085
+ app_versions: zod.z.record(zod.z.string(), AppVersionBindingSchema).nullable().describe("App-version pins bound on this version (or null).")
12011
12086
  });
12012
12087
 
12013
12088
  // src/plugins/codeSubstrate/getWorkflowVersion/index.ts