@zapier/zapier-sdk 0.80.2 → 0.81.0

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 (13) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +80 -72
  3. package/dist/experimental.cjs +53 -27
  4. package/dist/experimental.d.mts +48 -2
  5. package/dist/experimental.d.ts +48 -2
  6. package/dist/experimental.mjs +53 -28
  7. package/dist/{index-DEQqvs2r.d.mts → index-CbfvBdSp.d.mts} +10 -1
  8. package/dist/{index-DEQqvs2r.d.ts → index-CbfvBdSp.d.ts} +10 -1
  9. package/dist/index.cjs +7 -3
  10. package/dist/index.d.mts +1 -1
  11. package/dist/index.d.ts +1 -1
  12. package/dist/index.mjs +7 -4
  13. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # @zapier/zapier-sdk
2
2
 
3
+ ## 0.81.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 8d232d2: Deprecated `name` in favor of `key` for trigger inboxes. `name` continues to work as a deprecated alias.
8
+ - `createTriggerInbox` now accepts an optional `key` parameter; `name` is deprecated.
9
+ - `ensureTriggerInbox` now takes `key` as its required idempotency identifier; passing `name` still works but is deprecated.
10
+ - `listTriggerInboxes` now accepts a `key` filter; the `name` filter is deprecated.
11
+ - Trigger inbox locators (the `inbox` argument on `getTriggerInbox`, `updateTriggerInbox`, and related methods) now resolve non-UUID values by `key`.
12
+ - Trigger inbox responses now include a `key` field alongside `name` (both hold the same value; `key` may be `null` when an inbox has no natural key).
13
+
3
14
  ## 0.80.2
4
15
 
5
16
  ### Patch Changes
package/README.md CHANGED
@@ -2651,12 +2651,12 @@ Acknowledge messages from a lease. Acked messages are removed from the inbox; un
2651
2651
 
2652
2652
  **Parameters:**
2653
2653
 
2654
- | Name | Type | Required | Default | Possible Values | Description |
2655
- | -------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
2656
- | `options` | `object` | ✅ | — | — | |
2657
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
2658
- | ​ ↳ `lease` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
2659
- | ​ ↳ `messages` | `array` | ❌ | — | — | Specific message IDs to ack. Omit to ack every message in the lease. |
2654
+ | Name | Type | Required | Default | Possible Values | Description |
2655
+ | -------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
2656
+ | `options` | `object` | ✅ | — | — | |
2657
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
2658
+ | ​ ↳ `lease` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
2659
+ | ​ ↳ `messages` | `array` | ❌ | — | — | Specific message IDs to ack. Omit to ack every message in the lease. |
2660
2660
 
2661
2661
  **Returns:** `Promise<TriggerInboxAckItem>`
2662
2662
 
