@celigo/api-specs 0.2.150 → 0.2.152
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/api.yml +17 -4
- package/dist/connection.yml +17 -4
- package/dist/enduser.yml +17 -4
- package/dist/export.yml +111 -61
- package/dist/flow.yml +17 -8
- package/dist/guardrail.yml +23 -16
- package/dist/import.yml +23 -16
- package/dist/mcp-server.yml +17 -4
- package/dist/tool.yml +140 -76
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/tool.yml
CHANGED
|
@@ -8543,7 +8543,12 @@ components:
|
|
|
8543
8543
|
type: boolean
|
|
8544
8544
|
description: |
|
|
8545
8545
|
When true, uses iClient-managed OAuth credentials (clientId/clientSecret)
|
|
8546
|
-
instead of the values in this configuration.
|
|
8546
|
+
instead of the values in this configuration. The iClient is the connection's
|
|
8547
|
+
`_iClientId` — on an HTTP connection `http._iClientId`, beside `auth`, not inside it —
|
|
8548
|
+
and it also supplies the grant type and the authorization and token endpoints, so a
|
|
8549
|
+
create needs only `auth.type: "oauth"`, `auth.oauth.useIClientFields: true` and the
|
|
8550
|
+
iClient id. The connection holds no tokens until a person completes the authorization
|
|
8551
|
+
in a browser.
|
|
8547
8552
|
oauth1:
|
|
8548
8553
|
type: object
|
|
8549
8554
|
description: |-
|
|
@@ -8672,7 +8677,7 @@ components:
|
|
|
8672
8677
|
x-celigo-ai-guidance:
|
|
8673
8678
|
- |-
|
|
8674
8679
|
## OAUTH 2.0 GRANT TYPES
|
|
8675
|
-
- "
|
|
8680
|
+
- "authorizecode" — Authorization Code flow (browser-based user consent).
|
|
8676
8681
|
Requires authURI, tokenURI, and user authorization via browser.
|
|
8677
8682
|
- "clientcredentials" — Client Credentials flow (server-to-server, no user).
|
|
8678
8683
|
Requires tokenURI, clientId, clientSecret.
|
|
@@ -9263,7 +9268,11 @@ components:
|
|
|
9263
9268
|
description: |
|
|
9264
9269
|
The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
|
|
9265
9270
|
On update, the mask sent back keeps the stored token; a new value replaces it.
|
|
9266
|
-
Required unless automatic token refresh is configured
|
|
9271
|
+
Required unless automatic token refresh is configured: a token block without a
|
|
9272
|
+
token must carry a `refreshMethod`, so a create or update that sends neither fails
|
|
9273
|
+
with 422 `Expected field: refreshMethod to be present.` To create a static-token
|
|
9274
|
+
connection before the real token is available, send a placeholder value and
|
|
9275
|
+
replace it later.
|
|
9267
9276
|
examples:
|
|
9268
9277
|
- my-api-token-EXAMPLE
|
|
9269
9278
|
location:
|
|
@@ -11469,7 +11478,11 @@ components:
|
|
|
11469
11478
|
description: |
|
|
11470
11479
|
The API key or bearer token value (encrypted at rest); returned masked as `"******"`.
|
|
11471
11480
|
On update, the mask sent back keeps the stored token; a new value replaces it.
|
|
11472
|
-
Required unless automatic token refresh is configured
|
|
11481
|
+
Required unless automatic token refresh is configured: a token block without a
|
|
11482
|
+
token must carry a `refreshMethod`, so a create or update that sends neither fails
|
|
11483
|
+
with 422 `Expected field: refreshMethod to be present.` To create a static-token
|
|
11484
|
+
connection before the real token is available, send a placeholder value and
|
|
11485
|
+
replace it later.
|
|
11473
11486
|
examples:
|
|
11474
11487
|
- my-api-token-EXAMPLE
|
|
11475
11488
|
location:
|
|
@@ -22380,12 +22393,17 @@ components:
|
|
|
22380
22393
|
run at `default` regardless of what's set here.
|
|
22381
22394
|
output:
|
|
22382
22395
|
type: object
|
|
22383
|
-
description:
|
|
22396
|
+
description: |-
|
|
22397
|
+
Output format configuration. A guardrail stores `format` but doesn't use it: the
|
|
22398
|
+
request to the model always carries the guardrail's own `validation_result` JSON
|
|
22399
|
+
schema (`flagged`, `reasoning`, `confidence`), and the result returns `flagged` and
|
|
22400
|
+
`reasoning` whatever `format` holds.
|
|
22384
22401
|
properties:
|
|
22385
22402
|
format:
|
|
22386
22403
|
type: object
|
|
22387
22404
|
description: |
|
|
22388
|
-
|
|
22405
|
+
Stored output structure. The request to the model uses the guardrail's own
|
|
22406
|
+
verdict schema instead (see `output`).
|
|
22389
22407
|
properties:
|
|
22390
22408
|
type:
|
|
22391
22409
|
type: string
|
|
@@ -22394,10 +22412,10 @@ components:
|
|
|
22394
22412
|
- json_schema
|
|
22395
22413
|
- blob
|
|
22396
22414
|
x-enumDescriptions:
|
|
22397
|
-
text:
|
|
22398
|
-
json_schema:
|
|
22399
|
-
blob:
|
|
22400
|
-
description: Output format type.
|
|
22415
|
+
text: Stored format type; the model request still uses the guardrail's verdict schema.
|
|
22416
|
+
json_schema: A stored JSON schema (`jsonSchema`); the model request still uses the guardrail's verdict schema.
|
|
22417
|
+
blob: Stored format type; the model request still uses the guardrail's verdict schema.
|
|
22418
|
+
description: Output format type, as stored.
|
|
22401
22419
|
schemaMode:
|
|
22402
22420
|
type: string
|
|
22403
22421
|
enum:
|
|
@@ -22407,9 +22425,9 @@ components:
|
|
|
22407
22425
|
manual: The schema editor opens `jsonSchema` in the visual field-by-field view
|
|
22408
22426
|
json: The schema editor opens `jsonSchema` in the raw JSON view
|
|
22409
22427
|
description: |-
|
|
22410
|
-
Which view a schema editor opens `jsonSchema` in
|
|
22411
|
-
|
|
22412
|
-
|
|
22428
|
+
Which view a schema editor opens `jsonSchema` in. Stored and echoed on
|
|
22429
|
+
guardrails for parity with the AI-agent format block — the guardrail form
|
|
22430
|
+
does not set it today, and neither view changes the model request.
|
|
22413
22431
|
x-celigo-ai-guidance:
|
|
22414
22432
|
- |-
|
|
22415
22433
|
Resend the stored value on every update — a full PUT that omits the field
|
|
@@ -22421,18 +22439,20 @@ components:
|
|
|
22421
22439
|
x-celigo-ui-override: Required by the AI agent form when output format type is json_schema. Encoded here to mirror the form so builders produce connectable configurations.
|
|
22422
22440
|
strict:
|
|
22423
22441
|
type: boolean
|
|
22424
|
-
description:
|
|
22442
|
+
description: Stored strict-validation flag for `jsonSchema`. A guardrail's model request uses its own verdict schema, so this doesn't apply there.
|
|
22425
22443
|
x-celigo-ai-guidance:
|
|
22426
|
-
-
|
|
22444
|
+
- Stored only on a guardrail; it doesn't change the guardrail's verdict.
|
|
22427
22445
|
jsonSchema:
|
|
22428
22446
|
type: object
|
|
22429
22447
|
description: |
|
|
22430
|
-
JSON Schema
|
|
22448
|
+
Stored JSON Schema. Required when `format.type` is "json_schema". A guardrail
|
|
22449
|
+
doesn't send it to the model; the request carries the `validation_result`
|
|
22450
|
+
verdict schema instead.
|
|
22431
22451
|
x-celigo-ui-override: Required by the AI agent form when output format type is json_schema. Encoded here to mirror the form so builders produce connectable configurations.
|
|
22432
22452
|
properties:
|
|
22433
22453
|
type:
|
|
22434
22454
|
type: string
|
|
22435
|
-
description: Root
|
|
22455
|
+
description: Root type of the stored JSON Schema.
|
|
22436
22456
|
enum:
|
|
22437
22457
|
- object
|
|
22438
22458
|
- array
|
|
@@ -22450,15 +22470,15 @@ components:
|
|
|
22450
22470
|
properties:
|
|
22451
22471
|
type: object
|
|
22452
22472
|
additionalProperties: true
|
|
22453
|
-
description:
|
|
22473
|
+
description: Field definitions in the stored JSON Schema.
|
|
22454
22474
|
required:
|
|
22455
22475
|
type: array
|
|
22456
|
-
description: Property names the
|
|
22476
|
+
description: Property names the stored JSON Schema marks as required.
|
|
22457
22477
|
items:
|
|
22458
22478
|
type: string
|
|
22459
22479
|
additionalproperties:
|
|
22460
22480
|
type: boolean
|
|
22461
|
-
description:
|
|
22481
|
+
description: Whether the stored JSON Schema allows properties beyond those in `properties`.
|
|
22462
22482
|
schema:
|
|
22463
22483
|
type: object
|
|
22464
22484
|
readOnly: true
|
|
@@ -25877,36 +25897,40 @@ components:
|
|
|
25877
25897
|
Delta:
|
|
25878
25898
|
type: object
|
|
25879
25899
|
description: |-
|
|
25880
|
-
Configures incremental exports that retrieve only records created or modified since the
|
|
25881
|
-
|
|
25882
|
-
|
|
25883
|
-
|
|
25884
|
-
|
|
25885
|
-
{{lastExportDateTime}} is the run's own timestamp
|
|
25886
|
-
|
|
25887
|
-
|
|
25888
|
-
|
|
25900
|
+
Configures incremental exports that retrieve only records created or modified since the
|
|
25901
|
+
flow's delta checkpoint; omit it for other export types. Adaptors that compare a record field
|
|
25902
|
+
name it in `dateField`, while HTTP exports and SQL queries carry {{lastExportDateTime}} in the
|
|
25903
|
+
request and save without a delta object. Each run's window runs from {{lastExportDateTime}}
|
|
25904
|
+
(the checkpoint) to {{currentExportDateTime}} (the time the run started). A first run is not a
|
|
25905
|
+
full export: with no `startDate`, its {{lastExportDateTime}} is the run's own timestamp, so it
|
|
25906
|
+
picks up no earlier changes. The checkpoint moves to a run's window end only when the run
|
|
25907
|
+
exports records, so a run that exports nothing leaves it where it was, and after a failed run
|
|
25908
|
+
the next run reuses the last checkpoint. On success, when `POST /v1/flows/{_id}/run` sends
|
|
25909
|
+
`export.endDate`, the flow's checkpoint is left at that value, so an end date in the past
|
|
25910
|
+
moves the next run's lower bound back.
|
|
25889
25911
|
x-celigo-ai-guidance:
|
|
25890
25912
|
- |-
|
|
25891
|
-
|
|
25892
|
-
|
|
25913
|
+
Omit this object for export types other than "delta". An HTTP export with type
|
|
25914
|
+
"delta" saves without it, since the request carries {{lastExportDateTime}}, but
|
|
25915
|
+
set ``startDate`` anyway: without it the first run's window is empty.
|
|
25893
25916
|
Delta exports are designed for efficient synchronization by retrieving only
|
|
25894
25917
|
records that have been created or modified since the last execution.
|
|
25895
25918
|
- |-
|
|
25896
25919
|
## REQUIRED FIELDS
|
|
25897
25920
|
- ``startDate`` -- the initial cutoff timestamp the platform uses on the
|
|
25898
25921
|
first run (and as the floor for ``{{lastExportDateTime}}`` thereafter).
|
|
25899
|
-
|
|
25900
|
-
|
|
25901
|
-
|
|
25902
|
-
delta
|
|
25922
|
+
Without it, a new flow's first run renders ``{{lastExportDateTime}}`` as
|
|
25923
|
+
the run's own time, so the first run exports nothing (verified on HTTP
|
|
25924
|
+
and RDBMS delta exports). Adapter-specific validators (e.g. NetSuite's
|
|
25925
|
+
``transformTwoDotZero``) reject delta configs that omit ``startDate``
|
|
25926
|
+
with ``missing_delta_startDate``, so set it on every delta export.
|
|
25903
25927
|
- |-
|
|
25904
25928
|
## DEFAULT CUTOFF BEHAVIOR (NO USER-SUPPLIED CUTOFF)
|
|
25905
25929
|
When the user prompt does not specify an explicit cutoff timestamp,
|
|
25906
25930
|
default ``startDate`` to **today at midnight UTC** in ISO-8601 format
|
|
25907
25931
|
(e.g. ``"2026-05-14T00:00:00.000Z"``). This means the first run picks
|
|
25908
25932
|
up records changed today; subsequent runs use the platform-managed
|
|
25909
|
-
``{{lastExportDateTime}}`` (the last
|
|
25933
|
+
``{{lastExportDateTime}}`` (the end of the last run that exported records).
|
|
25910
25934
|
|
|
25911
25935
|
- First run: filters records changed since ``startDate``.
|
|
25912
25936
|
- Subsequent runs: uses ``{{lastExportDateTime}}`` as the lower bound;
|
|
@@ -25919,18 +25943,28 @@ components:
|
|
|
25919
25943
|
- For HTTP exports: Use {{lastExportDateTime}} variable in relativeURI or body
|
|
25920
25944
|
- For specific application adapters: Use dateField to specify timestamp fields
|
|
25921
25945
|
|
|
25922
|
-
2. The system automatically maintains the
|
|
25946
|
+
2. The system automatically maintains the checkpoint
|
|
25923
25947
|
- No need to store or manage timestamps in your own code
|
|
25924
25948
|
- A first run without ``startDate`` fetches nothing older than the run itself
|
|
25925
|
-
-
|
|
25949
|
+
- A run that exports records moves the checkpoint to its window end
|
|
25950
|
+
({{currentExportDateTime}}), where the next run starts
|
|
25951
|
+
- Use {{lastExportDateTime}} as the lower bound; {{currentExportDateTime}} as the
|
|
25952
|
+
lower bound asks for records changed after the run started, so every run exports nothing
|
|
25926
25953
|
|
|
25927
25954
|
3. Error handling and recovery:
|
|
25928
25955
|
- If an export fails, the next run uses the last successful timestamp
|
|
25929
25956
|
- Records created/modified during a failed run will be included in the next run
|
|
25957
|
+
- A run that exports nothing leaves the checkpoint where it was, so after a stretch of
|
|
25958
|
+
empty runs the next run that finds records reaches back to the last run that exported
|
|
25959
|
+
any: once the cause is fixed, no backfill run is needed
|
|
25960
|
+
- A run given its own window (export.startDate / export.endDate on
|
|
25961
|
+
POST /v1/flows/{_id}/run) that exports records leaves the checkpoint at endDate,
|
|
25962
|
+
even a past one, so the next run re-reads everything after it
|
|
25930
25963
|
- The lagOffset field can be used to handle edge cases
|
|
25931
25964
|
- |-
|
|
25932
|
-
|
|
25933
|
-
|
|
25965
|
+
Omit this object for export types other than "delta". An HTTP export with type
|
|
25966
|
+
"delta" saves without it, since the request carries {{lastExportDateTime}}, but
|
|
25967
|
+
set ``startDate`` anyway: without it the first run's window is empty.
|
|
25934
25968
|
Delta exports are designed for efficient synchronization by retrieving only
|
|
25935
25969
|
records that have been created or modified since the last execution.
|
|
25936
25970
|
properties:
|
|
@@ -25946,8 +25980,9 @@ components:
|
|
|
25946
25980
|
If the flow's own downstream steps update the exported records, add export criteria
|
|
25947
25981
|
that exclude already-processed records (or use a creation-time field for process-once
|
|
25948
25982
|
flows) so each run doesn't re-export what the previous run wrote. Not supported on
|
|
25949
|
-
HTTP exports: embed {{lastExportDateTime}} in the relativeURI or body instead;
|
|
25950
|
-
|
|
25983
|
+
HTTP exports: embed {{lastExportDateTime}} in the relativeURI or body instead; an HTTP
|
|
25984
|
+
export saved with dateField is refused with 422 "Unsupported dateField in
|
|
25985
|
+
export.delta.dateField". For Salesforce this
|
|
25951
25986
|
field is required and defaults to the standard timestamp fields (LastModifiedDate,
|
|
25952
25987
|
CreatedDate, SystemModstamp, LastActivityDate, LastViewedDate, LastReferencedDate) plus
|
|
25953
25988
|
any custom timestamp fields.
|
|
@@ -25986,7 +26021,8 @@ components:
|
|
|
25986
26021
|
###CRITICAL ADAPTOR-SPECIFIC INSTRUCTION:
|
|
25987
26022
|
- The adaptor type is HTTP. For HTTP exports, the "dateField" property MUST NOT be included in the delta configuration.
|
|
25988
26023
|
- HTTP exports use the {{lastExportDateTime}} variable directly in the relativeURI or body instead of dateField.
|
|
25989
|
-
- DO NOT include "dateField" in your response. If you include it, the
|
|
26024
|
+
- DO NOT include "dateField" in your response. If you include it, the save is refused with
|
|
26025
|
+
422 "Unsupported dateField in export.delta.dateField".
|
|
25990
26026
|
|
|
25991
26027
|
Example HTTP query with implicit delta:
|
|
25992
26028
|
```
|
|
@@ -26046,10 +26082,10 @@ components:
|
|
|
26046
26082
|
dateFormat:
|
|
26047
26083
|
type: string
|
|
26048
26084
|
description: |-
|
|
26049
|
-
Moment.js format string applied to
|
|
26050
|
-
|
|
26051
|
-
|
|
26052
|
-
widening the filter window.
|
|
26085
|
+
Moment.js format string applied to both delta variables, {{lastExportDateTime}} and
|
|
26086
|
+
{{currentExportDateTime}}, in HTTP requests and SQL queries alike. Leave unset unless the
|
|
26087
|
+
source system requires a non-ISO8601 format; by default both render as ISO 8601 UTC with
|
|
26088
|
+
milliseconds. Date-only formats truncate the time portion, widening the filter window.
|
|
26053
26089
|
x-celigo-ai-guidance:
|
|
26054
26090
|
- Defines the date/time format expected by the source system's API.
|
|
26055
26091
|
- |-
|
|
@@ -26060,7 +26096,8 @@ components:
|
|
|
26060
26096
|
- OPTIONAL: Only needed when the source system doesn't support ISO8601
|
|
26061
26097
|
- Default: ISO8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)
|
|
26062
26098
|
- Uses Moment.js formatting tokens
|
|
26063
|
-
-
|
|
26099
|
+
- Formats both {{lastExportDateTime}} and {{currentExportDateTime}}, in HTTP requests and in
|
|
26100
|
+
SQL queries (an RDBMS delta query receives the formatted value as a quoted literal)
|
|
26064
26101
|
- |-
|
|
26065
26102
|
## IMPLEMENTATION PATTERNS
|
|
26066
26103
|
|
|
@@ -26144,13 +26181,15 @@ components:
|
|
|
26144
26181
|
format: date-time
|
|
26145
26182
|
description: |-
|
|
26146
26183
|
Lower-bound cutoff for the first run. Omitting it doesn't export history: the first run
|
|
26147
|
-
then starts at its own timestamp. Set it to the earliest change the first
|
|
26148
|
-
up.
|
|
26184
|
+
then starts at its own timestamp, an empty window. Set it to the earliest change the first
|
|
26185
|
+
run should pick up. Later runs start from the flow's checkpoint, the end of the last run
|
|
26186
|
+
that exported records.
|
|
26149
26187
|
x-celigo-ai-guidance:
|
|
26150
26188
|
- |-
|
|
26151
26189
|
Initial cutoff timestamp for the first export run, in ISO-8601 UTC format (e.g.
|
|
26152
26190
|
``"2026-05-14T00:00:00.000Z"``).
|
|
26153
|
-
|
|
26191
|
+
Set it on every delta export: without it the first run's window is empty (verified
|
|
26192
|
+
on HTTP and RDBMS delta exports), and adapter-specific validators reject delta
|
|
26154
26193
|
configs without it (e.g.
|
|
26155
26194
|
NetSuite returns ``missing_delta_startDate`` from the ``transformTwoDotZero`` processor).
|
|
26156
26195
|
- |-
|
|
@@ -26162,10 +26201,11 @@ components:
|
|
|
26162
26201
|
flow is being authored.
|
|
26163
26202
|
- |-
|
|
26164
26203
|
## SUBSEQUENT RUNS
|
|
26165
|
-
After the first
|
|
26166
|
-
|
|
26167
|
-
|
|
26168
|
-
|
|
26204
|
+
After the first run that exports records, the platform keeps the
|
|
26205
|
+
flow's checkpoint at the end of the last run that exported records
|
|
26206
|
+
and exposes it as ``{{lastExportDateTime}}``; runs that export
|
|
26207
|
+
nothing leave it unchanged. ``startDate`` becomes the floor used
|
|
26208
|
+
only when the platform timestamp is absent (e.g. after a reset).
|
|
26169
26209
|
- |-
|
|
26170
26210
|
## EXAMPLES
|
|
26171
26211
|
- ``"2026-05-14T00:00:00.000Z"`` -- today at midnight UTC.
|
|
@@ -26174,7 +26214,8 @@ components:
|
|
|
26174
26214
|
- |-
|
|
26175
26215
|
Initial cutoff timestamp for the first export run, in ISO-8601 UTC format (e.g.
|
|
26176
26216
|
``"2026-05-14T00:00:00.000Z"``).
|
|
26177
|
-
|
|
26217
|
+
Set it on every delta export: without it the first run's window is empty (verified
|
|
26218
|
+
on HTTP and RDBMS delta exports), and adapter-specific validators reject delta
|
|
26178
26219
|
configs without it (e.g.
|
|
26179
26220
|
NetSuite returns ``missing_delta_startDate`` from the ``transformTwoDotZero`` processor).
|
|
26180
26221
|
examples:
|
|
@@ -26315,7 +26356,7 @@ components:
|
|
|
26315
26356
|
- exported_to_netsuite
|
|
26316
26357
|
Webhook:
|
|
26317
26358
|
type: object
|
|
26318
|
-
description: Configuration for webhook listeners that receive data through incoming HTTP requests. Required when the export's `type` is `webhook`; omit for other export types.
|
|
26359
|
+
description: Configuration for webhook listeners that receive data through incoming HTTP requests. Required when the export's `type` is `webhook`; omit for other export types. Senders POST to the export's listener URL, `https://api.integrator.io/v1/exports/{_id}/data` (or the same path on the account's regional API host); the platform validates each request using the configured `verify` method, passes the payload to subsequent flow steps, and returns a configurable HTTP response to the caller. A request is answered 204 by default when accepted, 401 when it fails verification, and 403 `unable_to_run_flows` while every flow the export feeds is disabled; a refused request is not queued, so the sender must resend it.
|
|
26319
26360
|
x-celigo-ai-guidance:
|
|
26320
26361
|
- Configuration object for real-time event listeners that receive data via incoming HTTP requests.
|
|
26321
26362
|
- |-
|
|
@@ -26689,7 +26730,7 @@ components:
|
|
|
26689
26730
|
- sha1
|
|
26690
26731
|
encoding:
|
|
26691
26732
|
type: string
|
|
26692
|
-
description: Encoding of the HMAC signature value when `verify` is `hmac`. Must match the encoding the webhook sender uses — a mismatch causes requests to be rejected even when the signature is otherwise correct.
|
|
26733
|
+
description: 'Encoding of the HMAC signature value when `verify` is `hmac`. Must match the encoding the webhook sender uses — a mismatch causes requests to be rejected with a 401 even when the signature is otherwise correct. With `provider: custom`, `hex` is compared as lowercase hex: an uppercase hex signature is rejected.'
|
|
26693
26734
|
x-celigo-ai-guidance:
|
|
26694
26735
|
- Specifies the encoding format used for the HMAC signature in webhook requests.
|
|
26695
26736
|
- |-
|
|
@@ -26785,7 +26826,7 @@ components:
|
|
|
26785
26826
|
- 9d1a5c6b3e7d9f2a1c5b8e3aEXAMPLE
|
|
26786
26827
|
header:
|
|
26787
26828
|
type: string
|
|
26788
|
-
description: Name of the request header that carries the HMAC signature when `verify` is `hmac`. Must match the header name the webhook sender uses (header names are case-insensitive); requests without this header are rejected with a 401.
|
|
26829
|
+
description: 'Name of the request header that carries the HMAC signature when `verify` is `hmac`. Must match the header name the webhook sender uses (header names are case-insensitive); requests without this header are rejected with a 401. With `provider: custom` the header value must be the bare digest in the configured `encoding`: a value with a `sha256=` prefix is rejected with a 401.'
|
|
26789
26830
|
x-celigo-ai-guidance:
|
|
26790
26831
|
- Specifies the HTTP header name that contains the signature for HMAC verification.
|
|
26791
26832
|
- |-
|
|
@@ -26831,8 +26872,9 @@ components:
|
|
|
26831
26872
|
|
|
26832
26873
|
- The system will look for this exact header name in incoming requests
|
|
26833
26874
|
- If the header is not found, the request will be rejected with a 401 error
|
|
26834
|
-
- Some platforms
|
|
26835
|
-
|
|
26875
|
+
- Some platforms include a prefix in the header value (e.g., "sha256="). With
|
|
26876
|
+
provider "custom" it is not stripped: a prefixed signature is rejected with a 401,
|
|
26877
|
+
so the sender must send the bare digest
|
|
26836
26878
|
|
|
26837
26879
|
IMPORTANT: This must exactly match the header name used by the webhook sender.
|
|
26838
26880
|
If you're unsure about the correct header name, consult the sender's documentation
|
|
@@ -27907,11 +27949,12 @@ components:
|
|
|
27907
27949
|
- metadata
|
|
27908
27950
|
skipDelete:
|
|
27909
27951
|
type: boolean
|
|
27952
|
+
default: false
|
|
27910
27953
|
description: |-
|
|
27911
27954
|
When true, source files remain on the file server after processing; when false (the
|
|
27912
27955
|
default), files are deleted after successful processing. Files that fail processing are
|
|
27913
27956
|
never deleted, regardless of this setting. Enable retention when files must be processed
|
|
27914
|
-
by other flows or kept for compliance.
|
|
27957
|
+
by other flows or systems, or kept for compliance.
|
|
27915
27958
|
x-celigo-ai-guidance:
|
|
27916
27959
|
- |-
|
|
27917
27960
|
Controls whether source files are retained or deleted after successful processing.
|
|
@@ -28584,8 +28627,10 @@ components:
|
|
|
28584
28627
|
type: string
|
|
28585
28628
|
description: |-
|
|
28586
28629
|
Character sequence separating fields within each row; comma when omitted. Use "\t"
|
|
28587
|
-
for tab-delimited files; European-locale exports often use semicolons.
|
|
28588
|
-
delimiter
|
|
28630
|
+
for tab-delimited files; European-locale exports often use semicolons. A wrong
|
|
28631
|
+
delimiter doesn't fail the parse: with a header row, each row becomes one field named
|
|
28632
|
+
after the whole header line (`{"order_id;sku;qty": "1001;TEE-M;2"}`), so the failure
|
|
28633
|
+
shows up in later steps.
|
|
28589
28634
|
x-celigo-ai-guidance:
|
|
28590
28635
|
- |-
|
|
28591
28636
|
Specifies the character sequence that separates individual fields (columns)
|
|
@@ -31045,6 +31090,8 @@ components:
|
|
|
31045
31090
|
Controls how the export requests subsequent pages when the API returns multi-page responses. The `method` field determines which companion fields are required and how each next page is requested. For the page, skip, and token methods, reference the matching pagination variable (`{{export.http.paging.page}}`, `{{export.http.paging.skip}}`, or `{{export.http.paging.token}}`) in the relative URI or request body — misconfigured pagination is a common cause of incomplete data retrieval.
|
|
31046
31091
|
|
|
31047
31092
|
When this export is the first lookup of a builder-mode API with `pagination.enabled` set, it is that API's volume driver: saving the export (even unchanged) invalidates the API's issued cursors, so a caller mid-walk gets an empty final page, and removing `paging` is accepted on save but makes every call to the API fail with `400 api_pagination_source_not_paged` until paging is restored or the API's flag is turned off.
|
|
31093
|
+
|
|
31094
|
+
When a next page's response is identical to the previous one, paging stops: the export records an open error with code `page_response_error` ("Identical response received from next page request. No more page requests will be made.") and the run completes with the pages already read, so later pages are never exported. A request that doesn't change between pages produces this, as observed with `method: page` and the pagination variable missing from the relative URI and body; reference the variable so each request asks for the next page.
|
|
31048
31095
|
x-celigo-ai-guidance:
|
|
31049
31096
|
- Configuration object for navigating through multi-page API responses.
|
|
31050
31097
|
- |-
|
|
@@ -34015,19 +34062,25 @@ components:
|
|
|
34015
34062
|
description: |-
|
|
34016
34063
|
Directory on the same server where files are moved after successful export, giving you
|
|
34017
34064
|
an independent backup; if omitted, files are simply deleted from the source directory
|
|
34018
|
-
after successful export (Celigo also keeps its own copy
|
|
34019
|
-
period). Supports static paths or handlebars templates.
|
|
34065
|
+
after successful export unless `file.skipDelete` is true (Celigo also keeps its own copy
|
|
34066
|
+
of processed files for a set period). Supports static paths or handlebars templates.
|
|
34020
34067
|
x-celigo-ai-guidance:
|
|
34021
34068
|
- Optional directory where files are moved before deletion.
|
|
34022
34069
|
- |-
|
|
34023
34070
|
IMPORTANT:
|
|
34024
|
-
Celigo automatically deletes files from the source directory after successful export
|
|
34071
|
+
Celigo automatically deletes files from the source directory after successful export,
|
|
34072
|
+
unless `file.skipDelete` is true. Moving them to a backup directory also takes them out
|
|
34073
|
+
of the source directory, so when another system still reads them there, set
|
|
34074
|
+
`file.skipDelete: true` instead.
|
|
34025
34075
|
The backup directory is for users who want to maintain their own independent
|
|
34026
34076
|
backup of exported files.
|
|
34027
34077
|
Celigo also maintains its own backup of processed files for a set period of time.
|
|
34028
34078
|
- |-
|
|
34029
34079
|
IMPORTANT:
|
|
34030
|
-
Celigo automatically deletes files from the source directory after successful export
|
|
34080
|
+
Celigo automatically deletes files from the source directory after successful export,
|
|
34081
|
+
unless `file.skipDelete` is true. Moving them to a backup directory also takes them out
|
|
34082
|
+
of the source directory, so when another system still reads them there, set
|
|
34083
|
+
`file.skipDelete: true` instead.
|
|
34031
34084
|
The backup directory is for users who want to maintain their own independent
|
|
34032
34085
|
backup of exported files.
|
|
34033
34086
|
Celigo also maintains its own backup of processed files for a set period of time.
|
|
@@ -36499,19 +36552,26 @@ components:
|
|
|
36499
36552
|
description: |-
|
|
36500
36553
|
Bucket in the same region where files are moved after successful export, giving you an
|
|
36501
36554
|
independent backup; if omitted, files are simply deleted from the source bucket after
|
|
36502
|
-
successful export (Celigo also keeps its own copy of
|
|
36503
|
-
The connection's AWS credentials must have
|
|
36555
|
+
successful export unless `file.skipDelete` is true (Celigo also keeps its own copy of
|
|
36556
|
+
processed files for a set period). The connection's AWS credentials must have
|
|
36557
|
+
s3:PutObject permission on this bucket.
|
|
36504
36558
|
x-celigo-ai-guidance:
|
|
36505
36559
|
- Optional destination bucket where files are moved before deletion.
|
|
36506
36560
|
- |-
|
|
36507
36561
|
IMPORTANT:
|
|
36508
|
-
Celigo automatically deletes files from the source bucket after successful export
|
|
36562
|
+
Celigo automatically deletes files from the source bucket after successful export,
|
|
36563
|
+
unless `file.skipDelete` is true. Moving them to a backup bucket also takes them out of
|
|
36564
|
+
the source bucket, so when another system still reads them there, set
|
|
36565
|
+
`file.skipDelete: true` instead.
|
|
36509
36566
|
The backup bucket is for users who want to maintain their own independent backup
|
|
36510
36567
|
of exported files.
|
|
36511
36568
|
Celigo also maintains its own backup of processed files for a set period of time.
|
|
36512
36569
|
- |-
|
|
36513
36570
|
IMPORTANT:
|
|
36514
|
-
Celigo automatically deletes files from the source bucket after successful export
|
|
36571
|
+
Celigo automatically deletes files from the source bucket after successful export,
|
|
36572
|
+
unless `file.skipDelete` is true. Moving them to a backup bucket also takes them out of
|
|
36573
|
+
the source bucket, so when another system still reads them there, set
|
|
36574
|
+
`file.skipDelete: true` instead.
|
|
36515
36575
|
The backup bucket is for users who want to maintain their own independent backup
|
|
36516
36576
|
of exported files.
|
|
36517
36577
|
Celigo also maintains its own backup of processed files for a set period of time.
|
|
@@ -36967,7 +37027,9 @@ components:
|
|
|
36967
37027
|
`NetSuiteExport` and `NetSuiteHTTPExport` both need a `netsuite` connection).
|
|
36968
37028
|
Server-required unless `type` is `webhook` or `simple` (those receive data instead of
|
|
36969
37029
|
fetching it) or `adaptorType` is `TopicExport` (Event Streams listeners are delivered
|
|
36970
|
-
by the platform itself and must omit it).
|
|
37030
|
+
by the platform itself and must omit it). A `WebhookExport` saved without `type: webhook`
|
|
37031
|
+
is refused with 422 "_connectionId is required unless type is [webhook|simple]"; a webhook
|
|
37032
|
+
export that does carry a connection saves and updates normally.
|
|
36971
37033
|
examples:
|
|
36972
37034
|
- 60a2c4e6f321d800129a1a3c
|
|
36973
37035
|
adaptorType:
|
|
@@ -37088,9 +37150,11 @@ components:
|
|
|
37088
37150
|
description: |-
|
|
37089
37151
|
Operational mode of the export. When omitted, the export retrieves all available records —
|
|
37090
37152
|
the standard batch mode, which is also the right choice for parsing structured files
|
|
37091
|
-
(CSV/XML/JSON) into records.
|
|
37092
|
-
|
|
37093
|
-
|
|
37153
|
+
(CSV/XML/JSON) into records. Most modes take their matching configuration object (e.g. a
|
|
37154
|
+
`webhook` object when `type` is `webhook`); an HTTP or SQL `delta` export saves without a
|
|
37155
|
+
`delta` object because its request carries `{{lastExportDateTime}}`, though
|
|
37156
|
+
`delta.startDate` sets its first window. Use `blob` only to transfer raw files without
|
|
37157
|
+
parsing their contents.
|
|
37094
37158
|
x-celigo-ai-guidance:
|
|
37095
37159
|
- |-
|
|
37096
37160
|
## HOW TO PICK THE TYPE VALUE
|
package/package.json
CHANGED