@zapier/zapier-sdk-cli 0.61.3 → 0.63.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 (15) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/README.md +67 -65
  3. package/dist/cli.cjs +366 -50
  4. package/dist/cli.mjs +368 -52
  5. package/dist/experimental.cjs +357 -38
  6. package/dist/experimental.d.mts +1 -1
  7. package/dist/experimental.d.ts +1 -1
  8. package/dist/experimental.mjs +359 -40
  9. package/dist/{extensions-DggdwXJF.d.mts → extensions-N27h0wrp.d.mts} +1 -0
  10. package/dist/{extensions-DggdwXJF.d.ts → extensions-N27h0wrp.d.ts} +1 -0
  11. package/dist/index.cjs +361 -40
  12. package/dist/index.d.mts +5 -1
  13. package/dist/index.d.ts +5 -1
  14. package/dist/index.mjs +363 -42
  15. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,36 @@
1
1
  # @zapier/zapier-sdk-cli
2
2
 
3
+ ## 0.63.0
4
+
5
+ ### Minor Changes
6
+
7
+ - d96b5f6: Added `--callback-url` to `zapier-sdk login` and `zapier-sdk signup` for resuming pending non-interactive OAuth flows. Non-interactive login and signup now save pending state and exit immediately; run the same command later with `--callback-url <url>` to complete authentication from the browser callback URL.
8
+
9
+ Login and signup telemetry now includes `used_non_interactive_mode` and `is_headless` on CLI command and auth lifecycle events.
10
+
11
+ ### Patch Changes
12
+
13
+ - Updated dependencies [d96b5f6]
14
+ - @zapier/zapier-sdk@0.81.1
15
+ - @zapier/zapier-sdk-mcp@0.17.1
16
+
17
+ ## 0.62.0
18
+
19
+ ### Minor Changes
20
+
21
+ - 8d232d2: Deprecated `name` in favor of `key` for trigger inboxes. `name` continues to work as a deprecated alias.
22
+ - `createTriggerInbox` now accepts an optional `key` parameter; `name` is deprecated.
23
+ - `ensureTriggerInbox` now takes `key` as its required idempotency identifier; passing `name` still works but is deprecated.
24
+ - `listTriggerInboxes` now accepts a `key` filter; the `name` filter is deprecated.
25
+ - Trigger inbox locators (the `inbox` argument on `getTriggerInbox`, `updateTriggerInbox`, and related methods) now resolve non-UUID values by `key`.
26
+ - 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).
27
+
28
+ ### Patch Changes
29
+
30
+ - Updated dependencies [8d232d2]
31
+ - @zapier/zapier-sdk-mcp@0.17.0
32
+ - @zapier/zapier-sdk@0.81.0
33
+
3
34
  ## 0.61.3
4
35
 
5
36
  ### Patch Changes
package/README.md CHANGED
@@ -209,11 +209,12 @@ Log in to Zapier to access your account
209
209
  | `--use-approvals` | `boolean` | ❌ | — | — | Require approvals for actions performed with these credentials |
210
210
  | `--non-interactive` | `boolean` | ❌ | — | — | Skip interactive prompts. Uses defaults where possible; errors instead of prompting when input is required. Useful in CI, piped output, or environments where TTY detection is unreliable. |
211
211
  | `--headless` | `boolean` | ❌ | — | — | Use when logging in from a machine that has no browser. Prints a login link to open elsewhere, then accepts the pasted loopback callback URL. |
212
+ | `--callback-url` | `string` | ❌ | — | — | Resume a pending non-interactive login with the final OAuth callback URL from your browser. |
212
213
 
213
214
  **Usage:**
214
215
 
215
216
  ```bash
216
- npx zapier-sdk login [--name] [--timeout] [--use-approvals] [--non-interactive] [--headless]
217
+ npx zapier-sdk login [--name] [--timeout] [--use-approvals] [--non-interactive] [--headless] [--callback-url]
217
218
  ```
218
219
 
219
220
  #### `logout`
@@ -238,11 +239,12 @@ Set up Zapier account access and SDK credentials
238
239
  | `--use-approvals` | `boolean` | ❌ | — | — | Require approvals for actions performed with these credentials |
239
240
  | `--non-interactive` | `boolean` | ❌ | — | — | Skip interactive prompts. Uses defaults where possible; errors instead of prompting when input is required. Useful in CI, piped output, or environments where TTY detection is unreliable. |
