@celigo/api-specs 0.2.134 → 0.2.136
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.
- package/dist/ai-agent.yml +4 -1
- package/dist/api.yml +8 -2
- package/dist/connection.yml +14 -7
- package/dist/enduser.yml +8 -2
- package/dist/flow.yml +94 -45
- package/dist/iclient.yml +28 -25
- package/dist/job.yml +9 -5
- package/dist/mcp-server.yml +8 -2
- package/dist/tool.yml +8 -2
- package/package.json +1 -1
- package/schemas.json +353 -360
package/dist/ai-agent.yml
CHANGED
|
@@ -4329,7 +4329,10 @@ components:
|
|
|
4329
4329
|
transformed name: `data[0].name` copies a field of the first result,
|
|
4330
4330
|
`data` copies the whole result array. A bare result-record field name
|
|
4331
4331
|
(e.g. `name`) resolves to nothing and merges nothing, and so does the
|
|
4332
|
-
raw response path a transform consumed.
|
|
4332
|
+
raw response path a transform consumed. A lookup that groups its
|
|
4333
|
+
results returns each group as an array inside `data`
|
|
4334
|
+
(`"data": [[<row>, <row>]]`): `data[0][0].name` (or `data.0.0.name`)
|
|
4335
|
+
reads the first row of the first group, and `data[0]` copies the group.
|
|
4333
4336
|
- **Import steps**: `{"id": "<destination record id>", "statusCode": 200,
|
|
4334
4337
|
"ignored": false, "errors": [], "_json": <raw destination response>,
|
|
4335
4338
|
...<response body fields flattened at the root>}` — use `id` for the
|
package/dist/api.yml
CHANGED
|
@@ -5015,6 +5015,12 @@ components:
|
|
|
5015
5015
|
type: boolean
|
|
5016
5016
|
description: When true, the connection has been taken offline and is skipped during flow execution.
|
|
5017
5017
|
readOnly: true
|
|
5018
|
+
needsAuthorization:
|
|
5019
|
+
type: boolean
|
|
5020
|
+
readOnly: true
|
|
5021
|
+
description: |-
|
|
5022
|
+
OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
|
|
5023
|
+
and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
|
|
5018
5024
|
_sourceId:
|
|
5019
5025
|
type: string
|
|
5020
5026
|
format: objectId
|
|
@@ -6071,7 +6077,7 @@ components:
|
|
|
6071
6077
|
OAuth 2.0 redirect URI (callback URL) registered with the API provider.
|
|
6072
6078
|
Must exactly match the redirect URI configured in the OAuth application registration.
|
|
6073
6079
|
examples:
|
|
6074
|
-
- https://
|
|
6080
|
+
- https://integrator.io/connection/oauth2callback
|
|
6075
6081
|
useIClientFields:
|
|
6076
6082
|
type: boolean
|
|
6077
6083
|
description: |
|
|
@@ -9927,7 +9933,7 @@ components:
|
|
|
9927
9933
|
|
|
9928
9934
|
## REQUIRED FIELDS
|
|
9929
9935
|
- pingFunction (name of the function that tests connection health)
|
|
9930
|
-
- _stackId (
|
|
9936
|
+
- _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
|
|
9931
9937
|
|
|
9932
9938
|
## CUSTOM FIELDS
|
|
9933
9939
|
Use encrypted/unencrypted fields to store connection-specific configuration.
|
package/dist/connection.yml
CHANGED
|
@@ -2438,7 +2438,8 @@ paths:
|
|
|
2438
2438
|
Returns the buffered debug log stream for the connection — request/response pairs from
|
|
2439
2439
|
recent exports, imports, and lookups that used it. Capture is gated by the connection's
|
|
2440
2440
|
`debugDate`: logs are recorded only while `debugDate` is in the future, so enable it first
|
|
2441
|
-
|
|
2441
|
+
with `PATCH /v1/connections/{_id}` on `/debugDate` (credential-safe, unlike a full `PUT`)
|
|
2442
|
+
or the buffer stays empty.
|
|
2442
2443
|
|
|
2443
2444
|
The response is a plain-text stream (not JSON): each entry is a header line
|
|
2444
2445
|
(`timestamp traceKey resourceType resourceId`) followed by a single-line JSON payload,
|
|
@@ -2494,11 +2495,11 @@ paths:
|
|
|
2494
2495
|
|
|
2495
2496
|
Idempotent — works whether the buffer held entries, was already empty, or the given
|
|
2496
2497
|
connection id does not exist. Does **not** clear the connection's `debugDate` — debug
|
|
2497
|
-
capture remains enabled until `debugDate` expires or is removed
|
|
2498
|
+
capture remains enabled until `debugDate` expires or is removed.
|
|
2498
2499
|
|
|
2499
2500
|
Useful between test runs to isolate logs for a single scenario. To fully
|
|
2500
|
-
disable debug capture, also `
|
|
2501
|
-
|
|
2501
|
+
disable debug capture, also send `PATCH /v1/connections/{_id}` with a `remove`
|
|
2502
|
+
operation on `/debugDate`.
|
|
2502
2503
|
parameters:
|
|
2503
2504
|
- name: _id
|
|
2504
2505
|
in: path
|
|
@@ -4126,6 +4127,12 @@ components:
|
|
|
4126
4127
|
type: boolean
|
|
4127
4128
|
description: When true, the connection has been taken offline and is skipped during flow execution.
|
|
4128
4129
|
readOnly: true
|
|
4130
|
+
needsAuthorization:
|
|
4131
|
+
type: boolean
|
|
4132
|
+
readOnly: true
|
|
4133
|
+
description: |-
|
|
4134
|
+
OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
|
|
4135
|
+
and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
|
|
4129
4136
|
_sourceId:
|
|
4130
4137
|
type: string
|
|
4131
4138
|
format: objectId
|
|
@@ -5182,7 +5189,7 @@ components:
|
|
|
5182
5189
|
OAuth 2.0 redirect URI (callback URL) registered with the API provider.
|
|
5183
5190
|
Must exactly match the redirect URI configured in the OAuth application registration.
|
|
5184
5191
|
examples:
|
|
5185
|
-
- https://
|
|
5192
|
+
- https://integrator.io/connection/oauth2callback
|
|
5186
5193
|
useIClientFields:
|
|
5187
5194
|
type: boolean
|
|
5188
5195
|
description: |
|
|
@@ -9038,7 +9045,7 @@ components:
|
|
|
9038
9045
|
|
|
9039
9046
|
## REQUIRED FIELDS
|
|
9040
9047
|
- pingFunction (name of the function that tests connection health)
|
|
9041
|
-
- _stackId (
|
|
9048
|
+
- _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
|
|
9042
9049
|
|
|
9043
9050
|
## CUSTOM FIELDS
|
|
9044
9051
|
Use encrypted/unencrypted fields to store connection-specific configuration.
|
|
@@ -10441,7 +10448,7 @@ components:
|
|
|
10441
10448
|
Embeds a one-time token in the `state` query parameter that expires quickly and is
|
|
10442
10449
|
invalidated after a single use.
|
|
10443
10450
|
examples:
|
|
10444
|
-
- https://login.example.com/oauth2/authorize?response_type=code&client_id=0oa1b2c3d4EXAMPLE5&redirect_uri=https%3A%2F%
|
|
10451
|
+
- https://login.example.com/oauth2/authorize?response_type=code&client_id=0oa1b2c3d4EXAMPLE5&redirect_uri=https%3A%2F%2Fintegrator.io%2Fconnection%2Foauth2callback&scope=read+write&state=eyJfY29ubmVjdGlvbklkIjoiNjE1ZGZhMDc0Mjc2MzY3MTI3NWI3MGFiIn0
|
|
10445
10452
|
DependencyEntry:
|
|
10446
10453
|
type: object
|
|
10447
10454
|
description: A single resource that depends on the queried resource.
|
package/dist/enduser.yml
CHANGED
|
@@ -2227,6 +2227,12 @@ components:
|
|
|
2227
2227
|
type: boolean
|
|
2228
2228
|
description: When true, the connection has been taken offline and is skipped during flow execution.
|
|
2229
2229
|
readOnly: true
|
|
2230
|
+
needsAuthorization:
|
|
2231
|
+
type: boolean
|
|
2232
|
+
readOnly: true
|
|
2233
|
+
description: |-
|
|
2234
|
+
OAuth handshake state. Celigo's OAuth callback sets it to `false` once the user consents
|
|
2235
|
+
and the tokens are stored (see `GET /v1/connection/{_id}/oauth2`).
|
|
2230
2236
|
_sourceId:
|
|
2231
2237
|
type: string
|
|
2232
2238
|
format: objectId
|
|
@@ -3283,7 +3289,7 @@ components:
|
|
|
3283
3289
|
OAuth 2.0 redirect URI (callback URL) registered with the API provider.
|
|
3284
3290
|
Must exactly match the redirect URI configured in the OAuth application registration.
|
|
3285
3291
|
examples:
|
|
3286
|
-
- https://
|
|
3292
|
+
- https://integrator.io/connection/oauth2callback
|
|
3287
3293
|
useIClientFields:
|
|
3288
3294
|
type: boolean
|
|
3289
3295
|
description: |
|
|
@@ -7139,7 +7145,7 @@ components:
|
|
|
7139
7145
|
|
|
7140
7146
|
## REQUIRED FIELDS
|
|
7141
7147
|
- pingFunction (name of the function that tests connection health)
|
|
7142
|
-
- _stackId (
|
|
7148
|
+
- _stackId (inside this object, as `wrapper._stackId` — references the Celigo Stack)
|
|
7143
7149
|
|
|
7144
7150
|
## CUSTOM FIELDS
|
|
7145
7151
|
Use encrypted/unencrypted fields to store connection-specific configuration.
|
package/dist/flow.yml
CHANGED
|
@@ -426,7 +426,7 @@ paths:
|
|
|
426
426
|
| `/name` | Flow display name |
|
|
427
427
|
| `/description` | Flow description |
|
|
428
428
|
| `/disabled` | Enable or disable the flow |
|
|
429
|
-
| `/logging/debugUntil` | Debug logging expiry (ISO-8601;
|
|
429
|
+
| `/logging/debugUntil` | Debug logging expiry (ISO-8601; at most the license's `logging.maxDebugDuration` minutes ahead, 422 beyond the cap) |
|
|
430
430
|
| `/logging/mode` | Logging mode |
|
|
431
431
|
| `/runPageGeneratorsInParallel` | Run page generators in parallel |
|
|
432
432
|
| `/aiDescription` | AI-generated description object |
|
|
@@ -439,7 +439,8 @@ paths:
|
|
|
439
439
|
|
|
440
440
|
PATCH is safer than PUT for toggling `disabled` or arming debug logging because it won't
|
|
441
441
|
accidentally reset other fields. To arm debug logging, `replace` `/logging/debugUntil` with
|
|
442
|
-
a future ISO timestamp (up to
|
|
442
|
+
a future ISO timestamp (up to the plan's cap, `logging.maxDebugDuration` minutes on the license
|
|
443
|
+
from `GET /v1/licenses`); to
|
|
443
444
|
disarm, set it to a past timestamp or null.
|
|
444
445
|
operationId: patchFlow
|
|
445
446
|
tags:
|
|
@@ -1502,7 +1503,8 @@ paths:
|
|
|
1502
1503
|
Returns one page of already-resolved errors for a flow step (same shape as the open-errors listing).
|
|
1503
1504
|
|
|
1504
1505
|
Errors arrive here either because a user marked them resolved (`PUT .../resolved`) or because a
|
|
1505
|
-
|
|
1506
|
+
retry was submitted for them — a retry resolves its errors when it is submitted, whatever its
|
|
1507
|
+
outcome. The platform retains resolved errors through the account's
|
|
1506
1508
|
retention window; use `DELETE .../resolved` to purge them earlier.
|
|
1507
1509
|
|
|
1508
1510
|
`resolvedBy` distinguishes how each error was closed: `auto` means a system-initiated
|
|
@@ -1856,9 +1858,9 @@ paths:
|
|
|
1856
1858
|
- Flows
|
|
1857
1859
|
summary: Retry errored records
|
|
1858
1860
|
description: |-
|
|
1859
|
-
Re-runs the per-record data snapshots captured when the listed errors occurred.
|
|
1860
|
-
|
|
1861
|
-
|
|
1861
|
+
Re-runs the per-record data snapshots captured when the listed errors occurred. Submitting the
|
|
1862
|
+
retry resolves the listed errors at once, before the retry job runs and whatever it does; a record
|
|
1863
|
+
that fails again comes back as a new open error.
|
|
1862
1864
|
|
|
1863
1865
|
Only errors that carry a `retryDataKey` can be retried — typically these are record-level errors
|
|
1864
1866
|
from imports or transforms. Connection-level errors (`classification: connection`) don't have a
|
|
@@ -1867,16 +1869,16 @@ paths:
|
|
|
1867
1869
|
**Response behavior splits on whether anything matched:**
|
|
1868
1870
|
- At least one record matched — a supplied `retryDataKey`, or (in `selectAll` mode) a retriable
|
|
1869
1871
|
open error on or before `lastErrorAt` → **200** with a `type: "retry"` Job record (the queued
|
|
1870
|
-
retry job; poll it via `GET /v1/jobs/{_id}`).
|
|
1871
|
-
`
|
|
1872
|
-
|
|
1872
|
+
retry job; poll it via `GET /v1/jobs/{_id}`). The matched errors move from `GET .../errors` to
|
|
1873
|
+
`/resolved` as the job is queued, with `resolvedBy` set to the user who submitted the retry.
|
|
1874
|
+
System-initiated auto-retries set `resolvedBy` to `"auto"` instead.
|
|
1873
1875
|
- Nothing matched → **204** silent no-op. There is no per-key validation: the endpoint does not
|
|
1874
1876
|
400 on bogus keys; callers must poll `GET .../errors` to confirm any change.
|
|
1875
1877
|
|
|
1876
|
-
**Retry outcome semantics.** A
|
|
1877
|
-
`errorId
|
|
1878
|
-
|
|
1879
|
-
|
|
1878
|
+
**Retry outcome semantics.** A record that fails again becomes a **new** open error with a new
|
|
1879
|
+
`errorId`, the same `retryDataKey` and `traceKey`, and the retry job's id as `_flowJobId`; the
|
|
1880
|
+
original stays resolved. Reconcile the "before" and "after" error lists by `retryDataKey`, not
|
|
1881
|
+
`errorId`.
|
|
1880
1882
|
|
|
1881
1883
|
To modify a record before retrying, call `GET .../{ retryDataKey}/data`, mutate the payload,
|
|
1882
1884
|
`PUT` it back, then call this endpoint. Retried records go through the same page-processor
|
|
@@ -1884,6 +1886,11 @@ paths:
|
|
|
1884
1886
|
listing keys, send `selectAll: true` with a `lastErrorAt` high-water mark instead of
|
|
1885
1887
|
`retryDataKeys` — one call retries every matching error, no matter how many (errors without a
|
|
1886
1888
|
`retryDataKey` are skipped).
|
|
1889
|
+
x-celigo-ai-guidance:
|
|
1890
|
+
- |-
|
|
1891
|
+
An error leaving the open list after this call does not mean the retry worked: submitting
|
|
1892
|
+
resolves it before the retry runs. Wait for the returned job to finish, then check its
|
|
1893
|
+
`numError` and the open errors for the same `retryDataKey`.
|
|
1887
1894
|
parameters:
|
|
1888
1895
|
- name: _id
|
|
1889
1896
|
in: path
|
|
@@ -2112,8 +2119,8 @@ paths:
|
|
|
2112
2119
|
`pathToMany`, `childIndex`, `traceKey`) identify where in the pipeline the record was when it
|
|
2113
2120
|
failed and how it's structured.
|
|
2114
2121
|
|
|
2115
|
-
The `data` field
|
|
2116
|
-
|
|
2122
|
+
The `data` field is the record as it reached the failing step — on an HTTP import, before the
|
|
2123
|
+
import's mappings, not the request the import sent. Use `PUT .../{retryDataKey}/data` to mutate
|
|
2117
2124
|
the snapshot before retrying. Only errors with a `retryDataKey` expose this endpoint;
|
|
2118
2125
|
connection-class errors are rejected with `no_retrydata_found`. The `stage` field indicates
|
|
2119
2126
|
where the retry will resume: `page_processor_import` re-runs the import (most common),
|
|
@@ -2961,9 +2968,10 @@ paths:
|
|
|
2961
2968
|
(export or import). Entries carry the `(_expOrImpId, groupId, recordId, traceKey)` tuple needed to
|
|
2962
2969
|
drill into per-stage metadata and data via the `logs/metadata/query` and `logs/data/query` endpoints.
|
|
2963
2970
|
|
|
2964
|
-
Execution logs are
|
|
2965
|
-
|
|
2966
|
-
|
|
2971
|
+
Execution logs are captured only for a run with a logging level — the job's `logMode` — set by the
|
|
2972
|
+
flow's `logging.mode` or an open `logging.debugUntil` window. While the account-level logging
|
|
2973
|
+
preference is off, a flow set to `basic` captures nothing and its jobs carry no `logMode`. Jobs older
|
|
2974
|
+
than the flow's log retention window will return an empty `logs` array.
|
|
2967
2975
|
|
|
2968
2976
|
For per-stage data (an HTTP request and response, or a mapping's or script hook's input and
|
|
2969
2977
|
output), pick an entry and call `POST .../logs/data/query` with the corresponding `stage`. To stitch an
|
|
@@ -3411,6 +3419,9 @@ paths:
|
|
|
3411
3419
|
test-run shape also exists for Tools (`/v1/tools/{_id}/test/run`) and
|
|
3412
3420
|
builder-mode APIs (`/v1/apis/{_id}/test/run`).
|
|
3413
3421
|
|
|
3422
|
+
A test run processes only the first page of records: later pages arrive empty, so downstream
|
|
3423
|
+
steps see only the first page's records.
|
|
3424
|
+
|
|
3414
3425
|
Test-run state is short-lived and ephemeral — capture the `runId` (the
|
|
3415
3426
|
`flowJob._id`) and read back any step detail soon after the run returns.
|
|
3416
3427
|
parameters:
|
|
@@ -4303,7 +4314,10 @@ components:
|
|
|
4303
4314
|
transformed name: `data[0].name` copies a field of the first result,
|
|
4304
4315
|
`data` copies the whole result array. A bare result-record field name
|
|
4305
4316
|
(e.g. `name`) resolves to nothing and merges nothing, and so does the
|
|
4306
|
-
raw response path a transform consumed.
|
|
4317
|
+
raw response path a transform consumed. A lookup that groups its
|
|
4318
|
+
results returns each group as an array inside `data`
|
|
4319
|
+
(`"data": [[<row>, <row>]]`): `data[0][0].name` (or `data.0.0.name`)
|
|
4320
|
+
reads the first row of the first group, and `data[0]` copies the group.
|
|
4307
4321
|
- **Import steps**: `{"id": "<destination record id>", "statusCode": 200,
|
|
4308
4322
|
"ignored": false, "errors": [], "_json": <raw destination response>,
|
|
4309
4323
|
...<response body fields flattened at the root>}` — use `id` for the
|
|
@@ -4627,10 +4641,13 @@ components:
|
|
|
4627
4641
|
properties:
|
|
4628
4642
|
version:
|
|
4629
4643
|
type: string
|
|
4630
|
-
|
|
4644
|
+
enum:
|
|
4645
|
+
- '1'
|
|
4646
|
+
x-enumDescriptions:
|
|
4647
|
+
'1': Version 1 of the Celigo expression-based filter format.
|
|
4648
|
+
description: Version of the filter format used by `rules`, the same version export and import filters use.
|
|
4631
4649
|
examples:
|
|
4632
|
-
- '1
|
|
4633
|
-
- '2.0'
|
|
4650
|
+
- '1'
|
|
4634
4651
|
rules:
|
|
4635
4652
|
type: array
|
|
4636
4653
|
description: |
|
|
@@ -4900,7 +4917,9 @@ components:
|
|
|
4900
4917
|
description: |
|
|
4901
4918
|
Override configurations for exports in the abstract flow.
|
|
4902
4919
|
|
|
4903
|
-
Allows customizing export behavior while maintaining the flow structure.
|
|
4920
|
+
Allows customizing export behavior while maintaining the flow structure. Each entry needs
|
|
4921
|
+
at least one field besides `_abstractId`; an entry with only `_abstractId` fails with 422
|
|
4922
|
+
("Export override must include at least one field in addition to _abstractId").
|
|
4904
4923
|
items:
|
|
4905
4924
|
type: object
|
|
4906
4925
|
properties:
|
|
@@ -4912,7 +4931,10 @@ components:
|
|
|
4912
4931
|
_id:
|
|
4913
4932
|
type: string
|
|
4914
4933
|
x-celigo-refModel: exports
|
|
4915
|
-
description:
|
|
4934
|
+
description: |-
|
|
4935
|
+
Existing export that replaces the abstract flow's export on this instance. This is
|
|
4936
|
+
how an instance gets its own webhook URL: instances that keep the abstract flow's
|
|
4937
|
+
listener share its URL, and one request to it runs every enabled instance.
|
|
4916
4938
|
examples:
|
|
4917
4939
|
- 60a2c4e6f321d800129a1a3c
|
|
4918
4940
|
_connectionId:
|
|
@@ -5397,7 +5419,11 @@ components:
|
|
|
5397
5419
|
Writable flow fields shared by the request and response schemas.
|
|
5398
5420
|
|
|
5399
5421
|
Use `pageProcessors` for simple linear flows or `routers` for conditional branching — never
|
|
5400
|
-
include both
|
|
5422
|
+
include both: a flow with both arrays non-empty is rejected with 422 `invalid_branched_flow_config`.
|
|
5423
|
+
The same import can be a step only once per flow: a second `pageProcessors` entry with its
|
|
5424
|
+
`_importId`, in the same array or another branch, fails with 422 `invalid_flow` ("… already
|
|
5425
|
+
included as a pageProcessor"). The `schedule` field uses Celigo's 6-field cron format (not
|
|
5426
|
+
standard 5-field).
|
|
5401
5427
|
properties:
|
|
5402
5428
|
name:
|
|
5403
5429
|
type: string
|
|
@@ -5528,6 +5554,9 @@ components:
|
|
|
5528
5554
|
neither, has exactly one branch, and is not drawn — it is the invisible joint that holds
|
|
5529
5555
|
the steps before the first branching router (they cannot sit in top-level
|
|
5530
5556
|
`pageProcessors` once routers exist) and that merges branches back into shared steps.
|
|
5557
|
+
Records enter at `routers[0]` and reach other routers only through `branches[].nextRouterId`,
|
|
5558
|
+
so the order of the rest of the array is not execution order; a flow edited in Flow Builder
|
|
5559
|
+
can list its routers out of execution order.
|
|
5531
5560
|
x-celigo-ai-guidance:
|
|
5532
5561
|
- No branching on a non-abstract flow → leave `routers` out and put the steps in top-level `pageProcessors`. No branching on an abstract flow → one pass-through router holding the chain (top-level `pageProcessors` are rejected with 422 `abstract_flow_invalid_fields`).
|
|
5533
5562
|
- Steps before the first branching router go in a one-branch pass-through router at `routers[0]` with neither `routeRecordsTo` nor `routeRecordsUsing` set, chained to the branching router with `branches[0].nextRouterId`. Branches that rejoin point `nextRouterId` at one shared pass-through router.
|
|
@@ -5868,15 +5897,15 @@ components:
|
|
|
5868
5897
|
- detailed
|
|
5869
5898
|
x-enumDescriptions:
|
|
5870
5899
|
accountLevel: Inherits the account-level logging setting.
|
|
5871
|
-
basic: Logs record
|
|
5900
|
+
basic: Logs each record's step status and each HTTP call's method, URL and status code, without headers or bodies; captures nothing while the account-level logging preference is off.
|
|
5872
5901
|
detailed: Logs full per-record data including request/response payloads.
|
|
5873
5902
|
debugUntil:
|
|
5874
5903
|
type: string
|
|
5875
5904
|
format: date-time
|
|
5876
5905
|
description: |-
|
|
5877
|
-
Temporary debug-level logging until this timestamp. The
|
|
5878
|
-
|
|
5879
|
-
rejected with 422.
|
|
5906
|
+
Temporary debug-level logging until this timestamp. The longest window is the
|
|
5907
|
+
plan's `logging.maxDebugDuration` (minutes) on the account's license
|
|
5908
|
+
(`GET /v1/licenses`); values beyond the cap are rejected with 422.
|
|
5880
5909
|
examples:
|
|
5881
5910
|
- '2026-01-15T10:30:00.000Z'
|
|
5882
5911
|
hidden:
|
|
@@ -6524,8 +6553,8 @@ components:
|
|
|
6524
6553
|
type: object
|
|
6525
6554
|
description: |-
|
|
6526
6555
|
One open-error record on a flow step. Errors accumulate per `(flow, step)` pair as the flow runs;
|
|
6527
|
-
they remain "open" until a user marks them resolved (`PUT .../resolved`) or a
|
|
6528
|
-
|
|
6556
|
+
they remain "open" until a user marks them resolved (`PUT .../resolved`) or submits a retry for
|
|
6557
|
+
them (`POST .../retry` resolves them at submission, whatever the retry's outcome).
|
|
6529
6558
|
properties:
|
|
6530
6559
|
errorId:
|
|
6531
6560
|
type: string
|
|
@@ -6542,7 +6571,11 @@ components:
|
|
|
6542
6571
|
- '2026-01-15T09:30:00.000Z'
|
|
6543
6572
|
source:
|
|
6544
6573
|
type: string
|
|
6545
|
-
description:
|
|
6574
|
+
description: |-
|
|
6575
|
+
Step stage or system the error came from, such as `application` (raised from the
|
|
6576
|
+
destination's response), `connection`, a hook (`pre_save_page_hook`,
|
|
6577
|
+
`post_response_map_hook`) or a filter (`output_filter`). `GET /v1/errors/filterMetadata`
|
|
6578
|
+
lists the source values the errors filter accepts.
|
|
6546
6579
|
examples:
|
|
6547
6580
|
- application
|
|
6548
6581
|
code:
|
|
@@ -6780,9 +6813,10 @@ components:
|
|
|
6780
6813
|
resolvedBy:
|
|
6781
6814
|
type: string
|
|
6782
6815
|
description: |-
|
|
6783
|
-
`"auto"` when the platform
|
|
6784
|
-
|
|
6785
|
-
|
|
6816
|
+
`"auto"` when the platform resolved it (a system-initiated retry, or a
|
|
6817
|
+
connection-class error resolved at the end of a job), or the Mongo **user id** (not
|
|
6818
|
+
email) of the user who resolved it — through `PUT .../resolved`, or by submitting a
|
|
6819
|
+
retry, which resolves its errors when it is submitted.
|
|
6786
6820
|
Cross-reference via `GET /v1/ashares/{_id}` to resolve the id to a profile.
|
|
6787
6821
|
examples:
|
|
6788
6822
|
- auto
|
|
@@ -6895,7 +6929,8 @@ components:
|
|
|
6895
6929
|
type: object
|
|
6896
6930
|
description: |-
|
|
6897
6931
|
Request body for `POST /v1/flows/{_id}/{_stepId}/retry`. Re-runs the per-record data snapshot
|
|
6898
|
-
captured at the moment each error occurred.
|
|
6932
|
+
captured at the moment each error occurred. Submitting it resolves the targeted errors at once; a
|
|
6933
|
+
record that fails again comes back as a new open error.
|
|
6899
6934
|
Target the records one of two ways: list their snapshot keys in `retryDataKeys`, or set
|
|
6900
6935
|
`selectAll: true` with a `lastErrorAt` high-water mark to retry every retriable open error on the
|
|
6901
6936
|
step without enumerating keys.
|
|
@@ -7319,11 +7354,15 @@ components:
|
|
|
7319
7354
|
type: string
|
|
7320
7355
|
readOnly: true
|
|
7321
7356
|
description: |-
|
|
7322
|
-
|
|
7323
|
-
and the account-level logging preference
|
|
7324
|
-
`
|
|
7357
|
+
Execution-logging level the run captured at, resolved from the flow's `logging.mode`,
|
|
7358
|
+
an open debug window (`logging.debugUntil`) and the account-level logging preference:
|
|
7359
|
+
`basic`, `detailed`, or `debug` while a debug window is open. Not set on a run that
|
|
7360
|
+
captured no execution logs, such as one that ran while the account-level preference
|
|
7361
|
+
was off.
|
|
7325
7362
|
examples:
|
|
7326
7363
|
- basic
|
|
7364
|
+
- detailed
|
|
7365
|
+
- debug
|
|
7327
7366
|
__lastPageGeneratorJob:
|
|
7328
7367
|
type: boolean
|
|
7329
7368
|
readOnly: true
|
|
@@ -7387,9 +7426,9 @@ components:
|
|
|
7387
7426
|
`GET /v1/flows/{_id}/{_stepId}/{retryDataKey}/data` and accepted (full-replace) by the PUT on the
|
|
7388
7427
|
same path.
|
|
7389
7428
|
|
|
7390
|
-
The `data` field carries the
|
|
7391
|
-
adaptor-specific. The surrounding fields identify where in the
|
|
7392
|
-
how the record was structured.
|
|
7429
|
+
The `data` field carries the record as it reached the failing step, which a retry runs through
|
|
7430
|
+
that step again — its shape is adaptor-specific. The surrounding fields identify where in the
|
|
7431
|
+
pipeline the failure happened and how the record was structured.
|
|
7393
7432
|
properties:
|
|
7394
7433
|
retryDataKey:
|
|
7395
7434
|
type: string
|
|
@@ -7398,13 +7437,16 @@ components:
|
|
|
7398
7437
|
- 5f8d43a1b9e5a80011a35f2d-rdk-0
|
|
7399
7438
|
data:
|
|
7400
7439
|
description: |-
|
|
7401
|
-
The
|
|
7402
|
-
|
|
7440
|
+
The record as it reached the step. On an HTTP import it is the incoming record, before the
|
|
7441
|
+
import's mappings — not the request body the import sent or the response it got back — and a
|
|
7442
|
+
retry maps it again with the import's current mappings, so a mapping fix reaches the retried
|
|
7443
|
+
record. Shape varies by adaptor.
|
|
7403
7444
|
additionalProperties: true
|
|
7404
7445
|
stage:
|
|
7405
7446
|
type: string
|
|
7406
7447
|
description: Pipeline stage where the record was when the error occurred.
|
|
7407
7448
|
examples:
|
|
7449
|
+
- page_processor_import
|
|
7408
7450
|
- importMappingExtract
|
|
7409
7451
|
pgExportId:
|
|
7410
7452
|
type: string
|
|
@@ -7630,6 +7672,10 @@ components:
|
|
|
7630
7672
|
`missing_required_field` even though the field is present. When a tagging scheme needs
|
|
7631
7673
|
more dimensions than 3 tags allow, encode the extra dimensions in the tag names rather
|
|
7632
7674
|
than adding tags.
|
|
7675
|
+
- |-
|
|
7676
|
+
Send each error as `{id, rdk}`, and never add the error's trace key (`tk`) beside `rdk`:
|
|
7677
|
+
that fails the request with 400 `invalid_fields` ("Please provide either retryDataKey or
|
|
7678
|
+
traceKey and not both for the error id.").
|
|
7633
7679
|
properties:
|
|
7634
7680
|
errors:
|
|
7635
7681
|
type: array
|
|
@@ -7647,7 +7693,10 @@ components:
|
|
|
7647
7693
|
- 5f8d43a1b9e5a80011a35f2d-0
|
|
7648
7694
|
rdk:
|
|
7649
7695
|
type: string
|
|
7650
|
-
description:
|
|
7696
|
+
description: |-
|
|
7697
|
+
Retry data key (`retryDataKey` from the listing). Required when the error has one: an
|
|
7698
|
+
entry without it fails with 404 `invalid_errorid`. Send an empty string, or omit it,
|
|
7699
|
+
only when the error has none.
|
|
7651
7700
|
examples:
|
|
7652
7701
|
- 5f8d43a1b9e5a80011a35f2d-rdk-0
|
|
7653
7702
|
required:
|
package/dist/iclient.yml
CHANGED
|
@@ -324,7 +324,9 @@ paths:
|
|
|
324
324
|
account: every update must include the full JSON key. An Azure
|
|
325
325
|
service principal keeps its stored `clientSecret` or `certificate`
|
|
326
326
|
when the field is omitted — only a new value replaces it, and
|
|
327
|
-
`certificate` is never returned.
|
|
327
|
+
`certificate` is never returned. Connections work the other way:
|
|
328
|
+
re-sending the mask on `PUT /v1/connections/{_id}` clears the stored
|
|
329
|
+
credential.
|
|
328
330
|
operationId: updateIClient
|
|
329
331
|
tags:
|
|
330
332
|
- iClients
|
|
@@ -487,8 +489,9 @@ paths:
|
|
|
487
489
|
x-internal: false
|
|
488
490
|
summary: Delete an iClient
|
|
489
491
|
description: |-
|
|
490
|
-
Permanently deletes an iClient. Blocked
|
|
491
|
-
|
|
492
|
+
Permanently deletes an iClient. Blocked while any connection references
|
|
493
|
+
it, including a deleted connection still in the recycle bin: purge that
|
|
494
|
+
connection with `DELETE /v1/recycleBinTTL/connections/{_id}` first.
|
|
492
495
|
operationId: deleteIClient
|
|
493
496
|
tags:
|
|
494
497
|
- iClients
|
|
@@ -508,7 +511,20 @@ paths:
|
|
|
508
511
|
'404':
|
|
509
512
|
$ref: '#/components/responses/404-not-found'
|
|
510
513
|
'422':
|
|
511
|
-
|
|
514
|
+
description: |-
|
|
515
|
+
A connection still references the iClient. A deleted connection in the
|
|
516
|
+
recycle bin counts until it is purged.
|
|
517
|
+
content:
|
|
518
|
+
application/json:
|
|
519
|
+
schema:
|
|
520
|
+
$ref: '#/components/schemas/Error'
|
|
521
|
+
examples:
|
|
522
|
+
referencedByBinnedConnection:
|
|
523
|
+
summary: A deleted connection still in the recycle bin references the iClient
|
|
524
|
+
value:
|
|
525
|
+
errors:
|
|
526
|
+
- code: delete_not_allowed
|
|
527
|
+
message: 'this document is referenced by Connection : 6a1b2c3d4e5f60718293a4b5'
|
|
512
528
|
/v1/iclients/{_id}/dependencies:
|
|
513
529
|
get:
|
|
514
530
|
x-internal: false
|
|
@@ -1366,7 +1382,7 @@ components:
|
|
|
1366
1382
|
It is used in OAuth 2.0 authorization flows to receive authorization codes or
|
|
1367
1383
|
access tokens securely.
|
|
1368
1384
|
examples:
|
|
1369
|
-
- https://
|
|
1385
|
+
- https://integrator.io/connection/oauth2callback
|
|
1370
1386
|
- https://client.example.com/callback
|
|
1371
1387
|
- https://app.example.com/oauth2/callback
|
|
1372
1388
|
- https://localhost:8080/auth/callback
|
|
@@ -2165,7 +2181,7 @@ components:
|
|
|
2165
2181
|
- |-
|
|
2166
2182
|
## IMPLEMENTATION GUIDANCE:
|
|
2167
2183
|
- Provide the plain password value here to set/update it.
|
|
2168
|
-
- To keep the
|
|
2184
|
+
- To keep the stored password on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
|
|
2169
2185
|
- |-
|
|
2170
2186
|
Use `password` for the OAuth2 password value used with the password grant;
|
|
2171
2187
|
this is the value provided to configure or update the iClient,
|
|
@@ -3166,7 +3182,7 @@ components:
|
|
|
3166
3182
|
- |-
|
|
3167
3183
|
## IMPLEMENTATION GUIDANCE:
|
|
3168
3184
|
- Provide the plaintext consumer key here to set/update it.
|
|
3169
|
-
- To keep the
|
|
3185
|
+
- To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
|
|
3170
3186
|
- |-
|
|
3171
3187
|
Set the NetSuite consumer key value used for authentication;
|
|
3172
3188
|
provide this value to configure or update the iClient.
|
|
@@ -3192,7 +3208,7 @@ components:
|
|
|
3192
3208
|
- |-
|
|
3193
3209
|
## IMPLEMENTATION GUIDANCE:
|
|
3194
3210
|
- Provide the plaintext consumer secret here to set/update it.
|
|
3195
|
-
- To keep the
|
|
3211
|
+
- To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
|
|
3196
3212
|
- |-
|
|
3197
3213
|
The NetSuite consumer secret value used for authentication;
|
|
3198
3214
|
provide this value to configure or update the iClient.
|
|
@@ -3336,7 +3352,7 @@ components:
|
|
|
3336
3352
|
- |-
|
|
3337
3353
|
## IMPLEMENTATION GUIDANCE:
|
|
3338
3354
|
- Provide the plain client secret value here to set/update it.
|
|
3339
|
-
- To keep the
|
|
3355
|
+
- To keep the stored secret on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
|
|
3340
3356
|
- |-
|
|
3341
3357
|
Use the Salesforce OAuth **client secret** value to configure or update the Salesforce iClient;
|
|
3342
3358
|
integrator.io stores this secret encrypted at rest internally (for example as
|
|
@@ -3425,7 +3441,7 @@ components:
|
|
|
3425
3441
|
- |-
|
|
3426
3442
|
## IMPLEMENTATION GUIDANCE:
|
|
3427
3443
|
- Provide the plaintext private key value here to set/update it (often PEM formatted).
|
|
3428
|
-
- To keep the
|
|
3444
|
+
- To keep the stored private key on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
|
|
3429
3445
|
- |-
|
|
3430
3446
|
Set the Salesforce private key value used for authentication flows such as JWT
|
|
3431
3447
|
bearer token OAuth;
|
|
@@ -3693,7 +3709,7 @@ components:
|
|
|
3693
3709
|
- |-
|
|
3694
3710
|
## IMPLEMENTATION GUIDANCE:
|
|
3695
3711
|
- Provide the plaintext certificate ID value here to set/update it.
|
|
3696
|
-
- To keep the
|
|
3712
|
+
- To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
|
|
3697
3713
|
- |-
|
|
3698
3714
|
Use the eBay certificate ID value for authentication;
|
|
3699
3715
|
this is the value you provide to configure or update the iClient. integrator.io
|
|
@@ -3906,7 +3922,7 @@ components:
|
|
|
3906
3922
|
- |-
|
|
3907
3923
|
## IMPLEMENTATION GUIDANCE:
|
|
3908
3924
|
- Provide the plaintext secret key value here to set/update it.
|
|
3909
|
-
- To keep the
|
|
3925
|
+
- To keep the stored value on a PUT, re-send `"******"` (the masked value GET returns) unchanged; never omit this field to keep it.
|
|
3910
3926
|
- |-
|
|
3911
3927
|
Use the Amazon MWS secret key value for authentication;
|
|
3912
3928
|
provide this value to configure or update the iClient.
|
|
@@ -4555,18 +4571,5 @@ components:
|
|
|
4555
4571
|
errors:
|
|
4556
4572
|
- code: not_found
|
|
4557
4573
|
message: The requested resource was not found.
|
|
4558
|
-
422-unprocessable-entity:
|
|
4559
|
-
description: |
|
|
4560
|
-
Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
|
|
4561
|
-
content:
|
|
4562
|
-
application/json:
|
|
4563
|
-
schema:
|
|
4564
|
-
$ref: '#/components/schemas/Error'
|
|
4565
|
-
examples:
|
|
4566
|
-
default:
|
|
4567
|
-
value:
|
|
4568
|
-
errors:
|
|
4569
|
-
- code: unprocessable_entity
|
|
4570
|
-
message: The request could not be processed due to a semantic error.
|
|
4571
4574
|
x-enable-proxy: true
|
|
4572
4575
|
x-internal: false
|
package/dist/job.yml
CHANGED
|
@@ -1618,11 +1618,15 @@ components:
|
|
|
1618
1618
|
type: string
|
|
1619
1619
|
readOnly: true
|
|
1620
1620
|
description: |-
|
|
1621
|
-
|
|
1622
|
-
and the account-level logging preference
|
|
1623
|
-
`
|
|
1621
|
+
Execution-logging level the run captured at, resolved from the flow's `logging.mode`,
|
|
1622
|
+
an open debug window (`logging.debugUntil`) and the account-level logging preference:
|
|
1623
|
+
`basic`, `detailed`, or `debug` while a debug window is open. Not set on a run that
|
|
1624
|
+
captured no execution logs, such as one that ran while the account-level preference
|
|
1625
|
+
was off.
|
|
1624
1626
|
examples:
|
|
1625
1627
|
- basic
|
|
1628
|
+
- detailed
|
|
1629
|
+
- debug
|
|
1626
1630
|
__lastPageGeneratorJob:
|
|
1627
1631
|
type: boolean
|
|
1628
1632
|
readOnly: true
|
|
@@ -1924,13 +1928,13 @@ components:
|
|
|
1924
1928
|
numResolvedByAuto:
|
|
1925
1929
|
type: integer
|
|
1926
1930
|
minimum: 0
|
|
1927
|
-
description: Errors
|
|
1931
|
+
description: Errors the platform resolved automatically.
|
|
1928
1932
|
examples:
|
|
1929
1933
|
- 7
|
|
1930
1934
|
numResolvedByUser:
|
|
1931
1935
|
type: integer
|
|
1932
1936
|
minimum: 0
|
|
1933
|
-
description: Errors
|
|
1937
|
+
description: Errors a user resolved.
|
|
1934
1938
|
examples:
|
|
1935
1939
|
- 0
|
|
1936
1940
|
avgRuntime:
|