@zapier/zapier-sdk 0.83.0 → 0.83.1

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 (9) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +48 -46
  3. package/dist/experimental.cjs +18 -13
  4. package/dist/experimental.d.mts +12 -0
  5. package/dist/experimental.d.ts +12 -0
  6. package/dist/experimental.mjs +18 -13
  7. package/dist/index.cjs +1 -1
  8. package/dist/index.mjs +1 -1
  9. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @zapier/zapier-sdk
2
2
 
3
+ ## 0.83.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 6201fd4: `getWorkflow` and `listWorkflows` now include a nullable `details` field on each trigger (e.g. `webhook_url` for catch-hook triggers). Also corrected the `trigger_url` field description to note that requests must also be authenticated as the account.
8
+
3
9
  ## 0.83.0
4
10
 
5
11
  ### Minor Changes
package/README.md CHANGED
@@ -1149,17 +1149,17 @@ Create a durable workflow container. Starts disabled with no version; publish a
1149
1149
 
1150
1150
  **Returns:** `Promise<WorkflowItem>`
1151
1151
 
1152
- | Name | Type | Required | Possible Values | Description |
1153
- | ------------------------ | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
1154
- | `data` | `object` | ✅ | — | |
1155
- | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1156
- | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1157
- | ​ ↳ `description` | `string` | ✅ | — | Workflow description (null if unset) |
1158
- | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1159
- | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers. Always false on a new workflow until enabled. |
1160
- | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1161
- | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1162
- | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1152
+ | Name | Type | Required | Possible Values | Description |
1153
+ | ------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1154
+ | `data` | `object` | ✅ | — | |
1155
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1156
+ | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1157
+ | ​ ↳ `description` | `string` | ✅ | — | Workflow description (null if unset) |
1158
+ | ​ ↳ `trigger_url` | `string` | ✅ | — | Public URL that fires this workflow when POSTed to. Embeds a trigger token in the path — treat as sensitive. Requests must also be authenticated as the account. |
1159
+ | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers. Always false on a new workflow until enabled. |
1160
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1161
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1162
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1163
1163
 
1164
1164
  **Example:**
1165
1165
 
@@ -1336,7 +1336,7 @@ Get a durable workflow with its current version details and trigger claim status
1336
1336
  | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1337
1337
  | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1338
1338
  | ​ ↳ `description` | `string` | ✅ | — | Optional workflow description (null if unset) |
1339
- | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1339
+ | ​ ↳ `trigger_url` | `string` | ✅ | — | Public URL that fires this workflow when POSTed to. Embeds a trigger token in the path — treat as sensitive. Requests must also be authenticated as the account. |
1340
1340
  | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1341
1341
  | ​ ↳ `disabled_reason` | `string` | ❌ | `trigger_claim_failed` | Why the workflow is off, when system-disabled. Null when not system-disabled. Independent of per-trigger claim status: an enabled workflow can still have a failed trigger. |
1342
1342
  | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
@@ -1359,6 +1359,7 @@ Get a durable workflow with its current version details and trigger claim status
1359
1359
  | ​   ↳ `params` | `object` | ❌ | — | Trigger parameters as a JSON object |
1360
1360
  | ​   ↳ `status` | `string` | ✅ | `unclaimed`, `pending`, `active`, `releasing`, `released`, `failed` | Live trigger claim status — whether the trigger is currently subscribed to its source. |
1361
1361
  | ​   ↳ `error` | `string` | ❌ | — | Failure reason for the latest claim. Present (non-null) only when status is 'failed'. |
1362
+ | ​   ↳ `details` | `object` | ❌ | — | Trigger-type-specific metadata; shape varies by trigger type (e.g. `webhook_url` on catch-hook triggers). Null or absent when none applies. |
1362
1363
  | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1363
1364
  | ​ ↳ `updated_at` | `string` | ✅ | — | When the workflow was last modified (ISO-8601) |
1364
1365
 