240
241
  | `--headless` | `boolean` | ❌ | — | — | Use when signing up from a machine that has no browser. Prints a signup link to open elsewhere, then accepts the pasted loopback callback URL. |
242
+ | `--callback-url` | `string` | ❌ | — | — | Resume a pending non-interactive signup with the final OAuth callback URL from your browser. |
241
243
 
242
244
  **Usage:**
243
245
 
244
246
  ```bash
245
- npx zapier-sdk signup [--timeout] [--use-approvals] [--non-interactive] [--headless]
247
+ npx zapier-sdk signup [--timeout] [--use-approvals] [--non-interactive] [--headless] [--callback-url]
246
248
  ```
247
249
 
248
250
  ### Actions
@@ -1235,11 +1237,11 @@ Acknowledge messages from a lease. Acked messages are removed from the inbox; un
1235
1237
 
1236
1238
  **Options:**
1237
1239
 
1238
- | Option | Type | Required | Default | Possible Values | Description |
1239
- | ------------ | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1240
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1241
- | `<lease>` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
1242
- | `--messages` | `array` | ❌ | — | — | Specific message IDs to ack. Omit to ack every message in the lease. |
1240
+ | Option | Type | Required | Default | Possible Values | Description |
1241
+ | ------------ | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1242
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1243
+ | `<lease>` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
1244
+ | `--messages` | `array` | ❌ | — | — | Specific message IDs to ack. Omit to ack every message in the lease. |
1243
1245
 
1244
1246
  **Usage:**
1245
1247
 
@@ -1249,23 +1251,23 @@ npx zapier-sdk ack-trigger-inbox-messages <inbox> <lease> [--messages]
1249
1251
 
1250
1252
  #### `create-trigger-inbox` 🧪 _experimental_
1251
1253
 
1252
- Create a new trigger inbox subscription. Always creates a new inbox; use ensureTriggerInbox for get-or-create on a stable name.
1254
+ Create a new trigger inbox subscription. Always creates a new inbox; use ensureTriggerInbox for get-or-create on a stable key.
1253
1255
 
1254
1256
  **Options:**
1255
1257
 
1256
- | Option | Type | Required | Default | Possible Values | Description |
1257
- | -------------------- | ---------------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
1258
- | `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
1259
- | `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
1260
- | `--name` | `string` | ❌ | — | — | Optional inbox name. Auto-generated when omitted. Throws a conflict error if the name is already in use by another subscription. |
1261
- | `--connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
1262
- | `--inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
1263
- | `--notification-url` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
1258
+ | Option | Type | Required | Default | Possible Values | Description |
1259
+ | -------------------- | ---------------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
1260
+ | `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
1261
+ | `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
1262
+ | `--key` | `string` | ❌ | — | — | Optional inbox key. Auto-generated when omitted. Throws a conflict error if the key is already in use by another subscription. |
1263
+ | `--connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
1264
+ | `--inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
1265
+ | `--notification-url` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
1264
1266
 
1265
1267
  **Usage:**
1266
1268
 
1267
1269
  ```bash
1268
- npx zapier-sdk create-trigger-inbox <app> <action> [--name] [--connection] [--inputs] [--notification-url]
1270
+ npx zapier-sdk create-trigger-inbox <app> <action> [--key] [--connection] [--inputs] [--notification-url]
1269
1271
  ```
1270
1272
 
1271
1273
  #### `delete-trigger-inbox` 🧪 _experimental_
@@ -1274,9 +1276,9 @@ Mark a trigger inbox for deletion
1274
1276
 
1275
1277
  **Options:**
1276
1278
 
1277
- | Option | Type | Required | Default | Possible Values | Description |
1278
- | --------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1279
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1279
+ | Option | Type | Required | Default | Possible Values | Description |
1280
+ | --------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1281
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1280
1282
 
1281
1283
  **Usage:**
1282
1284
 
@@ -1292,7 +1294,7 @@ Drain an existing trigger inbox: lease currently-available messages, process eac
1292
1294
 
1293
1295
  | Option | Type | Required | Default | Possible Values | Description |
1294
1296
  | --------------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1295
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1297
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1296
1298
  | `--concurrency` | `number` | ❌ | — | — | Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set. |
1297
1299
  | `--lease-limit` | `number` | ❌ | — | — | Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set. |
