@celigo/api-specs 0.2.110 → 0.2.111
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/export.yml +16 -29
- package/dist/tool.yml +15 -28
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/export.yml
CHANGED
|
@@ -7891,8 +7891,8 @@ components:
|
|
|
7891
7891
|
- Requires the "soql" object with query configuration
|
|
7892
7892
|
|
|
7893
7893
|
2. **Real-time Event Listeners** (type="distributed")
|
|
7894
|
-
- Responds to Salesforce
|
|
7895
|
-
-
|
|
7894
|
+
- Responds to Salesforce record creates, updates, and deletes as they happen
|
|
7895
|
+
- Fires through an Apex trigger on the object in the connected org (see `distributed`)
|
|
7896
7896
|
- Always appears as a "Listener" in the flow builder UI
|
|
7897
7897
|
- Requires the "distributed" object with event configuration
|
|
7898
7898
|
|
|
@@ -7957,7 +7957,7 @@ components:
|
|
|
7957
7957
|
- **Use Cases**: Real-time synchronization, event-driven integration
|
|
7958
7958
|
- **Dependencies**:
|
|
7959
7959
|
- Only uses REST API (api field is ignored)
|
|
7960
|
-
-
|
|
7960
|
+
- Depends on an Apex trigger on the object in the connected org: Integration Apps create it at installation; for a custom flow the customer deploys it from the export page's Required trigger code (see `distributed`)
|
|
7961
7961
|
- Only compatible with standard export type (ignores delta/test/once)
|
|
7962
7962
|
- |-
|
|
7963
7963
|
## IMPLEMENTATION CONSIDERATIONS
|
|
@@ -8421,34 +8421,21 @@ components:
|
|
|
8421
8421
|
- SELECT Id, Name, (SELECT Id, FirstName, LastName FROM Contacts) FROM Account
|
|
8422
8422
|
distributed:
|
|
8423
8423
|
type: object
|
|
8424
|
-
description: Real-time
|
|
8424
|
+
description: Real-time listener configuration; required when `type` is `distributed` and not used otherwise. Records reach the flow only when an Apex trigger on `sObjectType` in the connected org calls the Celigo package (`integrator_da__.RealTimeExporter.processExport()`) — no scheduling or manual execution is involved. Integration Apps create their triggers at installation; for a custom flow the customer deploys the trigger in Salesforce, starting from the code the export page shows under Required trigger.
|
|
8425
8425
|
x-celigo-ai-guidance:
|
|
8426
|
-
- Configuration for real-time Salesforce event-driven exports.
|
|
8427
8426
|
- |-
|
|
8428
|
-
|
|
8429
|
-
|
|
8430
|
-
|
|
8431
|
-
|
|
8432
|
-
|
|
8433
|
-
|
|
8434
|
-
|
|
8435
|
-
-
|
|
8436
|
-
|
|
8437
|
-
|
|
8438
|
-
|
|
8439
|
-
|
|
8440
|
-
- No scheduling or manual execution required
|
|
8441
|
-
- Triggered automatically when records change in Salesforce
|
|
8442
|
-
- Data flows in real-time as events occur
|
|
8443
|
-
- Uses Salesforce's platform events and streaming API
|
|
8444
|
-
- |-
|
|
8445
|
-
## TECHNICAL ARCHITECTURE
|
|
8446
|
-
|
|
8447
|
-
When configured, the system:
|
|
8448
|
-
1. Creates custom triggers in the connected Salesforce org
|
|
8449
|
-
2. Establishes event listeners for the specified objects
|
|
8450
|
-
3. Processes events as they occur (create/update/delete operations)
|
|
8451
|
-
4. Delivers the changed records to the integration flow
|
|
8427
|
+
After creating a listener on a custom flow, relay what the Help Center's "Listen for real-time data
|
|
8428
|
+
from Salesforce" states: an Apex trigger is required per sObject type and, for a custom flow, the
|
|
8429
|
+
customer creates it in Salesforce — copy the export page's Required trigger code, replace `<name>`,
|
|
8430
|
+
and save it under Setup → Object Manager → <object> → Triggers → New; deploying to production also
|
|
8431
|
+
needs a test class with 75% coverage. Integration Apps create their triggers at installation.
|
|
8432
|
+
- |-
|
|
8433
|
+
When a listener on an enabled flow never creates a job for a create, update, or delete, the
|
|
8434
|
+
Celigo-side causes are `distributed.disabled` true, an offline connection, and a qualifier the
|
|
8435
|
+
record does not satisfy — and any qualifier drops delete events (see `qualifier`). Also verify the
|
|
8436
|
+
Help Center's trigger requirement in the connected org: an active Apex trigger on the object whose
|
|
8437
|
+
code calls `integrator_da__.RealTimeExporter`, and the Celigo package reachable through the
|
|
8438
|
+
connection (`GET /v1/connections/{_id}/distributed`, documented in this spec set).
|
|
8452
8439
|
properties:
|
|
8453
8440
|
referencedFields:
|
|
8454
8441
|
type:
|
package/dist/tool.yml
CHANGED
|
@@ -31996,8 +31996,8 @@ components:
|
|
|
31996
31996
|
- Requires the "soql" object with query configuration
|
|
31997
31997
|
|
|
31998
31998
|
2. **Real-time Event Listeners** (type="distributed")
|
|
31999
|
-
- Responds to Salesforce
|
|
32000
|
-
-
|
|
31999
|
+
- Responds to Salesforce record creates, updates, and deletes as they happen
|
|
32000
|
+
- Fires through an Apex trigger on the object in the connected org (see `distributed`)
|
|
32001
32001
|
- Always appears as a "Listener" in the flow builder UI
|
|
32002
32002
|
- Requires the "distributed" object with event configuration
|
|
32003
32003
|
|
|
@@ -32062,7 +32062,7 @@ components:
|
|
|
32062
32062
|
- **Use Cases**: Real-time synchronization, event-driven integration
|
|
32063
32063
|
- **Dependencies**:
|
|
32064
32064
|
- Only uses REST API (api field is ignored)
|
|
32065
|
-
-
|
|
32065
|
+
- Depends on an Apex trigger on the object in the connected org: Integration Apps create it at installation; for a custom flow the customer deploys it from the export page's Required trigger code (see `distributed`)
|
|
32066
32066
|
- Only compatible with standard export type (ignores delta/test/once)
|
|
32067
32067
|
- |-
|
|
32068
32068
|
## IMPLEMENTATION CONSIDERATIONS
|
|
@@ -32526,34 +32526,21 @@ components:
|
|
|
32526
32526
|
- SELECT Id, Name, (SELECT Id, FirstName, LastName FROM Contacts) FROM Account
|
|
32527
32527
|
distributed:
|
|
32528
32528
|
type: object
|
|
32529
|
-
description: Real-time
|
|
32529
|
+
description: Real-time listener configuration; required when `type` is `distributed` and not used otherwise. Records reach the flow only when an Apex trigger on `sObjectType` in the connected org calls the Celigo package (`integrator_da__.RealTimeExporter.processExport()`) — no scheduling or manual execution is involved. Integration Apps create their triggers at installation; for a custom flow the customer deploys the trigger in Salesforce, starting from the code the export page shows under Required trigger.
|
|
32530
32530
|
x-celigo-ai-guidance:
|
|
32531
|
-
- Configuration for real-time Salesforce event-driven exports.
|
|
32532
32531
|
- |-
|
|
32533
|
-
|
|
32534
|
-
|
|
32535
|
-
|
|
32536
|
-
|
|
32537
|
-
|
|
32538
|
-
- Not used when type="soql" or for blob exports
|
|
32539
|
-
- Creates push-based integration triggered by Salesforce events
|
|
32540
|
-
- Implements real-time processing of creates, updates, and deletes
|
|
32532
|
+
After creating a listener on a custom flow, relay what the Help Center's "Listen for real-time data
|
|
32533
|
+
from Salesforce" states: an Apex trigger is required per sObject type and, for a custom flow, the
|
|
32534
|
+
customer creates it in Salesforce — copy the export page's Required trigger code, replace `<name>`,
|
|
32535
|
+
and save it under Setup → Object Manager → <object> → Triggers → New; deploying to production also
|
|
32536
|
+
needs a test class with 75% coverage. Integration Apps create their triggers at installation.
|
|
32541
32537
|
- |-
|
|
32542
|
-
|
|
32543
|
-
|
|
32544
|
-
|
|
32545
|
-
|
|
32546
|
-
|
|
32547
|
-
|
|
32548
|
-
- Uses Salesforce's platform events and streaming API
|
|
32549
|
-
- |-
|
|
32550
|
-
## TECHNICAL ARCHITECTURE
|
|
32551
|
-
|
|
32552
|
-
When configured, the system:
|
|
32553
|
-
1. Creates custom triggers in the connected Salesforce org
|
|
32554
|
-
2. Establishes event listeners for the specified objects
|
|
32555
|
-
3. Processes events as they occur (create/update/delete operations)
|
|
32556
|
-
4. Delivers the changed records to the integration flow
|
|
32538
|
+
When a listener on an enabled flow never creates a job for a create, update, or delete, the
|
|
32539
|
+
Celigo-side causes are `distributed.disabled` true, an offline connection, and a qualifier the
|
|
32540
|
+
record does not satisfy — and any qualifier drops delete events (see `qualifier`). Also verify the
|
|
32541
|
+
Help Center's trigger requirement in the connected org: an active Apex trigger on the object whose
|
|
32542
|
+
code calls `integrator_da__.RealTimeExporter`, and the Celigo package reachable through the
|
|
32543
|
+
connection (`GET /v1/connections/{_id}/distributed`, documented in this spec set).
|
|
32557
32544
|
properties:
|
|
32558
32545
|
referencedFields:
|
|
32559
32546
|
type:
|
package/package.json
CHANGED