@@ -1615,28 +1616,29 @@ List all active durable workflows for the authenticated account
1615
1616
 
1616
1617
  **Returns:** `Promise<PaginatedResult<WorkflowItem>>`
1617
1618
 
1618
- | Name | Type | Required | Possible Values | Description |
1619
- | ------------------------- | ---------- | -------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
1620
- | `data[]` | `object[]` | ✅ | — | |
1621
- | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1622
- | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1623
- | ​ ↳ `description` | `string` | ✅ | — | Optional workflow description (null if unset) |
1624
- | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1625
- | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1626
- | ​ ↳ `disabled_reason` | `string` | ❌ | `trigger_claim_failed` | Why the workflow is off, when system-disabled. Null when not system-disabled. |
1627
- | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1628
- | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1629
- | ​ ↳ `current_version_id` | `string` | ✅ | — | ID of the workflow version that runs handle. Null until a version is published. |
1630
- | ​ ↳ `triggers[]` | `object[]` | ✅ | — | Trigger configurations from the current version, with live claim status. Empty array when the workflow has no triggers. |
1631
- | ​   ↳ `selected_api` | `string` | ✅ | — | Zapier app/API identifier (e.g. 'GoogleSheetsAPI') |
1632
- | ​   ↳ `action` | `string` | ✅ | — | Trigger action key (e.g. 'new_row') |
1633
- | ​   ↳ `authentication_id` | `string` | ❌ | — | Connection ID for the trigger source. Null for no-auth triggers. |
1634
- | ​   ↳ `params` | `object` | ❌ | — | Trigger parameters as a JSON object |
1635
- | ​   ↳ `status` | `string` | ✅ | `unclaimed`, `pending`, `active`, `releasing`, `released`, `failed` | Live trigger claim status — whether the trigger is currently subscribed to its source. |
1636
- | ​   ↳ `error` | `string` | ❌ | — | Failure reason for the latest claim. Present (non-null) only when status is 'failed'. |
1637
- | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1638
- | ​ ↳ `updated_at` | `string` | ✅ | — | When the workflow was last modified (ISO-8601) |
1639
- | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1619
+ | Name | Type | Required | Possible Values | Description |
1620
+ | ------------------------- | ---------- | -------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1621
+ | `data[]` | `object[]` | ✅ | — | |
1622
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1623
+ | ​ ↳ `name` | `string` | ✅ | — | Workflow name |
1624
+ | ​ ↳ `description` | `string` | ✅ | — | Optional workflow description (null if unset) |
1625
+ | ​ ↳ `trigger_url` | `string` | ✅ | — | Public URL that fires this workflow when POSTed to. Embeds a trigger token in the path — treat as sensitive. Requests must also be authenticated as the account. |
1626
+ | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1627
+ | ​ ↳ `disabled_reason` | `string` | ❌ | `trigger_claim_failed` | Why the workflow is off, when system-disabled. Null when not system-disabled. |
1628
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1629
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1630
+ | ​ ↳ `current_version_id` | `string` | ✅ | — | ID of the workflow version that runs handle. Null until a version is published. |
1631
+ | ​ ↳ `triggers[]` | `object[]` | ✅ | — | Trigger configurations from the current version, with live claim status. Empty array when the workflow has no triggers. |
1632
+ | ​   ↳ `selected_api` | `string` | ✅ | — | Zapier app/API identifier (e.g. 'GoogleSheetsAPI') |
1633
+ | ​   ↳ `action` | `string` | ✅ | — | Trigger action key (e.g. 'new_row') |
1634
+ | ​   ↳ `authentication_id` | `string` | ❌ | — | Connection ID for the trigger source. Null for no-auth triggers. |
1635
+ | ​   ↳ `params` | `object` | ❌ | — | Trigger parameters as a JSON object |
1636
+ | ​   ↳ `status` | `string` | ✅ | `unclaimed`, `pending`, `active`, `releasing`, `released`, `failed` | Live trigger claim status — whether the trigger is currently subscribed to its source. |
1637
+ | ​   ↳ `error` | `string` | ❌ | — | Failure reason for the latest claim. Present (non-null) only when status is 'failed'. |
1638
+ | ​   ↳ `details` | `object` | ❌ | — | Trigger-type-specific metadata; shape varies by trigger type (e.g. `webhook_url` on catch-hook triggers). Null or absent when none applies. |
1639
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1640
+ | ​ ↳ `updated_at` | `string` | ✅ | — | When the workflow was last modified (ISO-8601) |
1641
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1640
1642
 