1298
1300
  | `--lease-seconds` | `number` | ❌ | — | — | Seconds until the lease expires; messages return to available if not acked. API default is 300 (5 minutes). |
@@ -1311,23 +1313,23 @@ npx zapier-sdk drain-trigger-inbox <inbox> [--concurrency] [--lease-limit] [--le
1311
1313
 
1312
1314
  #### `ensure-trigger-inbox` 🧪 _experimental_
1313
1315
 
1314
- 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.
1316
+ 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.
1315
1317
 
1316
1318
  **Options:**
1317
1319
 
1318
- | Option | Type | Required | Default | Possible Values | Description |
1319
- | -------------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1320
- | `<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). |
1321
- | `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
1322
- | `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
1323
- | `--connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
1324
- | `--inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
1325
- | `--notification-url` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
1320
+ | Option | Type | Required | Default | Possible Values | Description |
1321
+ | -------------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1322
+ | `<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). |
1323
+ | `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
1324
+ | `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
1325
+ | `--connection` | `string, number` | ❌ | — | — | Connection alias or connection ID. Optional for triggers that don't require auth. |
1326
+ | `--inputs` | `object` | ❌ | — | — | Input parameters for the trigger subscription |
1327
+ | `--notification-url` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive |
1326
1328
 
1327
1329
  **Usage:**
1328
1330
 
1329
1331
  ```bash
1330
- npx zapier-sdk ensure-trigger-inbox <name> <app> <action> [--connection] [--inputs] [--notification-url]
1332
+ npx zapier-sdk ensure-trigger-inbox <key> <app> <action> [--connection] [--inputs] [--notification-url]
1331
1333
  ```
1332
1334
 
1333
1335
  #### `get-trigger-inbox` 🧪 _experimental_
@@ -1336,9 +1338,9 @@ Get details of a trigger inbox by ID
1336
1338
 
1337
1339
  **Options:**
1338
1340
 
1339
- | Option | Type | Required | Default | Possible Values | Description |
1340
- | --------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1341
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1341
+ | Option | Type | Required | Default | Possible Values | Description |
1342
+ | --------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1343
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1342
1344
 
1343
1345
  **Usage:**
1344
1346
 
@@ -1373,7 +1375,7 @@ Lease up to N messages from a trigger inbox. Returns messages plus a lease ID; a
1373
1375
 
1374
1376
  | Option | Type | Required | Default | Possible Values | Description |
1375
1377
  | ----------------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------- |
1376
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1378
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1377
1379
  | `--lease-limit` | `number` | ❌ | — | — | Maximum messages to lease in a single batch (1-100) |
1378
1380
  | `--lease-seconds` | `number` | ❌ | — | — | Seconds until the lease expires; messages return to available if not acked. API default is 300 (5 minutes). |
1379
1381
 
@@ -1389,12 +1391,12 @@ List messages in a trigger inbox (no payload, status-only)
1389
1391
 
1390
1392
  **Options:**
1391
1393
 
1392
- | Option | Type | Required | Default | Possible Values | Description |
1393
- | ------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1394
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1395
- | `--page-size` | `number` | ❌ | — | — | Number of messages per page |
1396
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1397
- | `--cursor` | `string` | ❌ | — | — | Pagination cursor |
1394
+ | Option | Type | Required | Default | Possible Values | Description |
1395
+ | ------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1396
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1397
+ | `--page-size` | `number` | ❌ | — | — | Number of messages per page |
1398
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1399
+ | `--cursor` | `string` | ❌ | — | — | Pagination cursor |
1398
1400
 
1399
1401
  **Usage:**
1400
1402
 
@@ -1408,18 +1410,18 @@ List all trigger inboxes for the authenticated user
1408
1410
 
1409
1411
  **Options:**
1410
1412
 
1411
- | Option | Type | Required | Default | Possible Values | Description |
1412
- | ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
1413
- | `--name` | `string` | ❌ | — | — | Filter by inbox name (exact match). Names are unique per (user, account), so this returns at most one inbox. |
1414
- | `--status` | `string` | ❌ | — | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Filter by inbox status |
1415
- | `--page-size` | `number` | ❌ | — | — | Number of inboxes per page |
1416
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1417
- | `--cursor` | `string` | ❌ | — | — | Cursor (offset) to start from for pagination |
1413
+ | Option | Type | Required | Default | Possible Values | Description |
1414
+ | ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
1415
+ | `--key` | `string` | ❌ | — | — | Filter by inbox key (exact match). Keys are unique per (user, account), so this returns at most one inbox. |
1416
+ | `--status` | `string` | ❌ | — | `initializing`, `active`, `paused`, `deleting`, `initialization_failure` | Filter by inbox status |
1417
+ | `--page-size` | `number` | ❌ | — | — | Number of inboxes per page |
1418
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1419
+ | `--cursor` | `string` | ❌ | — | — | Cursor (offset) to start from for pagination |
1418
1420
 