@@ -2684,19 +2684,19 @@ const result = await zapier.ackTriggerInboxMessages({
2684
2684
 
2685
2685
  #### `createTriggerInbox` 🧪 _experimental_
2686
2686
 
2687
- Create a new trigger inbox subscription. Always creates a new inbox; use ensureTriggerInbox for get-or-create on a stable name.
2687
+ Create a new trigger inbox subscription. Always creates a new inbox; use ensureTriggerInbox for get-or-create on a stable key.
2688
2688
 
2689
2689
  **Parameters:**
2690
2690
 
2691
- | Name | Type | Required | Default | Possible Values | Description |
2692
- | --------------------- | ---------------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
2693
- | `options` | `object` | ✅ | — | — | |
2694
- | ​ ↳ `name` | `string` | ❌ | — | — | Optional inbox name. Auto-generated when omitted. Throws a conflict error if the name is already in use by another subscription. |
2695
- | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
2696
- | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
2697
- | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
2698
- | ​ ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
2699
- | ​ ↳ `notificationUrl` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
2691
+ | Name | Type | Required | Default | Possible Values | Description |
2692
+ | --------------------- | ---------------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
2693
+ | `options` | `object` | ✅ | — | — | |
2694
+ | ​ ↳ `key` | `string` | ❌ | — | — | Optional inbox key. Auto-generated when omitted. Throws a conflict error if the key is already in use by another subscription. |
2695
+ | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
2696
+ | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
2697
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
2698
+ | ​ ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
2699
+ | ​ ↳ `notificationUrl` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
2700
2700
 
2701
2701
  **Returns:** `Promise<TriggerInboxItem>`
2702
2702
 
@@ -2705,6 +2705,7 @@ Create a new trigger inbox subscription. Always creates a new inbox; use ensureT
2705
2705
  | `data` | `object` | ✅ | — | |
2706
2706
  | ​ ↳ `id` | `string` | ✅ | — | |
2707
2707
  | ​ ↳ `created_at` | `string` | ✅ | — | |
2708
+ | ​ ↳ `key` | `string` | ✅ | — | |
2708
2709
  | ​ ↳ `name` | `string` | ✅ | — | |
2709
2710
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
2710
2711
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -2730,10 +2731,10 @@ Mark a trigger inbox for deletion
2730
2731
 
2731
2732
  **Parameters:**
2732
2733
 
2733
- | Name | Type | Required | Default | Possible Values | Description |
2734
- | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
2735
- | `options` | `object` | ✅ | — | — | |
2736
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
2734
+ | Name | Type | Required | Default | Possible Values | Description |
2735
+ | ----------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
2736
+ | `options` | `object` | ✅ | — | — | |
2737
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
2737
2738
 
2738
2739
  **Returns:** `Promise<{ success: boolean }>`
2739
2740
 
@@ -2742,6 +2743,7 @@ Mark a trigger inbox for deletion
2742
2743
  | `data` | `object` | ✅ | — | |
2743
2744
  | ​ ↳ `id` | `string` | ✅ | — | |
2744
2745
  | ​ ↳ `created_at` | `string` | ✅ | — | |
2746
+ | ​ ↳ `key` | `string` | ✅ | — | |
2745
2747
  | ​ ↳ `name` | `string` | ✅ | — | |
2746
2748
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
2747
2749
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -2769,7 +2771,7 @@ Drain an existing trigger inbox: lease currently-available messages, process eac
2769
2771
  | Name | Type | Required | Default | Possible Values | Description |
2770
2772
  | --------------------- | ---------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2771
2773
  | `options` | `object` | ✅ | — | — | |
2772
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
2774
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
2773
2775
  | ​ ↳ `onMessage` | `function` | ❌ | — | — | Per-message handler. Resolves to ack; rejects to release-or-leave per `releaseOnError`. Throw `ZapierReleaseTriggerMessageSignal` to release explicitly, or `ZapierAbortDrainSignal` to stop after the current batch. |
2774
2776
  | ​ ↳ `concurrency` | `number` | ❌ | — | — | Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set. |
2775
2777
  | ​ ↳ `leaseLimit` | `number` | ❌ | — | — | Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set. |
@@ -2795,19 +2797,19 @@ const result = await zapier.drainTriggerInbox({
2795
2797
 
2796
2798
  #### `ensureTriggerInbox` 🧪 _experimental_
2797
2799
 
2798
- Get-or-create a trigger inbox by name. Idempotent on (user, account, name): returns the existing inbox if a matching subscription is registered, creates a new one otherwise. Throws ZapierConflictError if the name exists with a different subscription.
2800
+ Get-or-create a trigger inbox by key. Idempotent on (user, account, key): returns the existing inbox if a matching subscription is registered, creates a new one otherwise. Throws ZapierConflictError if the key exists with a different subscription.
2799
2801
 
2800
2802
  **Parameters:**
2801
2803
 
2802
- | Name | Type | Required | Default | Possible Values | Description |
2803
- | --------------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2804
- | `options` | `object` | ✅ | — | — | |
2805
- | ​ ↳ `name` | `string` | ✅ | — | — | Inbox name; serves as the idempotency key. Required for ensureTriggerInbox — without one, the API mints a fresh inbox each call (use createTriggerInbox for that path). |
2806
- | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
2807
- | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
2808
- | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
2809
- | ​ ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
2810
- | ​ ↳ `notificationUrl` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
2804
+ | Name | Type | Required | Default | Possible Values | Description |
2805
+ | --------------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2806
+ | `options` | `object` | ✅ | — | — | |
2807
+ | ​ ↳ `key` | `string` | ✅ | — | — | Inbox key; serves as the idempotency key. Required for ensureTriggerInbox — without one, the API mints a fresh inbox each call (use createTriggerInbox for that path). |
2808
+ | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
2809
+ | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
2810
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
2811
+ | ​ ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
2812
+ | ​ ↳ `notificationUrl` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
2811
2813
 
2812
2814
  **Returns:** `Promise<TriggerInboxItem>`
2813
2815
 
@@ -2816,6 +2818,7 @@ Get-or-create a trigger inbox by name. Idempotent on (user, account, name): retu
2816
2818
  | `data` | `object` | ✅ | — | |
2817
2819
  | ​ ↳ `id` | `string` | ✅ | — | |
2818
2820
  | ​ ↳ `created_at` | `string` | ✅ | — | |
2821
+ | ​ ↳ `key` | `string` | ✅ | — | |
2819
2822
  | ​ ↳ `name` | `string` | ✅ | — | |
2820
2823
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
2821
2824
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -2830,7 +2833,7 @@ Get-or-create a trigger inbox by name. Idempotent on (user, account, name): retu
2830
2833
 
2831
2834
  ```typescript
2832
2835
  const result = await zapier.ensureTriggerInbox({
2833
- name: "example-name",
2836
+ key: "example-key",
2834
2837
  app: "example-app",
2835
2838
  action: "example-action",
2836
2839
  });
@@ -2842,10 +2845,10 @@ Get details of a trigger inbox by ID
2842
2845
 
2843
2846
  **Parameters:**
2844
2847
 
2845
- | Name | Type | Required | Default | Possible Values | Description |
2846
- | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
2847
- | `options` | `object` | ✅ | — | — | |
2848
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
2848
+ | Name | Type | Required | Default | Possible Values | Description |
2849
+ | ----------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
2850
+ | `options` | `object` | ✅ | — | — | |
2851
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
2849
2852
 
2850
2853
  **Returns:** `Promise<TriggerInboxItem>`
2851
2854
 
@@ -2854,6 +2857,7 @@ Get details of a trigger inbox by ID
2854
2857
  | `data` | `object` | ✅ | — | |
2855
2858
  | ​ ↳ `id` | `string` | ✅ | — | |
2856
2859
  | ​ ↳ `created_at` | `string` | ✅ | — | |
2860
+ | ​ ↳ `key` | `string` | ✅ | — | |
2857
2861
  | ​ ↳ `name` | `string` | ✅ | — | |
2858
2862
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
2859
2863
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -2906,7 +2910,7 @@ Lease up to N messages from a trigger inbox. Returns messages plus a lease ID; a
2906
2910
  | Name | Type | Required | Default | Possible Values | Description |
2907
2911
  | ------------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------ |
2908
2912
  | `options` | `object` | ✅ | — | — | |
2909
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
2913
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
2910
2914
  | ​ ↳ `leaseLimit` | `number` | ❌ | — | — | Maximum messages to lease in a single batch (1-100) |
2911
2915
  | ​ ↳ `leaseSeconds` | `number` | ❌ | — | — | Seconds until the lease expires; messages return to available if not acked. API default is 300 (5 minutes). |
2912
2916
  | ​ ↳ `signal` | `any` | ❌ | — | — | Abort signal forwarded to the lease HTTP request. Aborting causes the in-flight request to reject with AbortError. |
@@ -2945,13 +2949,13 @@ List messages in a trigger inbox (no payload, status-only)
2945
2949
 
2946
2950
  **Parameters:**
2947
2951
 
2948
- | Name | Type | Required | Default | Possible Values | Description |
2949
- | -------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
2950
- | `options` | `object` | ✅ | — | — | |
2951
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
2952
- | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of messages per page |
2953
- | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
2954
- | ​ ↳ `cursor` | `string` | ❌ | — | — | Pagination cursor |
2952
+ | Name | Type | Required | Default | Possible Values | Description |
2953
+ | -------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
2954
+ | `options` | `object` | ✅ | — | — | |
2955
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
2956
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of messages per page |
2957
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
2958
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Pagination cursor |
2955
2959
 
2956
2960
  **Returns:** `Promise<PaginatedResult<TriggerMessageItem>>`
2957
2961
 
@@ -2999,14 +3003,14 @@ List all trigger inboxes for the authenticated user
2999
3003
 
3000
3004
  **Parameters:**
3001
3005
 
3002
- | Name | Type | Required | Default | Possible Values | Description |
3003
- | -------------- | -------- | -------- | ------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
3004
- | `options` | `object` | ✅ | — | — | |
3005
- | ​ ↳ `name` | `string` | ❌ | — | — | Filter by inbox name (exact match). Names are unique per (user, account), so this returns at most one inbox. |
3006
- | ​ ↳ `status` | `string` | ❌ | — | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Filter by inbox status |
3007
- | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of inboxes per page |
3008
- | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
3009
- | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor (offset) to start from for pagination |
3006
+ | Name | Type | Required | Default | Possible Values | Description |
3007
+ | -------------- | -------- | -------- | ------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
3008
+ | `options` | `object` | ✅ | — | — | |
3009
+ | ​ ↳ `key` | `string` | ❌ | — | — | Filter by inbox key (exact match). Keys are unique per (user, account), so this returns at most one inbox. |
3010
+ | ​ ↳ `status` | `string` | ❌ | — | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Filter by inbox status |
3011
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of inboxes per page |
3012
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
3013
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor (offset) to start from for pagination |
3010
3014
 
3011
3015
  **Returns:** `Promise<PaginatedResult<TriggerInboxItem>>`
3012
3016
 
@@ -3015,6 +3019,7 @@ List all trigger inboxes for the authenticated user
3015
3019
  | `data[]` | `object[]` | ✅ | — | |
3016
3020
  | ​ ↳ `id` | `string` | ✅ | — | |
3017
3021
  | ​ ↳ `created_at` | `string` | ✅ | — | |
3022
+ | ​ ↳ `key` | `string` | ✅ | — | |
3018
3023
  | ​ ↳ `name` | `string` | ✅ | — | |
3019
3024
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
3020
3025
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -3255,10 +3260,10 @@ Pause a trigger inbox; events stop being collected
3255
3260
 
3256
3261
  **Parameters:**
3257
3262
 
3258
- | Name | Type | Required | Default | Possible Values | Description |
3259
- | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
3260
- | `options` | `object` | ✅ | — | — | |
3261
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
3263
+ | Name | Type | Required | Default | Possible Values | Description |
3264
+ | ----------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
3265
+ | `options` | `object` | ✅ | — | — | |
3266
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
3262
3267
 
3263
3268
  **Returns:** `Promise<TriggerInboxItem>`
3264
3269
 
@@ -3267,6 +3272,7 @@ Pause a trigger inbox; events stop being collected
3267
3272
  | `data` | `object` | ✅ | — | |
3268
3273
  | ​ ↳ `id` | `string` | ✅ | — | |
3269
3274
  | ​ ↳ `created_at` | `string` | ✅ | — | |
3275
+ | ​ ↳ `key` | `string` | ✅ | — | |
3270
3276
  | ​ ↳ `name` | `string` | ✅ | — | |
3271
3277
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
3272
3278
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -3291,12 +3297,12 @@ Release messages from a lease back to the inbox without acknowledging them. Rele
3291
3297
 
3292
3298
  **Parameters:**
3293
3299
 
3294
- | Name | Type | Required | Default | Possible Values | Description |
3295
- | -------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
3296
- | `options` | `object` | ✅ | — | — | |
3297
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
3298
- | ​ ↳ `lease` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
3299
- | ​ ↳ `messages` | `array` | ❌ | — | — | Specific message IDs to release. Omit to release every message in the lease. |
3300
+ | Name | Type | Required | Default | Possible Values | Description |
3301
+ | -------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
3302
+ | `options` | `object` | ✅ | — | — | |
3303
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
3304
+ | ​ ↳ `lease` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
3305
+ | ​ ↳ `messages` | `array` | ❌ | — | — | Specific message IDs to release. Omit to release every message in the lease. |
3300
3306
 
3301
3307
  **Returns:** `Promise<TriggerInboxReleaseItem>`
3302
3308
 
@@ -3328,10 +3334,10 @@ Resume a paused trigger inbox; events resume being collected
3328
3334
 
3329
3335
  **Parameters:**
3330
3336
 
3331
- | Name | Type | Required | Default | Possible Values | Description |
3332
- | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
3333
- | `options` | `object` | ✅ | — | — | |
3334
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
3337
+ | Name | Type | Required | Default | Possible Values | Description |
3338
+ | ----------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
3339
+ | `options` | `object` | ✅ | — | — | |
3340
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
3335
3341
 
3336
3342
  **Returns:** `Promise<TriggerInboxItem>`
3337
3343
 
@@ -3340,6 +3346,7 @@ Resume a paused trigger inbox; events resume being collected
3340
3346
  | `data` | `object` | ✅ | — | |
3341
3347
  | ​ ↳ `id` | `string` | ✅ | — | |
3342
3348
  | ​ ↳ `created_at` | `string` | ✅ | — | |
3349
+ | ​ ↳ `key` | `string` | ✅ | — | |
3343
3350
  | ​ ↳ `name` | `string` | ✅ | — | |
3344
3351
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
3345
3352
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -3364,11 +3371,11 @@ Update settings on an existing trigger inbox
3364
3371
 
3365
3372
  **Parameters:**
3366
3373
 
3367
- | Name | Type | Required | Default | Possible Values | Description |
3368
- | --------------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
3369
- | `options` | `object` | ✅ | — | — | |
3370
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
3371
- | ​ ↳ `notificationUrl` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive. Pass null to clear. |
3374
+ | Name | Type | Required | Default | Possible Values | Description |
3375
+ | --------------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
3376
+ | `options` | `object` | ✅ | — | — | |
3377
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
3378
+ | ​ ↳ `notificationUrl` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive. Pass null to clear. |
3372
3379
 
3373
3380
  **Returns:** `Promise<TriggerInboxItem>`
3374
3381
 
@@ -3377,6 +3384,7 @@ Update settings on an existing trigger inbox
3377
3384
  | `data` | `object` | ✅ | — | |
3378
3385
  | ​ ↳ `id` | `string` | ✅ | — | |
3379
3386
  | ​ ↳ `created_at` | `string` | ✅ | — | |
3387
+ | ​ ↳ `key` | `string` | ✅ | — | |
3380
3388
  | ​ ↳ `name` | `string` | ✅ | — | |
3381
3389
  | ​ ↳ `status` | `string` | ✅ | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Inbox lifecycle status |
3382
3390
  | ​ ↳ `paused_reason` | `string` | ✅ | `user`, `authentication`, `authentication_access_revoked`, `partner_revoked`, `subscribe_failed`, `migrate_failed`, `abandoned`, `unknown`, `upstream_failures` | Why the inbox was paused, if applicable |
@@ -3404,7 +3412,7 @@ Continuously consume a trigger inbox: drain currently-available messages via onM
3404
3412
  | Name | Type | Required | Default | Possible Values | Description |
3405
3413
  | ----------------------------- | ---------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
3406
3414
  | `options` | `object` | ✅ | — | — | |
3407
- | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
3415
+ | ​ ↳ `inbox` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
3408
3416
  | ​ ↳ `onMessage` | `function` | ❌ | — | — | Per-message handler. Resolves to ack; rejects to release-or-leave per `releaseOnError`. Throw `ZapierReleaseTriggerMessageSignal` to release explicitly, or `ZapierAbortDrainSignal` to stop after the current batch. |
3409
3417
  | ​ ↳ `concurrency` | `number` | ❌ | — | — | Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set. |
3410
3418
  | ​ ↳ `leaseLimit` | `number` | ❌ | — | — | Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set. |