1641
1643
  **Example:**
1642
1644
 
@@ -1786,18 +1788,18 @@ Update a durable workflow's name and/or description
1786
1788
 
1787
1789
  **Returns:** `Promise<WorkflowItem>`
1788
1790
 
1789
- | Name | Type | Required | Possible Values | Description |
1790
- | ------------------------ | --------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------- |
1791
- | `data` | `object` | ✅ | — | |
1792
- | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1793
- | ​ ↳ `name` | `string` | ✅ | — | Workflow name (post-update) |
1794
- | ​ ↳ `description` | `string` | ✅ | — | Workflow description, post-update (null if unset) |
1795
- | ​ ↳ `trigger_url` | `string` | ✅ | — | Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path — treat as sensitive. |
1796
- | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1797
- | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1798
- | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1799
- | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1800
- | ​ ↳ `updated_at` | `string` | ✅ | — | When this update was applied (ISO-8601) |
1791
+ | Name | Type | Required | Possible Values | Description |
1792
+ | ------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1793
+ | `data` | `object` | ✅ | — | |
1794
+ | ​ ↳ `id` | `string` | ✅ | — | Workflow ID (UUID) |
1795
+ | ​ ↳ `name` | `string` | ✅ | — | Workflow name (post-update) |
1796
+ | ​ ↳ `description` | `string` | ✅ | — | Workflow description, post-update (null if unset) |
1797
+ | ​ ↳ `trigger_url` | `string` | ✅ | — | Public URL that fires this workflow when POSTed to. Embeds a trigger token in the path — treat as sensitive. Requests must also be authenticated as the account. |
1798
+ | ​ ↳ `enabled` | `boolean` | ✅ | — | Whether the workflow currently accepts triggers |
1799
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the workflow is private to the creating user. False means account-visible. |
1800
+ | ​ ↳ `created_by_user_id` | `string` | ✅ | — | User ID of the workflow creator (null in legacy data) |
1801
+ | ​ ↳ `created_at` | `string` | ✅ | — | When the workflow was created (ISO-8601) |
1802
+ | ​ ↳ `updated_at` | `string` | ✅ | — | When this update was applied (ISO-8601) |
1801
1803
 
1802
1804
  **Example:**
1803
1805
 
package/dist/experimental.cjs CHANGED
@@ -5194,7 +5194,7 @@ function parseDeprecationDate(value) {
5194
5194
  }
5195
5195
 
5196
5196
  // src/sdk-version.ts
5197
- var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.0" : void 0) || "unknown";
5197
+ var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.1" : void 0) || "unknown";
5198
5198
 
5199
5199
  // src/utils/open-url.ts
5200
5200
  var nodePrefix = "node:";
@@ -14718,6 +14718,9 @@ function toWireAppVersions(appVersions) {
14718
14718
  }
14719
14719
  return wire;
14720
14720
  }