1419
1421
  **Usage:**
1420
1422
 
1421
1423
  ```bash
1422
- npx zapier-sdk list-trigger-inboxes [--name] [--status] [--page-size] [--max-items] [--cursor]
1424
+ npx zapier-sdk list-trigger-inboxes [--key] [--status] [--page-size] [--max-items] [--cursor]
1423
1425
  ```
1424
1426
 
1425
1427
  #### `list-trigger-input-field-choices` 🧪 _experimental_
@@ -1493,9 +1495,9 @@ Pause a trigger inbox; events stop being collected
1493
1495
 
1494
1496
  **Options:**
1495
1497
 
1496
- | Option | Type | Required | Default | Possible Values | Description |
1497
- | --------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1498
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1498
+ | Option | Type | Required | Default | Possible Values | Description |
1499
+ | --------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1500
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1499
1501
 
1500
1502
  **Usage:**
1501
1503
 
@@ -1509,11 +1511,11 @@ Release messages from a lease back to the inbox without acknowledging them. Rele
1509
1511
 
1510
1512
  **Options:**
1511
1513
 
1512
- | Option | Type | Required | Default | Possible Values | Description |
1513
- | ------------ | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1514
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1515
- | `<lease>` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
1516
- | `--messages` | `array` | ❌ | — | — | Specific message IDs to release. Omit to release every message in the lease. |
1514
+ | Option | Type | Required | Default | Possible Values | Description |
1515
+ | ------------ | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1516
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1517
+ | `<lease>` | `string` | ✅ | — | — | Lease ID returned from leaseTriggerInboxMessages |
1518
+ | `--messages` | `array` | ❌ | — | — | Specific message IDs to release. Omit to release every message in the lease. |
1517
1519
 
1518
1520
  **Usage:**
1519
1521
 
@@ -1527,9 +1529,9 @@ Resume a paused trigger inbox; events resume being collected
1527
1529
 
1528
1530
  **Options:**
1529
1531
 
1530
- | Option | Type | Required | Default | Possible Values | Description |
1531
- | --------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1532
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1532
+ | Option | Type | Required | Default | Possible Values | Description |
1533
+ | --------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1534
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1533
1535
 
1534
1536
  **Usage:**
1535
1537
 
@@ -1543,10 +1545,10 @@ Update settings on an existing trigger inbox
1543
1545
 
1544
1546
  **Options:**
1545
1547
 
1546
- | Option | Type | Required | Default | Possible Values | Description |
1547
- | -------------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------- |
1548
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1549
- | `--notification-url` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive. Pass null to clear. |
1548
+ | Option | Type | Required | Default | Possible Values | Description |
1549
+ | -------------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------------- |
1550
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1551
+ | `--notification-url` | `string` | ❌ | — | — | Webhook URL to POST to when new messages arrive. Pass null to clear. |
1550
1552
 
1551
1553
  **Usage:**
1552
1554
 
@@ -1562,7 +1564,7 @@ Continuously consume a trigger inbox: drain currently-available messages via onM
1562
1564
 
1563
1565
  | Option | Type | Required | Default | Possible Values | Description |
1564
1566
  | ------------------------------ | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1565
- | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or name. Non-UUID values are resolved by name via the inbox list endpoint. |
1567
+ | `<inbox>` | `string` | ✅ | — | — | Trigger inbox identifier — UUID or key. Non-UUID values are resolved by key via the inbox list endpoint. |
1566
1568
  | `--concurrency` | `number` | ❌ | — | — | Per-message handler workers running in parallel. Defaults to `leaseLimit`, or 1 if neither is set. |
1567
1569
  | `--lease-limit` | `number` | ❌ | — | — | Per-lease HTTP batch size. Defaults to `concurrency`, or 1 if neither is set. |
1568
1570
  | `--lease-seconds` | `number` | ❌ | — | — | Seconds until the lease expires; messages return to available if not acked. API default is 300 (5 minutes). |