14721
+ var WorkflowTriggerUrlSchema = zod.z.string().describe(
14722
+ "Public URL that fires this workflow when POSTed to. Embeds a trigger token in the path \u2014 treat as sensitive. Requests must also be authenticated as the account."
14723
+ );
14721
14724
  var ConnectionBindingSchema2 = zod.z.object({
14722
14725
  connection_id: zod.z.union([
14723
14726
  zod.z.number().int().positive(),
@@ -14750,6 +14753,11 @@ var WorkflowTriggerStatusSchema = zod.z.enum([
14750
14753
  "failed"
14751
14754
  ]);
14752
14755
  var WorkflowDisabledReasonSchema = zod.z.enum(["trigger_claim_failed"]);
14756
+ var WorkflowTriggerDetailsSchema = zod.z.object({
14757
+ webhook_url: zod.z.string().optional().describe(
14758
+ "Public catch URL for this trigger. Present on catch-hook triggers (e.g. Webhooks by Zapier)."
14759
+ )
14760
+ }).describe("Trigger-type-specific metadata. Shape varies by trigger type.");
14753
14761
  var WorkflowTriggerSchema = zod.z.object({
14754
14762
  selected_api: zod.z.string().describe("Zapier app/API identifier (e.g. 'GoogleSheetsAPI')"),
14755
14763
  action: zod.z.string().describe("Trigger action key (e.g. 'new_row')"),
@@ -14765,6 +14773,11 @@ var WorkflowTriggerSchema = zod.z.object({
14765
14773
  // time — surface verbatim.
14766
14774
  error: zod.z.string().nullable().optional().describe(
14767
14775
  "Failure reason for the latest claim. Present (non-null) only when status is 'failed'."
14776
+ ),
14777
+ // webhook_url is named in this prose because the generated README doesn't
14778
+ // expand fields nested this deep.
14779
+ details: WorkflowTriggerDetailsSchema.nullable().optional().describe(
14780
+ "Trigger-type-specific metadata; shape varies by trigger type (e.g. `webhook_url` on catch-hook triggers). Null or absent when none applies."
14768
14781
  )
14769
14782
  }).describe(
14770
14783
  "Trigger from a workflow's current version, combined with the live claim status."
@@ -14775,9 +14788,7 @@ var WorkflowItemSchema = zod.z.object({
14775
14788
  id: zod.z.string().describe("Workflow ID (UUID)"),
14776
14789
  name: zod.z.string().describe("Workflow name"),
14777
14790
  description: zod.z.string().nullable().describe("Optional workflow description (null if unset)"),
14778
- trigger_url: zod.z.string().describe(
14779
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14780
- ),
14791
+ trigger_url: WorkflowTriggerUrlSchema,
14781
14792
  enabled: zod.z.boolean().describe("Whether the workflow currently accepts triggers"),
14782
14793
  // Optional until COSUB-630 ships the field server-side; afterwards the API
14783
14794
  // always sends it (null unless the workflow was system-disabled).
@@ -14873,9 +14884,7 @@ var GetWorkflowResponseSchema = zod.z.object({
14873
14884
  id: zod.z.string().describe("Workflow ID (UUID)"),
14874
14885
  name: zod.z.string().describe("Workflow name"),
14875
14886
  description: zod.z.string().nullable().describe("Optional workflow description (null if unset)"),
14876
- trigger_url: zod.z.string().describe(
14877
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14878
- ),
14887
+ trigger_url: WorkflowTriggerUrlSchema,
14879
14888
  enabled: zod.z.boolean().describe("Whether the workflow currently accepts triggers"),
14880
14889
  // Optional until COSUB-630 ships the field server-side; afterwards the API
14881
14890
  // always sends it (null unless the workflow was system-disabled). Kept
@@ -14936,9 +14945,7 @@ var CreateWorkflowResponseSchema = zod.z.object({
14936
14945
  id: zod.z.string().describe("Workflow ID (UUID)"),
14937
14946
  name: zod.z.string().describe("Workflow name"),
14938
14947
  description: zod.z.string().nullable().describe("Workflow description (null if unset)"),
14939
- trigger_url: zod.z.string().describe(
14940
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14941
- ),
14948
+ trigger_url: WorkflowTriggerUrlSchema,
14942
14949
  enabled: zod.z.boolean().describe(
14943
14950
  "Whether the workflow currently accepts triggers. Always false on a new workflow until enabled."
14944
14951
  ),
@@ -14986,9 +14993,7 @@ var UpdateWorkflowResponseSchema = zod.z.object({
14986
14993
  id: zod.z.string().describe("Workflow ID (UUID)"),
14987
14994
  name: zod.z.string().describe("Workflow name (post-update)"),
14988
14995
  description: zod.z.string().nullable().describe("Workflow description, post-update (null if unset)"),
14989
- trigger_url: zod.z.string().describe(
14990
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14991
- ),
14996
+ trigger_url: WorkflowTriggerUrlSchema,
14992
14997
  enabled: zod.z.boolean().describe("Whether the workflow currently accepts triggers"),
14993
14998
  is_private: zod.z.boolean().describe(
14994
14999
  "Whether the workflow is private to the creating user. False means account-visible."
package/dist/experimental.d.mts CHANGED
@@ -2760,6 +2760,9 @@ declare const zapierExperimentalSdkPlugin: AggregatePlugin<"experimental-sdk", {
2760
2760
  authentication_id?: string | null | undefined;
2761
2761
  params?: Record<string, unknown> | undefined;
2762
2762
  error?: string | null | undefined;
2763
+ details?: {
2764
+ webhook_url?: string | undefined;
2765
+ } | null | undefined;
2763
2766
  }[];
2764
2767
  created_at: string;
2765
2768
  updated_at: string;
@@ -2784,6 +2787,9 @@ declare const zapierExperimentalSdkPlugin: AggregatePlugin<"experimental-sdk", {
2784
2787
  authentication_id?: string | null | undefined;
2785
2788
  params?: Record<string, unknown> | undefined;
2786
2789
  error?: string | null | undefined;
2790
+ details?: {
2791
+ webhook_url?: string | undefined;
2792
+ } | null | undefined;
2787
2793
  }[];
2788
2794
  created_at: string;
2789
2795
  updated_at: string;
@@ -4692,6 +4698,9 @@ declare function createZapierSdk(options?: ZapierSdkOptions): {
4692
4698
  authentication_id?: string | null | undefined;
4693
4699
  params?: Record<string, unknown> | undefined;
4694
4700
  error?: string | null | undefined;
4701
+ details?: {
4702
+ webhook_url?: string | undefined;
4703
+ } | null | undefined;
4695
4704
  }[];
4696
4705
  created_at: string;
4697
4706
  updated_at: string;
@@ -4715,6 +4724,9 @@ declare function createZapierSdk(options?: ZapierSdkOptions): {
4715
4724
  authentication_id?: string | null | undefined;
4716
4725
  params?: Record<string, unknown> | undefined;
4717
4726
  error?: string | null | undefined;
4727
+ details?: {
4728
+ webhook_url?: string | undefined;
4729
+ } | null | undefined;
4718
4730
  }[];
4719
4731
  created_at: string;
4720
4732
  updated_at: string;
package/dist/experimental.d.ts CHANGED
@@ -2760,6 +2760,9 @@ declare const zapierExperimentalSdkPlugin: AggregatePlugin<"experimental-sdk", {
2760
2760
  authentication_id?: string | null | undefined;
2761
2761
  params?: Record<string, unknown> | undefined;
2762
2762
  error?: string | null | undefined;
2763
+ details?: {
2764
+ webhook_url?: string | undefined;
2765
+ } | null | undefined;
2763
2766
  }[];
2764
2767
  created_at: string;
2765
2768
  updated_at: string;
@@ -2784,6 +2787,9 @@ declare const zapierExperimentalSdkPlugin: AggregatePlugin<"experimental-sdk", {
2784
2787
  authentication_id?: string | null | undefined;
2785
2788
  params?: Record<string, unknown> | undefined;
2786
2789
  error?: string | null | undefined;
2790
+ details?: {
2791
+ webhook_url?: string | undefined;
2792
+ } | null | undefined;
2787
2793
  }[];
2788
2794
  created_at: string;
2789
2795
  updated_at: string;
@@ -4692,6 +4698,9 @@ declare function createZapierSdk(options?: ZapierSdkOptions): {
4692
4698
  authentication_id?: string | null | undefined;
4693
4699
  params?: Record<string, unknown> | undefined;
4694
4700
  error?: string | null | undefined;
4701
+ details?: {
4702
+ webhook_url?: string | undefined;
4703
+ } | null | undefined;
4695
4704
  }[];
4696
4705
  created_at: string;
4697
4706
  updated_at: string;
@@ -4715,6 +4724,9 @@ declare function createZapierSdk(options?: ZapierSdkOptions): {
4715
4724
  authentication_id?: string | null | undefined;
4716
4725
  params?: Record<string, unknown> | undefined;
4717
4726
  error?: string | null | undefined;
4727
+ details?: {
4728
+ webhook_url?: string | undefined;
4729
+ } | null | undefined;
4718
4730
  }[];
4719
4731
  created_at: string;
4720
4732
  updated_at: string;
package/dist/experimental.mjs CHANGED
@@ -5192,7 +5192,7 @@ function parseDeprecationDate(value) {
5192
5192
  }
5193
5193
 
5194
5194
  // src/sdk-version.ts
5195
- var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.0" : void 0) || "unknown";
5195
+ var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.1" : void 0) || "unknown";
5196
5196
 
5197
5197
  // src/utils/open-url.ts
5198
5198
  var nodePrefix = "node:";
@@ -14716,6 +14716,9 @@ function toWireAppVersions(appVersions) {
14716
14716
  }
14717
14717
  return wire;
14718
14718
  }
14719
+ var WorkflowTriggerUrlSchema = z.string().describe(
14720
+ "Public URL that fires this workflow when POSTed to. Embeds a trigger token in the path \u2014 treat as sensitive. Requests must also be authenticated as the account."
14721
+ );
14719
14722
  var ConnectionBindingSchema2 = z.object({
14720
14723
  connection_id: z.union([
14721
14724
  z.number().int().positive(),
@@ -14748,6 +14751,11 @@ var WorkflowTriggerStatusSchema = z.enum([
14748
14751
  "failed"
14749
14752
  ]);
14750
14753
  var WorkflowDisabledReasonSchema = z.enum(["trigger_claim_failed"]);
14754
+ var WorkflowTriggerDetailsSchema = z.object({
14755
+ webhook_url: z.string().optional().describe(
14756
+ "Public catch URL for this trigger. Present on catch-hook triggers (e.g. Webhooks by Zapier)."
14757
+ )
14758
+ }).describe("Trigger-type-specific metadata. Shape varies by trigger type.");
14751
14759
  var WorkflowTriggerSchema = z.object({
14752
14760
  selected_api: z.string().describe("Zapier app/API identifier (e.g. 'GoogleSheetsAPI')"),
14753
14761
  action: z.string().describe("Trigger action key (e.g. 'new_row')"),
@@ -14763,6 +14771,11 @@ var WorkflowTriggerSchema = z.object({
14763
14771
  // time — surface verbatim.
14764
14772
  error: z.string().nullable().optional().describe(
14765
14773
  "Failure reason for the latest claim. Present (non-null) only when status is 'failed'."
14774
+ ),
14775
+ // webhook_url is named in this prose because the generated README doesn't
14776
+ // expand fields nested this deep.
14777
+ details: WorkflowTriggerDetailsSchema.nullable().optional().describe(
14778
+ "Trigger-type-specific metadata; shape varies by trigger type (e.g. `webhook_url` on catch-hook triggers). Null or absent when none applies."
14766
14779
  )
14767
14780
  }).describe(
14768
14781
  "Trigger from a workflow's current version, combined with the live claim status."
@@ -14773,9 +14786,7 @@ var WorkflowItemSchema = z.object({
14773
14786
  id: z.string().describe("Workflow ID (UUID)"),
14774
14787
  name: z.string().describe("Workflow name"),
14775
14788
  description: z.string().nullable().describe("Optional workflow description (null if unset)"),
14776
- trigger_url: z.string().describe(
14777
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14778
- ),
14789
+ trigger_url: WorkflowTriggerUrlSchema,
14779
14790
  enabled: z.boolean().describe("Whether the workflow currently accepts triggers"),
14780
14791
  // Optional until COSUB-630 ships the field server-side; afterwards the API
14781
14792
  // always sends it (null unless the workflow was system-disabled).
@@ -14871,9 +14882,7 @@ var GetWorkflowResponseSchema = z.object({
14871
14882
  id: z.string().describe("Workflow ID (UUID)"),
14872
14883
  name: z.string().describe("Workflow name"),
14873
14884
  description: z.string().nullable().describe("Optional workflow description (null if unset)"),
14874
- trigger_url: z.string().describe(
14875
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14876
- ),
14885
+ trigger_url: WorkflowTriggerUrlSchema,
14877
14886
  enabled: z.boolean().describe("Whether the workflow currently accepts triggers"),
14878
14887
  // Optional until COSUB-630 ships the field server-side; afterwards the API
14879
14888
  // always sends it (null unless the workflow was system-disabled). Kept
@@ -14934,9 +14943,7 @@ var CreateWorkflowResponseSchema = z.object({
14934
14943
  id: z.string().describe("Workflow ID (UUID)"),
14935
14944
  name: z.string().describe("Workflow name"),
14936
14945
  description: z.string().nullable().describe("Workflow description (null if unset)"),
14937
- trigger_url: z.string().describe(
14938
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14939
- ),
14946
+ trigger_url: WorkflowTriggerUrlSchema,
14940
14947
  enabled: z.boolean().describe(
14941
14948
  "Whether the workflow currently accepts triggers. Always false on a new workflow until enabled."
14942
14949
  ),
@@ -14984,9 +14991,7 @@ var UpdateWorkflowResponseSchema = z.object({
14984
14991
  id: z.string().describe("Workflow ID (UUID)"),
14985
14992
  name: z.string().describe("Workflow name (post-update)"),
14986
14993
  description: z.string().nullable().describe("Workflow description, post-update (null if unset)"),
14987
- trigger_url: z.string().describe(
14988
- "Public webhook URL that fires this workflow when POSTed to. Embeds a secret trigger token in the path \u2014 treat as sensitive."
14989
- ),
14994
+ trigger_url: WorkflowTriggerUrlSchema,
14990
14995
  enabled: z.boolean().describe("Whether the workflow currently accepts triggers"),
14991
14996
  is_private: z.boolean().describe(
14992
14997
  "Whether the workflow is private to the creating user. False means account-visible."
package/dist/index.cjs CHANGED
@@ -5340,7 +5340,7 @@ function parseDeprecationDate(value) {
5340
5340
  }
5341
5341
 
5342
5342
  // src/sdk-version.ts
5343
- var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.0" : void 0) || "unknown";
5343
+ var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.1" : void 0) || "unknown";
5344
5344
 
5345
5345
  // src/utils/open-url.ts
5346
5346
  var nodePrefix = "node:";
package/dist/index.mjs CHANGED
@@ -5338,7 +5338,7 @@ function parseDeprecationDate(value) {
5338
5338
  }
5339
5339
 
5340
5340
  // src/sdk-version.ts
5341
- var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.0" : void 0) || "unknown";
5341
+ var SDK_VERSION = (typeof process !== "undefined" && process.env ? "0.83.1" : void 0) || "unknown";
5342
5342
 
5343
5343
  // src/utils/open-url.ts
5344
5344
  var nodePrefix = "node:";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zapier/zapier-sdk",
3
- "version": "0.83.0",
3
+ "version": "0.83.1",
4
4
  "description": "Complete Zapier SDK - combines all Zapier SDK packages",
5
5
  "main": "dist/index.cjs",
6
6
  "module": "dist/index.mjs",