@epilot/erp-integration-client 0.21.0 → 0.24.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.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +58 -27
- package/dist/openapi.d.ts +667 -301
- package/dist/openapi.json +896 -322
- package/package.json +1 -1
package/dist/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "ERP Integration API",
|
|
5
|
-
"version": "0.
|
|
5
|
+
"version": "0.36.0",
|
|
6
6
|
"description": "API for integrating with ERP systems, handling tracking acknowledgments, triggering ERP processes, and processing ERP updates."
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -128,6 +128,7 @@
|
|
|
128
128
|
},
|
|
129
129
|
"/v1/erp/updates/events": {
|
|
130
130
|
"post": {
|
|
131
|
+
"deprecated": true,
|
|
131
132
|
"operationId": "processErpUpdatesEvents",
|
|
132
133
|
"summary": "processErpUpdatesEvents",
|
|
133
134
|
"description": "Handles updates from ERP systems and tracks them appropriately",
|
|
@@ -214,9 +215,6 @@
|
|
|
214
215
|
"401": {
|
|
215
216
|
"$ref": "#/components/responses/Unauthorized"
|
|
216
217
|
},
|
|
217
|
-
"422": {
|
|
218
|
-
"$ref": "#/components/responses/ERPUpdatesResponse"
|
|
219
|
-
},
|
|
220
218
|
"500": {
|
|
221
219
|
"$ref": "#/components/responses/InternalServerError"
|
|
222
220
|
}
|
|
@@ -225,6 +223,7 @@
|
|
|
225
223
|
},
|
|
226
224
|
"/v2/erp/updates/events": {
|
|
227
225
|
"post": {
|
|
226
|
+
"deprecated": true,
|
|
228
227
|
"operationId": "processErpUpdatesEventsV2",
|
|
229
228
|
"summary": "processErpUpdatesEventsV2",
|
|
230
229
|
"description": "Handles updates from ERP systems using integration_id directly.\nThis is the v2 version that simplifies the API by accepting integration_id\ninstead of app_id and component_id.\n",
|
|
@@ -272,9 +271,59 @@
|
|
|
272
271
|
"401": {
|
|
273
272
|
"$ref": "#/components/responses/Unauthorized"
|
|
274
273
|
},
|
|
275
|
-
"
|
|
274
|
+
"500": {
|
|
275
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
},
|
|
280
|
+
"/v3/erp/updates/events": {
|
|
281
|
+
"post": {
|
|
282
|
+
"operationId": "processErpUpdatesEventsV3",
|
|
283
|
+
"summary": "processErpUpdatesEventsV3",
|
|
284
|
+
"description": "Handles updates from ERP systems using integration_id directly.\nThis is the v3 version that removes the unused event_type field and renames object_type to event_name\nto align with the integration UI naming.\n",
|
|
285
|
+
"tags": [
|
|
286
|
+
"erp"
|
|
287
|
+
],
|
|
288
|
+
"requestBody": {
|
|
289
|
+
"content": {
|
|
290
|
+
"application/json": {
|
|
291
|
+
"schema": {
|
|
292
|
+
"$ref": "#/components/schemas/ErpUpdatesEventsV3Request"
|
|
293
|
+
},
|
|
294
|
+
"example": {
|
|
295
|
+
"integration_id": "123e4567-e89b-12d3-a456-426614174000",
|
|
296
|
+
"correlation_id": "req-789e4567-e89b-12d3-a456-426614174000",
|
|
297
|
+
"events": [
|
|
298
|
+
{
|
|
299
|
+
"event_name": "business_partner",
|
|
300
|
+
"timestamp": "2025-05-01T08:30:00Z",
|
|
301
|
+
"format": "json",
|
|
302
|
+
"payload": "{\"id\":\"BP10001\",\"name\":\"Acme Corporation\",\"type\":\"organization\",\"tax_id\":\"DE123456789\",\"status\":\"active\"}",
|
|
303
|
+
"deduplication_id": "bp-create-20250501-083000-001"
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
"event_name": "contract_account",
|
|
307
|
+
"timestamp": "2025-05-01T08:35:00Z",
|
|
308
|
+
"format": "json",
|
|
309
|
+
"payload": "{\"id\":\"CA20001\",\"business_partner_id\":\"BP10001\",\"status\":\"active\",\"payment_method\":\"direct_debit\"}",
|
|
310
|
+
"deduplication_id": "ca-update-20250501-083500-001"
|
|
311
|
+
}
|
|
312
|
+
]
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
},
|
|
317
|
+
"responses": {
|
|
318
|
+
"200": {
|
|
276
319
|
"$ref": "#/components/responses/ERPUpdatesResponse"
|
|
277
320
|
},
|
|
321
|
+
"400": {
|
|
322
|
+
"$ref": "#/components/responses/BadRequest"
|
|
323
|
+
},
|
|
324
|
+
"401": {
|
|
325
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
326
|
+
},
|
|
278
327
|
"500": {
|
|
279
328
|
"$ref": "#/components/responses/InternalServerError"
|
|
280
329
|
}
|
|
@@ -1782,103 +1831,6 @@
|
|
|
1782
1831
|
}
|
|
1783
1832
|
}
|
|
1784
1833
|
},
|
|
1785
|
-
"/v2/integrations/{integrationId}/environment": {
|
|
1786
|
-
"get": {
|
|
1787
|
-
"operationId": "getIntegrationEnvironment",
|
|
1788
|
-
"summary": "getIntegrationEnvironment",
|
|
1789
|
-
"description": "Retrieve the environment configuration for an integration.\nSecret values are masked and replaced with \"****\" to prevent exposure.\n",
|
|
1790
|
-
"tags": [
|
|
1791
|
-
"integrations"
|
|
1792
|
-
],
|
|
1793
|
-
"parameters": [
|
|
1794
|
-
{
|
|
1795
|
-
"name": "integrationId",
|
|
1796
|
-
"in": "path",
|
|
1797
|
-
"required": true,
|
|
1798
|
-
"description": "The integration ID",
|
|
1799
|
-
"schema": {
|
|
1800
|
-
"type": "string",
|
|
1801
|
-
"format": "uuid"
|
|
1802
|
-
}
|
|
1803
|
-
}
|
|
1804
|
-
],
|
|
1805
|
-
"responses": {
|
|
1806
|
-
"200": {
|
|
1807
|
-
"description": "Successfully retrieved environment",
|
|
1808
|
-
"content": {
|
|
1809
|
-
"application/json": {
|
|
1810
|
-
"schema": {
|
|
1811
|
-
"$ref": "#/components/schemas/IntegrationEnvironment"
|
|
1812
|
-
}
|
|
1813
|
-
}
|
|
1814
|
-
}
|
|
1815
|
-
},
|
|
1816
|
-
"401": {
|
|
1817
|
-
"$ref": "#/components/responses/Unauthorized"
|
|
1818
|
-
},
|
|
1819
|
-
"404": {
|
|
1820
|
-
"description": "Integration not found"
|
|
1821
|
-
},
|
|
1822
|
-
"500": {
|
|
1823
|
-
"$ref": "#/components/responses/InternalServerError"
|
|
1824
|
-
}
|
|
1825
|
-
}
|
|
1826
|
-
},
|
|
1827
|
-
"patch": {
|
|
1828
|
-
"operationId": "updateIntegrationEnvironment",
|
|
1829
|
-
"summary": "updateIntegrationEnvironment",
|
|
1830
|
-
"description": "Update the environment configuration for an integration.\nSupports partial updates - only provided values are modified.\nSecret values can be updated by providing the actual value in the secrets field.\nTo keep existing secrets, omit them from the request.\nTo clear a value, set it to null.\n",
|
|
1831
|
-
"tags": [
|
|
1832
|
-
"integrations"
|
|
1833
|
-
],
|
|
1834
|
-
"parameters": [
|
|
1835
|
-
{
|
|
1836
|
-
"name": "integrationId",
|
|
1837
|
-
"in": "path",
|
|
1838
|
-
"required": true,
|
|
1839
|
-
"description": "The integration ID",
|
|
1840
|
-
"schema": {
|
|
1841
|
-
"type": "string",
|
|
1842
|
-
"format": "uuid"
|
|
1843
|
-
}
|
|
1844
|
-
}
|
|
1845
|
-
],
|
|
1846
|
-
"requestBody": {
|
|
1847
|
-
"required": true,
|
|
1848
|
-
"content": {
|
|
1849
|
-
"application/json": {
|
|
1850
|
-
"schema": {
|
|
1851
|
-
"$ref": "#/components/schemas/UpdateIntegrationEnvironmentRequest"
|
|
1852
|
-
}
|
|
1853
|
-
}
|
|
1854
|
-
}
|
|
1855
|
-
},
|
|
1856
|
-
"responses": {
|
|
1857
|
-
"200": {
|
|
1858
|
-
"description": "Environment updated successfully",
|
|
1859
|
-
"content": {
|
|
1860
|
-
"application/json": {
|
|
1861
|
-
"schema": {
|
|
1862
|
-
"$ref": "#/components/schemas/IntegrationEnvironment"
|
|
1863
|
-
}
|
|
1864
|
-
}
|
|
1865
|
-
}
|
|
1866
|
-
},
|
|
1867
|
-
"400": {
|
|
1868
|
-
"$ref": "#/components/responses/BadRequest"
|
|
1869
|
-
},
|
|
1870
|
-
"401": {
|
|
1871
|
-
"$ref": "#/components/responses/Unauthorized"
|
|
1872
|
-
},
|
|
1873
|
-
"404": {
|
|
1874
|
-
"description": "Integration not found"
|
|
1875
|
-
},
|
|
1876
|
-
"500": {
|
|
1877
|
-
"$ref": "#/components/responses/InternalServerError"
|
|
1878
|
-
}
|
|
1879
|
-
}
|
|
1880
|
-
}
|
|
1881
|
-
},
|
|
1882
1834
|
"/v1/integrations/{integrationId}/app-mapping": {
|
|
1883
1835
|
"put": {
|
|
1884
1836
|
"operationId": "setIntegrationAppMapping",
|
|
@@ -2004,11 +1956,11 @@
|
|
|
2004
1956
|
}
|
|
2005
1957
|
}
|
|
2006
1958
|
},
|
|
2007
|
-
"/v1/integrations/{integrationId}/monitoring/events": {
|
|
1959
|
+
"/v1/integrations/{integrationId}/monitoring/inbound-events": {
|
|
2008
1960
|
"post": {
|
|
2009
|
-
"operationId": "
|
|
2010
|
-
"summary": "
|
|
2011
|
-
"description": "Query
|
|
1961
|
+
"operationId": "queryInboundMonitoringEvents",
|
|
1962
|
+
"summary": "queryInboundMonitoringEvents",
|
|
1963
|
+
"description": "Query inbound monitoring events for a specific integration.\nReturns detailed information about inbound sync events from ERP systems,\nincluding success rates, error breakdowns, and processing metrics.\n",
|
|
2012
1964
|
"tags": [
|
|
2013
1965
|
"monitoring",
|
|
2014
1966
|
"integrations"
|
|
@@ -2030,14 +1982,14 @@
|
|
|
2030
1982
|
"content": {
|
|
2031
1983
|
"application/json": {
|
|
2032
1984
|
"schema": {
|
|
2033
|
-
"$ref": "#/components/schemas/
|
|
1985
|
+
"$ref": "#/components/schemas/QueryInboundMonitoringEventsRequest"
|
|
2034
1986
|
}
|
|
2035
1987
|
}
|
|
2036
1988
|
}
|
|
2037
1989
|
},
|
|
2038
1990
|
"responses": {
|
|
2039
1991
|
"200": {
|
|
2040
|
-
"$ref": "#/components/responses/
|
|
1992
|
+
"$ref": "#/components/responses/QueryInboundMonitoringEventsResponse"
|
|
2041
1993
|
},
|
|
2042
1994
|
"400": {
|
|
2043
1995
|
"$ref": "#/components/responses/BadRequest"
|
|
@@ -2058,7 +2010,7 @@
|
|
|
2058
2010
|
"post": {
|
|
2059
2011
|
"operationId": "getMonitoringStats",
|
|
2060
2012
|
"summary": "getMonitoringStats",
|
|
2061
|
-
"description": "Get aggregated statistics for
|
|
2013
|
+
"description": "Get aggregated statistics for both inbound and outbound monitoring events for a specific integration.\nReturns summary metrics for inbound (ERP sync) and outbound (webhook delivery) events,\nincluding success/error counts and optional breakdowns.\n",
|
|
2062
2014
|
"tags": [
|
|
2063
2015
|
"monitoring",
|
|
2064
2016
|
"integrations"
|
|
@@ -2104,6 +2056,56 @@
|
|
|
2104
2056
|
}
|
|
2105
2057
|
}
|
|
2106
2058
|
},
|
|
2059
|
+
"/v1/integrations/{integrationId}/monitoring/timeseries": {
|
|
2060
|
+
"post": {
|
|
2061
|
+
"operationId": "getMonitoringTimeSeries",
|
|
2062
|
+
"summary": "getMonitoringTimeSeries",
|
|
2063
|
+
"description": "Get time-series aggregated event counts for monitoring charts.\nReturns pre-bucketed counts at configurable intervals for both inbound and outbound events.\nMaximum of 200 buckets per request. Returns 400 if the time range and interval would exceed this limit.\n",
|
|
2064
|
+
"tags": [
|
|
2065
|
+
"monitoring",
|
|
2066
|
+
"integrations"
|
|
2067
|
+
],
|
|
2068
|
+
"parameters": [
|
|
2069
|
+
{
|
|
2070
|
+
"name": "integrationId",
|
|
2071
|
+
"in": "path",
|
|
2072
|
+
"required": true,
|
|
2073
|
+
"description": "The integration ID",
|
|
2074
|
+
"schema": {
|
|
2075
|
+
"type": "string",
|
|
2076
|
+
"format": "uuid"
|
|
2077
|
+
}
|
|
2078
|
+
}
|
|
2079
|
+
],
|
|
2080
|
+
"requestBody": {
|
|
2081
|
+
"required": true,
|
|
2082
|
+
"content": {
|
|
2083
|
+
"application/json": {
|
|
2084
|
+
"schema": {
|
|
2085
|
+
"$ref": "#/components/schemas/GetMonitoringTimeSeriesRequest"
|
|
2086
|
+
}
|
|
2087
|
+
}
|
|
2088
|
+
}
|
|
2089
|
+
},
|
|
2090
|
+
"responses": {
|
|
2091
|
+
"200": {
|
|
2092
|
+
"$ref": "#/components/responses/GetMonitoringTimeSeriesResponse"
|
|
2093
|
+
},
|
|
2094
|
+
"400": {
|
|
2095
|
+
"$ref": "#/components/responses/BadRequest"
|
|
2096
|
+
},
|
|
2097
|
+
"401": {
|
|
2098
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2099
|
+
},
|
|
2100
|
+
"404": {
|
|
2101
|
+
"$ref": "#/components/responses/NotFound"
|
|
2102
|
+
},
|
|
2103
|
+
"500": {
|
|
2104
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2105
|
+
}
|
|
2106
|
+
}
|
|
2107
|
+
}
|
|
2108
|
+
},
|
|
2107
2109
|
"/v1/integrations/{integrationId}/outbound-status": {
|
|
2108
2110
|
"get": {
|
|
2109
2111
|
"operationId": "getOutboundStatus",
|
|
@@ -2196,6 +2198,56 @@
|
|
|
2196
2198
|
}
|
|
2197
2199
|
}
|
|
2198
2200
|
}
|
|
2201
|
+
},
|
|
2202
|
+
"/v1/integrations/{integrationId}/monitoring/outbound-events": {
|
|
2203
|
+
"post": {
|
|
2204
|
+
"operationId": "queryOutboundMonitoringEvents",
|
|
2205
|
+
"summary": "queryOutboundMonitoringEvents",
|
|
2206
|
+
"description": "Query outbound monitoring events for a specific integration.\nReturns detailed information about outbound event deliveries,\nfiltered by event_name (event_catalog_event) linked to the integration's outbound use cases.\n",
|
|
2207
|
+
"tags": [
|
|
2208
|
+
"monitoring",
|
|
2209
|
+
"integrations"
|
|
2210
|
+
],
|
|
2211
|
+
"parameters": [
|
|
2212
|
+
{
|
|
2213
|
+
"name": "integrationId",
|
|
2214
|
+
"in": "path",
|
|
2215
|
+
"required": true,
|
|
2216
|
+
"description": "The integration ID",
|
|
2217
|
+
"schema": {
|
|
2218
|
+
"type": "string",
|
|
2219
|
+
"format": "uuid"
|
|
2220
|
+
}
|
|
2221
|
+
}
|
|
2222
|
+
],
|
|
2223
|
+
"requestBody": {
|
|
2224
|
+
"required": true,
|
|
2225
|
+
"content": {
|
|
2226
|
+
"application/json": {
|
|
2227
|
+
"schema": {
|
|
2228
|
+
"$ref": "#/components/schemas/QueryOutboundMonitoringEventsRequest"
|
|
2229
|
+
}
|
|
2230
|
+
}
|
|
2231
|
+
}
|
|
2232
|
+
},
|
|
2233
|
+
"responses": {
|
|
2234
|
+
"200": {
|
|
2235
|
+
"$ref": "#/components/responses/QueryOutboundMonitoringEventsResponse"
|
|
2236
|
+
},
|
|
2237
|
+
"400": {
|
|
2238
|
+
"$ref": "#/components/responses/BadRequest"
|
|
2239
|
+
},
|
|
2240
|
+
"401": {
|
|
2241
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2242
|
+
},
|
|
2243
|
+
"404": {
|
|
2244
|
+
"$ref": "#/components/responses/NotFound"
|
|
2245
|
+
},
|
|
2246
|
+
"500": {
|
|
2247
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2248
|
+
}
|
|
2249
|
+
}
|
|
2250
|
+
}
|
|
2199
2251
|
}
|
|
2200
2252
|
},
|
|
2201
2253
|
"components": {
|
|
@@ -2307,46 +2359,122 @@
|
|
|
2307
2359
|
}
|
|
2308
2360
|
}
|
|
2309
2361
|
},
|
|
2310
|
-
"
|
|
2362
|
+
"ErpEventV3": {
|
|
2311
2363
|
"type": "object",
|
|
2312
2364
|
"required": [
|
|
2313
|
-
"
|
|
2314
|
-
"
|
|
2315
|
-
"
|
|
2316
|
-
"
|
|
2317
|
-
"created_at",
|
|
2318
|
-
"action_id",
|
|
2319
|
-
"flow_action_id",
|
|
2320
|
-
"flow_name",
|
|
2321
|
-
"activity_id",
|
|
2322
|
-
"entity_id"
|
|
2365
|
+
"event_name",
|
|
2366
|
+
"timestamp",
|
|
2367
|
+
"format",
|
|
2368
|
+
"payload"
|
|
2323
2369
|
],
|
|
2324
2370
|
"properties": {
|
|
2325
|
-
"
|
|
2326
|
-
"type": "string",
|
|
2327
|
-
"description": "Unique identifier of the current automation execution"
|
|
2328
|
-
},
|
|
2329
|
-
"org_id": {
|
|
2330
|
-
"type": "string",
|
|
2331
|
-
"description": "Identifier of the organization where the automation is executed"
|
|
2332
|
-
},
|
|
2333
|
-
"webhook_id": {
|
|
2334
|
-
"type": "string",
|
|
2335
|
-
"description": "Identifier of the self-service webhook configuration"
|
|
2336
|
-
},
|
|
2337
|
-
"flow_id": {
|
|
2371
|
+
"event_name": {
|
|
2338
2372
|
"type": "string",
|
|
2339
|
-
"description": "
|
|
2373
|
+
"description": "Name of the event (e.g., business_partner, contract_account). Corresponds to the \"Event Name\" from the integration UI. Replaces object_type from V2."
|
|
2340
2374
|
},
|
|
2341
|
-
"
|
|
2375
|
+
"timestamp": {
|
|
2342
2376
|
"type": "string",
|
|
2343
2377
|
"format": "date-time",
|
|
2344
|
-
"description": "
|
|
2378
|
+
"description": "Timestamp when the event occurred"
|
|
2345
2379
|
},
|
|
2346
|
-
"
|
|
2380
|
+
"format": {
|
|
2347
2381
|
"type": "string",
|
|
2348
|
-
"
|
|
2349
|
-
|
|
2382
|
+
"enum": [
|
|
2383
|
+
"json",
|
|
2384
|
+
"xml"
|
|
2385
|
+
],
|
|
2386
|
+
"default": "json",
|
|
2387
|
+
"description": "Format of the payload data"
|
|
2388
|
+
},
|
|
2389
|
+
"payload": {
|
|
2390
|
+
"oneOf": [
|
|
2391
|
+
{
|
|
2392
|
+
"type": "string",
|
|
2393
|
+
"description": "The serialized object data payload (JSON, XML, etc.) as a string"
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
"type": "object",
|
|
2397
|
+
"description": "Direct JSON object (will be automatically serialized)",
|
|
2398
|
+
"additionalProperties": true
|
|
2399
|
+
}
|
|
2400
|
+
],
|
|
2401
|
+
"description": "The object data payload - can be either a serialized string or a direct JSON object"
|
|
2402
|
+
},
|
|
2403
|
+
"deduplication_id": {
|
|
2404
|
+
"type": "string",
|
|
2405
|
+
"pattern": "^[a-zA-Z0-9_-]+$",
|
|
2406
|
+
"minLength": 1,
|
|
2407
|
+
"maxLength": 255,
|
|
2408
|
+
"description": "Optional unique identifier for idempotency - prevents duplicate processing of the same event within 24 hours in context of the same integration. Must contain only alphanumeric characters, hyphens, and underscores.\n",
|
|
2409
|
+
"example": "evt-2025-05-01-12345-bp"
|
|
2410
|
+
}
|
|
2411
|
+
}
|
|
2412
|
+
},
|
|
2413
|
+
"ErpUpdatesEventsV3Request": {
|
|
2414
|
+
"type": "object",
|
|
2415
|
+
"required": [
|
|
2416
|
+
"integration_id",
|
|
2417
|
+
"events"
|
|
2418
|
+
],
|
|
2419
|
+
"properties": {
|
|
2420
|
+
"integration_id": {
|
|
2421
|
+
"type": "string",
|
|
2422
|
+
"format": "uuid",
|
|
2423
|
+
"description": "UUID that identifies the integration configuration to use"
|
|
2424
|
+
},
|
|
2425
|
+
"correlation_id": {
|
|
2426
|
+
"type": "string",
|
|
2427
|
+
"description": "Optional ID that identifies the specific request for debugging purposes"
|
|
2428
|
+
},
|
|
2429
|
+
"events": {
|
|
2430
|
+
"type": "array",
|
|
2431
|
+
"description": "List of ERP events to process",
|
|
2432
|
+
"items": {
|
|
2433
|
+
"$ref": "#/components/schemas/ErpEventV3"
|
|
2434
|
+
}
|
|
2435
|
+
}
|
|
2436
|
+
}
|
|
2437
|
+
},
|
|
2438
|
+
"TriggerErpActionRequest": {
|
|
2439
|
+
"type": "object",
|
|
2440
|
+
"required": [
|
|
2441
|
+
"execution_id",
|
|
2442
|
+
"org_id",
|
|
2443
|
+
"webhook_id",
|
|
2444
|
+
"flow_id",
|
|
2445
|
+
"created_at",
|
|
2446
|
+
"action_id",
|
|
2447
|
+
"flow_action_id",
|
|
2448
|
+
"flow_name",
|
|
2449
|
+
"activity_id",
|
|
2450
|
+
"entity_id"
|
|
2451
|
+
],
|
|
2452
|
+
"properties": {
|
|
2453
|
+
"execution_id": {
|
|
2454
|
+
"type": "string",
|
|
2455
|
+
"description": "Unique identifier of the current automation execution"
|
|
2456
|
+
},
|
|
2457
|
+
"org_id": {
|
|
2458
|
+
"type": "string",
|
|
2459
|
+
"description": "Identifier of the organization where the automation is executed"
|
|
2460
|
+
},
|
|
2461
|
+
"webhook_id": {
|
|
2462
|
+
"type": "string",
|
|
2463
|
+
"description": "Identifier of the self-service webhook configuration"
|
|
2464
|
+
},
|
|
2465
|
+
"flow_id": {
|
|
2466
|
+
"type": "string",
|
|
2467
|
+
"description": "Identifier of the automation flow that triggered the action"
|
|
2468
|
+
},
|
|
2469
|
+
"created_at": {
|
|
2470
|
+
"type": "string",
|
|
2471
|
+
"format": "date-time",
|
|
2472
|
+
"description": "ISO-8601 timestamp when the webhook event was created"
|
|
2473
|
+
},
|
|
2474
|
+
"action_id": {
|
|
2475
|
+
"type": "string",
|
|
2476
|
+
"description": "Identifier of the automation action being executed"
|
|
2477
|
+
},
|
|
2350
2478
|
"flow_action_id": {
|
|
2351
2479
|
"type": "string",
|
|
2352
2480
|
"description": "Identifier of the specific automation flow action instance"
|
|
@@ -2425,6 +2553,20 @@
|
|
|
2425
2553
|
"type": "string",
|
|
2426
2554
|
"description": "Optional description of the integration"
|
|
2427
2555
|
},
|
|
2556
|
+
"access_token_ids": {
|
|
2557
|
+
"type": "array",
|
|
2558
|
+
"description": "List of access token IDs associated with this integration",
|
|
2559
|
+
"items": {
|
|
2560
|
+
"type": "string"
|
|
2561
|
+
}
|
|
2562
|
+
},
|
|
2563
|
+
"environment_config": {
|
|
2564
|
+
"type": "array",
|
|
2565
|
+
"items": {
|
|
2566
|
+
"$ref": "#/components/schemas/EnvironmentFieldConfig"
|
|
2567
|
+
},
|
|
2568
|
+
"description": "Configuration defining environment variables needed by this integration. Values are stored in the Environments API."
|
|
2569
|
+
},
|
|
2428
2570
|
"created_at": {
|
|
2429
2571
|
"type": "string",
|
|
2430
2572
|
"format": "date-time",
|
|
@@ -2453,6 +2595,20 @@
|
|
|
2453
2595
|
"type": "string",
|
|
2454
2596
|
"maxLength": 1000,
|
|
2455
2597
|
"description": "Optional description of the integration"
|
|
2598
|
+
},
|
|
2599
|
+
"access_token_ids": {
|
|
2600
|
+
"type": "array",
|
|
2601
|
+
"description": "List of access token IDs to associate with this integration",
|
|
2602
|
+
"items": {
|
|
2603
|
+
"type": "string"
|
|
2604
|
+
}
|
|
2605
|
+
},
|
|
2606
|
+
"environment_config": {
|
|
2607
|
+
"type": "array",
|
|
2608
|
+
"items": {
|
|
2609
|
+
"$ref": "#/components/schemas/EnvironmentFieldConfig"
|
|
2610
|
+
},
|
|
2611
|
+
"description": "Configuration defining environment variables needed by this integration"
|
|
2456
2612
|
}
|
|
2457
2613
|
}
|
|
2458
2614
|
},
|
|
@@ -2469,6 +2625,64 @@
|
|
|
2469
2625
|
"type": "string",
|
|
2470
2626
|
"maxLength": 1000,
|
|
2471
2627
|
"description": "Optional description of the integration"
|
|
2628
|
+
},
|
|
2629
|
+
"access_token_ids": {
|
|
2630
|
+
"type": "array",
|
|
2631
|
+
"description": "List of access token IDs to associate with this integration",
|
|
2632
|
+
"items": {
|
|
2633
|
+
"type": "string"
|
|
2634
|
+
}
|
|
2635
|
+
},
|
|
2636
|
+
"environment_config": {
|
|
2637
|
+
"type": "array",
|
|
2638
|
+
"items": {
|
|
2639
|
+
"$ref": "#/components/schemas/EnvironmentFieldConfig"
|
|
2640
|
+
},
|
|
2641
|
+
"description": "Configuration defining environment variables needed by this integration"
|
|
2642
|
+
}
|
|
2643
|
+
}
|
|
2644
|
+
},
|
|
2645
|
+
"EnvironmentFieldConfig": {
|
|
2646
|
+
"type": "object",
|
|
2647
|
+
"required": [
|
|
2648
|
+
"key",
|
|
2649
|
+
"label",
|
|
2650
|
+
"type"
|
|
2651
|
+
],
|
|
2652
|
+
"properties": {
|
|
2653
|
+
"key": {
|
|
2654
|
+
"type": "string",
|
|
2655
|
+
"description": "Environment variable key, used to look up the value in the Environments API.",
|
|
2656
|
+
"pattern": "^[a-z0-9][a-z0-9_.\\-]{0,127}$"
|
|
2657
|
+
},
|
|
2658
|
+
"label": {
|
|
2659
|
+
"type": "string",
|
|
2660
|
+
"description": "Display label for the field in the UI",
|
|
2661
|
+
"minLength": 1,
|
|
2662
|
+
"maxLength": 255
|
|
2663
|
+
},
|
|
2664
|
+
"type": {
|
|
2665
|
+
"type": "string",
|
|
2666
|
+
"enum": [
|
|
2667
|
+
"String",
|
|
2668
|
+
"SecretString"
|
|
2669
|
+
],
|
|
2670
|
+
"description": "Whether the value is a plain string or an encrypted secret"
|
|
2671
|
+
},
|
|
2672
|
+
"description": {
|
|
2673
|
+
"type": "string",
|
|
2674
|
+
"description": "Help text shown below the field",
|
|
2675
|
+
"maxLength": 1000
|
|
2676
|
+
},
|
|
2677
|
+
"required": {
|
|
2678
|
+
"type": "boolean",
|
|
2679
|
+
"default": false,
|
|
2680
|
+
"description": "Whether this field must be filled before the integration can be used"
|
|
2681
|
+
},
|
|
2682
|
+
"order": {
|
|
2683
|
+
"type": "integer",
|
|
2684
|
+
"minimum": 0,
|
|
2685
|
+
"description": "Sort order for display and drag-to-reorder"
|
|
2472
2686
|
}
|
|
2473
2687
|
}
|
|
2474
2688
|
},
|
|
@@ -2528,69 +2742,6 @@
|
|
|
2528
2742
|
}
|
|
2529
2743
|
}
|
|
2530
2744
|
},
|
|
2531
|
-
"IntegrationEnvironment": {
|
|
2532
|
-
"type": "object",
|
|
2533
|
-
"description": "Environment configuration for an integration with masked secrets",
|
|
2534
|
-
"required": [
|
|
2535
|
-
"integrationId",
|
|
2536
|
-
"values"
|
|
2537
|
-
],
|
|
2538
|
-
"properties": {
|
|
2539
|
-
"integrationId": {
|
|
2540
|
-
"type": "string",
|
|
2541
|
-
"format": "uuid",
|
|
2542
|
-
"description": "Parent integration ID"
|
|
2543
|
-
},
|
|
2544
|
-
"values": {
|
|
2545
|
-
"type": "object",
|
|
2546
|
-
"additionalProperties": {
|
|
2547
|
-
"type": "string"
|
|
2548
|
-
},
|
|
2549
|
-
"description": "Environment values as key-value pairs.\nSecret values are masked as \"****\" in responses.\n"
|
|
2550
|
-
},
|
|
2551
|
-
"secret_keys": {
|
|
2552
|
-
"type": "array",
|
|
2553
|
-
"items": {
|
|
2554
|
-
"type": "string"
|
|
2555
|
-
},
|
|
2556
|
-
"description": "List of keys that contain secret values (masked in values field)"
|
|
2557
|
-
},
|
|
2558
|
-
"created_at": {
|
|
2559
|
-
"type": "string",
|
|
2560
|
-
"format": "date-time",
|
|
2561
|
-
"nullable": true,
|
|
2562
|
-
"description": "ISO-8601 timestamp when the environment was created"
|
|
2563
|
-
},
|
|
2564
|
-
"updated_at": {
|
|
2565
|
-
"type": "string",
|
|
2566
|
-
"format": "date-time",
|
|
2567
|
-
"nullable": true,
|
|
2568
|
-
"description": "ISO-8601 timestamp when the environment was last updated"
|
|
2569
|
-
}
|
|
2570
|
-
}
|
|
2571
|
-
},
|
|
2572
|
-
"UpdateIntegrationEnvironmentRequest": {
|
|
2573
|
-
"type": "object",
|
|
2574
|
-
"description": "Request to update environment configuration.\nSupports partial updates - only provided values are modified.\n",
|
|
2575
|
-
"properties": {
|
|
2576
|
-
"values": {
|
|
2577
|
-
"type": "object",
|
|
2578
|
-
"additionalProperties": {
|
|
2579
|
-
"type": "string",
|
|
2580
|
-
"nullable": true
|
|
2581
|
-
},
|
|
2582
|
-
"description": "Plain text environment values to update.\nSet a value to null to clear it.\n"
|
|
2583
|
-
},
|
|
2584
|
-
"secrets": {
|
|
2585
|
-
"type": "object",
|
|
2586
|
-
"additionalProperties": {
|
|
2587
|
-
"type": "string",
|
|
2588
|
-
"nullable": true
|
|
2589
|
-
},
|
|
2590
|
-
"description": "Secret environment values to update.\nThese are stored securely and masked in GET responses.\nSet a value to null to clear it.\nOmit a secret to keep its existing value.\n"
|
|
2591
|
-
}
|
|
2592
|
-
}
|
|
2593
|
-
},
|
|
2594
2745
|
"UseCaseBase": {
|
|
2595
2746
|
"type": "object",
|
|
2596
2747
|
"required": [
|
|
@@ -3167,7 +3318,7 @@
|
|
|
3167
3318
|
"attributes": {
|
|
3168
3319
|
"type": "object",
|
|
3169
3320
|
"additionalProperties": true,
|
|
3170
|
-
"description": "Meter reading attributes
|
|
3321
|
+
"description": "Meter reading attributes. Required: external_id, timestamp, source, value. `source` must be one of: ECP, ERP, 360, journey-submission. `reason` (optional) must be one of: regular, irregular, last, first, meter_change, contract_change, meter_adjustment (or empty/null)."
|
|
3171
3322
|
}
|
|
3172
3323
|
}
|
|
3173
3324
|
},
|
|
@@ -3566,6 +3717,21 @@
|
|
|
3566
3717
|
],
|
|
3567
3718
|
"description": "Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean."
|
|
3568
3719
|
},
|
|
3720
|
+
"mode": {
|
|
3721
|
+
"type": "string",
|
|
3722
|
+
"enum": [
|
|
3723
|
+
"upsert",
|
|
3724
|
+
"delete",
|
|
3725
|
+
"purge",
|
|
3726
|
+
"upsert-prune-scope-purge",
|
|
3727
|
+
"upsert-prune-scope-delete"
|
|
3728
|
+
],
|
|
3729
|
+
"default": "upsert",
|
|
3730
|
+
"description": "Operation mode for entity mapping:\n- 'upsert': Create or update the entity (default)\n- 'delete': Soft delete the entity (marks as deleted)\n- 'purge': Hard delete the entity (permanent removal)\n- 'upsert-prune-scope-purge': Upsert entities from array, then purge entities in scope that weren't upserted\n- 'upsert-prune-scope-delete': Upsert entities from array, then soft delete entities in scope that weren't upserted\n"
|
|
3731
|
+
},
|
|
3732
|
+
"scope": {
|
|
3733
|
+
"$ref": "#/components/schemas/PruneScopeConfig"
|
|
3734
|
+
},
|
|
3569
3735
|
"fields": {
|
|
3570
3736
|
"type": "array",
|
|
3571
3737
|
"description": "Field mapping definitions",
|
|
@@ -3575,6 +3741,41 @@
|
|
|
3575
3741
|
}
|
|
3576
3742
|
}
|
|
3577
3743
|
},
|
|
3744
|
+
"PruneScopeConfig": {
|
|
3745
|
+
"type": "object",
|
|
3746
|
+
"description": "Scope configuration for upsert-prune-scope modes.\nDefines how to find entities that should be pruned if not in the upsert payload.\nThe scope is resolved against the original event payload (not individual array items).\n",
|
|
3747
|
+
"required": [
|
|
3748
|
+
"scope_mode"
|
|
3749
|
+
],
|
|
3750
|
+
"properties": {
|
|
3751
|
+
"scope_mode": {
|
|
3752
|
+
"type": "string",
|
|
3753
|
+
"enum": [
|
|
3754
|
+
"relations",
|
|
3755
|
+
"query"
|
|
3756
|
+
],
|
|
3757
|
+
"description": "Scope mode for finding entities to prune:\n- 'relations': Find scope by looking at all entities related to a specific entity (both direct and reverse relations)\n- 'query': Find scope entities directly via query parameters\n"
|
|
3758
|
+
},
|
|
3759
|
+
"schema": {
|
|
3760
|
+
"type": "string",
|
|
3761
|
+
"description": "For 'relations' mode: The schema of the entity to find (e.g., 'billing_account').\nNot used for 'query' mode.\n"
|
|
3762
|
+
},
|
|
3763
|
+
"unique_ids": {
|
|
3764
|
+
"type": "array",
|
|
3765
|
+
"description": "For 'relations' mode: How to identify the scope entity from the payload.\nNot used for 'query' mode.\n",
|
|
3766
|
+
"items": {
|
|
3767
|
+
"$ref": "#/components/schemas/RelationUniqueIdField"
|
|
3768
|
+
}
|
|
3769
|
+
},
|
|
3770
|
+
"query": {
|
|
3771
|
+
"type": "array",
|
|
3772
|
+
"description": "For 'query' mode: Direct query parameters to find scope entities.\nNot used for 'relations' or 'reverse-relations' modes.\n",
|
|
3773
|
+
"items": {
|
|
3774
|
+
"$ref": "#/components/schemas/RelationUniqueIdField"
|
|
3775
|
+
}
|
|
3776
|
+
}
|
|
3777
|
+
}
|
|
3778
|
+
},
|
|
3578
3779
|
"IntegrationMeterReading": {
|
|
3579
3780
|
"type": "object",
|
|
3580
3781
|
"required": [
|
|
@@ -3879,6 +4080,13 @@
|
|
|
3879
4080
|
"type": "string",
|
|
3880
4081
|
"description": "Optional description of the integration"
|
|
3881
4082
|
},
|
|
4083
|
+
"access_token_ids": {
|
|
4084
|
+
"type": "array",
|
|
4085
|
+
"description": "List of access token IDs associated with this integration",
|
|
4086
|
+
"items": {
|
|
4087
|
+
"type": "string"
|
|
4088
|
+
}
|
|
4089
|
+
},
|
|
3882
4090
|
"use_cases": {
|
|
3883
4091
|
"type": "array",
|
|
3884
4092
|
"description": "All use cases belonging to this integration",
|
|
@@ -3916,6 +4124,13 @@
|
|
|
3916
4124
|
"maxLength": 1000,
|
|
3917
4125
|
"description": "Optional description of the integration"
|
|
3918
4126
|
},
|
|
4127
|
+
"access_token_ids": {
|
|
4128
|
+
"type": "array",
|
|
4129
|
+
"description": "List of access token IDs to associate with this integration",
|
|
4130
|
+
"items": {
|
|
4131
|
+
"type": "string"
|
|
4132
|
+
}
|
|
4133
|
+
},
|
|
3919
4134
|
"use_cases": {
|
|
3920
4135
|
"type": "array",
|
|
3921
4136
|
"description": "Full list of use cases (declarative). This replaces ALL existing use cases.\n- Use cases with an `id` field matching an existing use case will be updated\n- Use cases without an `id` or with a non-matching `id` will be created\n- Existing use cases not in this list will be deleted\n",
|
|
@@ -4063,6 +4278,10 @@
|
|
|
4063
4278
|
"type": "string",
|
|
4064
4279
|
"description": "Filter by object type"
|
|
4065
4280
|
},
|
|
4281
|
+
"event_name": {
|
|
4282
|
+
"type": "string",
|
|
4283
|
+
"description": "Filter by event name (alias for object_type)"
|
|
4284
|
+
},
|
|
4066
4285
|
"limit": {
|
|
4067
4286
|
"type": "integer",
|
|
4068
4287
|
"description": "Maximum number of results to return",
|
|
@@ -4090,7 +4309,7 @@
|
|
|
4090
4309
|
}
|
|
4091
4310
|
}
|
|
4092
4311
|
},
|
|
4093
|
-
"
|
|
4312
|
+
"QueryInboundMonitoringEventsRequest": {
|
|
4094
4313
|
"type": "object",
|
|
4095
4314
|
"properties": {
|
|
4096
4315
|
"use_case_id": {
|
|
@@ -4098,14 +4317,6 @@
|
|
|
4098
4317
|
"format": "uuid",
|
|
4099
4318
|
"description": "Filter by use case ID"
|
|
4100
4319
|
},
|
|
4101
|
-
"direction": {
|
|
4102
|
-
"type": "string",
|
|
4103
|
-
"enum": [
|
|
4104
|
-
"inbound",
|
|
4105
|
-
"outbound"
|
|
4106
|
-
],
|
|
4107
|
-
"description": "Filter by sync direction"
|
|
4108
|
-
},
|
|
4109
4320
|
"event_type": {
|
|
4110
4321
|
"type": "string",
|
|
4111
4322
|
"enum": [
|
|
@@ -4121,7 +4332,8 @@
|
|
|
4121
4332
|
"enum": [
|
|
4122
4333
|
"entity",
|
|
4123
4334
|
"meter_reading",
|
|
4124
|
-
"webhook"
|
|
4335
|
+
"webhook",
|
|
4336
|
+
"api_deprecation"
|
|
4125
4337
|
],
|
|
4126
4338
|
"description": "Filter by sync type"
|
|
4127
4339
|
},
|
|
@@ -4130,7 +4342,8 @@
|
|
|
4130
4342
|
"enum": [
|
|
4131
4343
|
"success",
|
|
4132
4344
|
"error",
|
|
4133
|
-
"skipped"
|
|
4345
|
+
"skipped",
|
|
4346
|
+
"warning"
|
|
4134
4347
|
],
|
|
4135
4348
|
"description": "Filter by processing status"
|
|
4136
4349
|
},
|
|
@@ -4141,8 +4354,7 @@
|
|
|
4141
4354
|
"configuration",
|
|
4142
4355
|
"downstream_api",
|
|
4143
4356
|
"timeout",
|
|
4144
|
-
"system"
|
|
4145
|
-
"webhook_delivery"
|
|
4357
|
+
"system"
|
|
4146
4358
|
],
|
|
4147
4359
|
"description": "Filter by error category (only applicable when status=error)"
|
|
4148
4360
|
},
|
|
@@ -4154,6 +4366,10 @@
|
|
|
4154
4366
|
"type": "string",
|
|
4155
4367
|
"description": "Filter by object type (e.g., 'contract', 'meter')"
|
|
4156
4368
|
},
|
|
4369
|
+
"event_name": {
|
|
4370
|
+
"type": "string",
|
|
4371
|
+
"description": "Filter by event name (alias for object_type)"
|
|
4372
|
+
},
|
|
4157
4373
|
"event_id": {
|
|
4158
4374
|
"type": "string",
|
|
4159
4375
|
"description": "Filter by event ID to find a specific event"
|
|
@@ -4197,13 +4413,10 @@
|
|
|
4197
4413
|
},
|
|
4198
4414
|
"QueryAccessLogsRequest": {
|
|
4199
4415
|
"type": "object",
|
|
4200
|
-
"required": [
|
|
4201
|
-
"token_id"
|
|
4202
|
-
],
|
|
4203
4416
|
"properties": {
|
|
4204
4417
|
"token_id": {
|
|
4205
4418
|
"type": "string",
|
|
4206
|
-
"description": "Filter by access token ID (e.g., 'api_5ZugdRXasLfWBypHi93Fk')",
|
|
4419
|
+
"description": "Filter by a specific access token ID (e.g., 'api_5ZugdRXasLfWBypHi93Fk').\nMust be one of the access_token_ids linked to the integration.\nIf omitted, returns logs for all access tokens linked to the integration.\n",
|
|
4207
4420
|
"example": "api_5ZugdRXasLfWBypHi93Fk"
|
|
4208
4421
|
},
|
|
4209
4422
|
"service": {
|
|
@@ -4332,19 +4545,6 @@
|
|
|
4332
4545
|
"GetMonitoringStatsRequest": {
|
|
4333
4546
|
"type": "object",
|
|
4334
4547
|
"properties": {
|
|
4335
|
-
"use_case_id": {
|
|
4336
|
-
"type": "string",
|
|
4337
|
-
"format": "uuid",
|
|
4338
|
-
"description": "Filter by use case ID"
|
|
4339
|
-
},
|
|
4340
|
-
"direction": {
|
|
4341
|
-
"type": "string",
|
|
4342
|
-
"enum": [
|
|
4343
|
-
"inbound",
|
|
4344
|
-
"outbound"
|
|
4345
|
-
],
|
|
4346
|
-
"description": "Filter by sync direction"
|
|
4347
|
-
},
|
|
4348
4548
|
"from_date": {
|
|
4349
4549
|
"type": "string",
|
|
4350
4550
|
"format": "date-time",
|
|
@@ -4357,35 +4557,392 @@
|
|
|
4357
4557
|
"description": "End date for statistics period (inclusive)",
|
|
4358
4558
|
"example": "2025-01-31T23:59:59Z"
|
|
4359
4559
|
},
|
|
4360
|
-
"
|
|
4560
|
+
"inbound_group_by": {
|
|
4361
4561
|
"type": "array",
|
|
4362
4562
|
"items": {
|
|
4363
4563
|
"type": "string",
|
|
4364
4564
|
"enum": [
|
|
4365
|
-
"direction",
|
|
4366
4565
|
"use_case_id",
|
|
4367
4566
|
"sync_type",
|
|
4368
4567
|
"status",
|
|
4369
4568
|
"error_category",
|
|
4370
4569
|
"object_type",
|
|
4570
|
+
"event_name",
|
|
4371
4571
|
"date"
|
|
4372
4572
|
]
|
|
4373
4573
|
},
|
|
4374
|
-
"description": "Fields to group statistics by",
|
|
4574
|
+
"description": "Fields to group inbound statistics by",
|
|
4375
4575
|
"example": [
|
|
4376
|
-
"
|
|
4576
|
+
"use_case_id",
|
|
4377
4577
|
"status"
|
|
4378
4578
|
]
|
|
4379
|
-
}
|
|
4380
|
-
|
|
4579
|
+
},
|
|
4580
|
+
"outbound_group_by": {
|
|
4581
|
+
"type": "array",
|
|
4582
|
+
"items": {
|
|
4583
|
+
"type": "string",
|
|
4584
|
+
"enum": [
|
|
4585
|
+
"event_name",
|
|
4586
|
+
"status",
|
|
4587
|
+
"webhook_config_id",
|
|
4588
|
+
"date"
|
|
4589
|
+
]
|
|
4590
|
+
},
|
|
4591
|
+
"description": "Fields to group outbound statistics by",
|
|
4592
|
+
"example": [
|
|
4593
|
+
"event_name",
|
|
4594
|
+
"status"
|
|
4595
|
+
]
|
|
4596
|
+
}
|
|
4597
|
+
}
|
|
4381
4598
|
},
|
|
4382
|
-
"
|
|
4599
|
+
"GetMonitoringTimeSeriesRequest": {
|
|
4600
|
+
"type": "object",
|
|
4601
|
+
"required": [
|
|
4602
|
+
"from_date",
|
|
4603
|
+
"interval"
|
|
4604
|
+
],
|
|
4605
|
+
"properties": {
|
|
4606
|
+
"from_date": {
|
|
4607
|
+
"type": "string",
|
|
4608
|
+
"format": "date-time",
|
|
4609
|
+
"description": "Start date for the time series (inclusive)",
|
|
4610
|
+
"example": "2025-01-01T00:00:00Z"
|
|
4611
|
+
},
|
|
4612
|
+
"to_date": {
|
|
4613
|
+
"type": "string",
|
|
4614
|
+
"format": "date-time",
|
|
4615
|
+
"description": "End date for the time series (inclusive). Defaults to current time if not specified.",
|
|
4616
|
+
"example": "2025-01-31T23:59:59Z"
|
|
4617
|
+
},
|
|
4618
|
+
"interval": {
|
|
4619
|
+
"type": "string",
|
|
4620
|
+
"enum": [
|
|
4621
|
+
"5m",
|
|
4622
|
+
"10m",
|
|
4623
|
+
"30m",
|
|
4624
|
+
"1h",
|
|
4625
|
+
"3h",
|
|
4626
|
+
"1d"
|
|
4627
|
+
],
|
|
4628
|
+
"description": "The time bucket interval for aggregation",
|
|
4629
|
+
"example": "1h"
|
|
4630
|
+
},
|
|
4631
|
+
"direction": {
|
|
4632
|
+
"type": "string",
|
|
4633
|
+
"enum": [
|
|
4634
|
+
"inbound",
|
|
4635
|
+
"outbound",
|
|
4636
|
+
"both"
|
|
4637
|
+
],
|
|
4638
|
+
"default": "both",
|
|
4639
|
+
"description": "Filter by event direction. Defaults to both.",
|
|
4640
|
+
"example": "both"
|
|
4641
|
+
}
|
|
4642
|
+
}
|
|
4643
|
+
},
|
|
4644
|
+
"TimeSeriesBucket": {
|
|
4645
|
+
"type": "object",
|
|
4646
|
+
"required": [
|
|
4647
|
+
"timestamp"
|
|
4648
|
+
],
|
|
4649
|
+
"properties": {
|
|
4650
|
+
"timestamp": {
|
|
4651
|
+
"type": "string",
|
|
4652
|
+
"format": "date-time",
|
|
4653
|
+
"description": "The start timestamp of the bucket"
|
|
4654
|
+
},
|
|
4655
|
+
"inbound": {
|
|
4656
|
+
"type": "object",
|
|
4657
|
+
"nullable": true,
|
|
4658
|
+
"description": "Inbound event counts for this bucket. Null when direction is outbound.",
|
|
4659
|
+
"properties": {
|
|
4660
|
+
"success_count": {
|
|
4661
|
+
"type": "integer"
|
|
4662
|
+
},
|
|
4663
|
+
"error_count": {
|
|
4664
|
+
"type": "integer"
|
|
4665
|
+
},
|
|
4666
|
+
"warning_count": {
|
|
4667
|
+
"type": "integer"
|
|
4668
|
+
},
|
|
4669
|
+
"skipped_count": {
|
|
4670
|
+
"type": "integer"
|
|
4671
|
+
},
|
|
4672
|
+
"total_count": {
|
|
4673
|
+
"type": "integer"
|
|
4674
|
+
}
|
|
4675
|
+
}
|
|
4676
|
+
},
|
|
4677
|
+
"outbound": {
|
|
4678
|
+
"type": "object",
|
|
4679
|
+
"nullable": true,
|
|
4680
|
+
"description": "Outbound event counts for this bucket. Null when direction is inbound.",
|
|
4681
|
+
"properties": {
|
|
4682
|
+
"success_count": {
|
|
4683
|
+
"type": "integer"
|
|
4684
|
+
},
|
|
4685
|
+
"error_count": {
|
|
4686
|
+
"type": "integer"
|
|
4687
|
+
},
|
|
4688
|
+
"pending_count": {
|
|
4689
|
+
"type": "integer"
|
|
4690
|
+
},
|
|
4691
|
+
"total_count": {
|
|
4692
|
+
"type": "integer"
|
|
4693
|
+
}
|
|
4694
|
+
}
|
|
4695
|
+
}
|
|
4696
|
+
}
|
|
4697
|
+
},
|
|
4698
|
+
"QueryOutboundMonitoringEventsRequest": {
|
|
4699
|
+
"type": "object",
|
|
4700
|
+
"properties": {
|
|
4701
|
+
"event_name": {
|
|
4702
|
+
"type": "string",
|
|
4703
|
+
"description": "Filter by event name (event_catalog_event). If not specified, returns events for all linked event names in the integration's outbound use cases.",
|
|
4704
|
+
"example": "automation_flow_target"
|
|
4705
|
+
},
|
|
4706
|
+
"status": {
|
|
4707
|
+
"type": "string",
|
|
4708
|
+
"enum": [
|
|
4709
|
+
"succeeded",
|
|
4710
|
+
"failed",
|
|
4711
|
+
"pending"
|
|
4712
|
+
],
|
|
4713
|
+
"description": "Filter by delivery status"
|
|
4714
|
+
},
|
|
4715
|
+
"webhook_config_id": {
|
|
4716
|
+
"type": "string",
|
|
4717
|
+
"description": "Filter by webhook configuration ID"
|
|
4718
|
+
},
|
|
4719
|
+
"from_date": {
|
|
4720
|
+
"type": "string",
|
|
4721
|
+
"format": "date-time",
|
|
4722
|
+
"description": "Filter events from this date (inclusive)",
|
|
4723
|
+
"example": "2025-01-01T00:00:00Z"
|
|
4724
|
+
},
|
|
4725
|
+
"to_date": {
|
|
4726
|
+
"type": "string",
|
|
4727
|
+
"format": "date-time",
|
|
4728
|
+
"description": "Filter events until this date (inclusive)",
|
|
4729
|
+
"example": "2025-01-31T23:59:59Z"
|
|
4730
|
+
},
|
|
4731
|
+
"limit": {
|
|
4732
|
+
"type": "integer",
|
|
4733
|
+
"description": "Maximum number of results to return",
|
|
4734
|
+
"example": 50,
|
|
4735
|
+
"default": 50,
|
|
4736
|
+
"minimum": 1,
|
|
4737
|
+
"maximum": 100
|
|
4738
|
+
},
|
|
4739
|
+
"cursor": {
|
|
4740
|
+
"type": "object",
|
|
4741
|
+
"description": "Cursor for pagination",
|
|
4742
|
+
"properties": {
|
|
4743
|
+
"created_at": {
|
|
4744
|
+
"type": "string",
|
|
4745
|
+
"format": "date-time",
|
|
4746
|
+
"description": "Timestamp from the last event in the previous page"
|
|
4747
|
+
},
|
|
4748
|
+
"event_id": {
|
|
4749
|
+
"type": "string",
|
|
4750
|
+
"description": "Event ID from the last event in the previous page"
|
|
4751
|
+
}
|
|
4752
|
+
}
|
|
4753
|
+
}
|
|
4754
|
+
}
|
|
4755
|
+
},
|
|
4756
|
+
"OutboundMonitoringEvent": {
|
|
4757
|
+
"type": "object",
|
|
4758
|
+
"required": [
|
|
4759
|
+
"org_id",
|
|
4760
|
+
"event_id",
|
|
4761
|
+
"event_name",
|
|
4762
|
+
"status",
|
|
4763
|
+
"created_at"
|
|
4764
|
+
],
|
|
4765
|
+
"properties": {
|
|
4766
|
+
"org_id": {
|
|
4767
|
+
"type": "string",
|
|
4768
|
+
"description": "Organization ID"
|
|
4769
|
+
},
|
|
4770
|
+
"event_id": {
|
|
4771
|
+
"type": "string",
|
|
4772
|
+
"description": "Unique event identifier"
|
|
4773
|
+
},
|
|
4774
|
+
"event_name": {
|
|
4775
|
+
"type": "string",
|
|
4776
|
+
"description": "Event name (event_catalog_event)"
|
|
4777
|
+
},
|
|
4778
|
+
"status": {
|
|
4779
|
+
"type": "string",
|
|
4780
|
+
"enum": [
|
|
4781
|
+
"succeeded",
|
|
4782
|
+
"failed",
|
|
4783
|
+
"pending"
|
|
4784
|
+
],
|
|
4785
|
+
"description": "Delivery status"
|
|
4786
|
+
},
|
|
4787
|
+
"url": {
|
|
4788
|
+
"type": "string",
|
|
4789
|
+
"description": "Target URL"
|
|
4790
|
+
},
|
|
4791
|
+
"http_method": {
|
|
4792
|
+
"type": "string",
|
|
4793
|
+
"description": "HTTP method used (e.g., POST)"
|
|
4794
|
+
},
|
|
4795
|
+
"http_response": {
|
|
4796
|
+
"type": "object",
|
|
4797
|
+
"description": "HTTP response details (status_code, message, headers)",
|
|
4798
|
+
"additionalProperties": true
|
|
4799
|
+
},
|
|
4800
|
+
"webhook_config_id": {
|
|
4801
|
+
"type": "string",
|
|
4802
|
+
"description": "Webhook configuration ID"
|
|
4803
|
+
},
|
|
4804
|
+
"metadata": {
|
|
4805
|
+
"type": "object",
|
|
4806
|
+
"description": "Additional metadata (webhook_id, organization details, correlation_id, etc.)",
|
|
4807
|
+
"additionalProperties": true
|
|
4808
|
+
},
|
|
4809
|
+
"execution_context": {
|
|
4810
|
+
"type": "object",
|
|
4811
|
+
"description": "Execution context (execution_arn, state_machine_arn, etc.)",
|
|
4812
|
+
"additionalProperties": true
|
|
4813
|
+
},
|
|
4814
|
+
"payload": {
|
|
4815
|
+
"type": "object",
|
|
4816
|
+
"description": "Payload that was sent",
|
|
4817
|
+
"additionalProperties": true
|
|
4818
|
+
},
|
|
4819
|
+
"created_at": {
|
|
4820
|
+
"type": "string",
|
|
4821
|
+
"format": "date-time",
|
|
4822
|
+
"description": "When the event was created"
|
|
4823
|
+
},
|
|
4824
|
+
"updated_at": {
|
|
4825
|
+
"type": "string",
|
|
4826
|
+
"format": "date-time",
|
|
4827
|
+
"description": "When the event was last updated"
|
|
4828
|
+
}
|
|
4829
|
+
}
|
|
4830
|
+
},
|
|
4831
|
+
"MonitoringStats": {
|
|
4832
|
+
"type": "object",
|
|
4833
|
+
"required": [
|
|
4834
|
+
"inbound",
|
|
4835
|
+
"outbound"
|
|
4836
|
+
],
|
|
4837
|
+
"properties": {
|
|
4838
|
+
"inbound": {
|
|
4839
|
+
"type": "object",
|
|
4840
|
+
"description": "Statistics for inbound (ERP sync) events",
|
|
4841
|
+
"required": [
|
|
4842
|
+
"total_events",
|
|
4843
|
+
"success_count",
|
|
4844
|
+
"error_count",
|
|
4845
|
+
"skipped_count"
|
|
4846
|
+
],
|
|
4847
|
+
"properties": {
|
|
4848
|
+
"total_events": {
|
|
4849
|
+
"type": "integer",
|
|
4850
|
+
"description": "Total number of inbound events in the period"
|
|
4851
|
+
},
|
|
4852
|
+
"total_correlations": {
|
|
4853
|
+
"type": "integer",
|
|
4854
|
+
"description": "Total number of unique correlation IDs"
|
|
4855
|
+
},
|
|
4856
|
+
"success_count": {
|
|
4857
|
+
"type": "integer",
|
|
4858
|
+
"description": "Number of successful events"
|
|
4859
|
+
},
|
|
4860
|
+
"error_count": {
|
|
4861
|
+
"type": "integer",
|
|
4862
|
+
"description": "Number of failed events"
|
|
4863
|
+
},
|
|
4864
|
+
"skipped_count": {
|
|
4865
|
+
"type": "integer",
|
|
4866
|
+
"description": "Number of skipped events"
|
|
4867
|
+
},
|
|
4868
|
+
"warning_count": {
|
|
4869
|
+
"type": "integer",
|
|
4870
|
+
"description": "Number of warning events"
|
|
4871
|
+
},
|
|
4872
|
+
"success_rate": {
|
|
4873
|
+
"type": "number",
|
|
4874
|
+
"format": "float",
|
|
4875
|
+
"description": "Success rate as percentage (0-100)"
|
|
4876
|
+
},
|
|
4877
|
+
"last_error_at": {
|
|
4878
|
+
"type": "string",
|
|
4879
|
+
"format": "date-time",
|
|
4880
|
+
"nullable": true,
|
|
4881
|
+
"description": "Timestamp of the most recent error"
|
|
4882
|
+
},
|
|
4883
|
+
"breakdown": {
|
|
4884
|
+
"type": "array",
|
|
4885
|
+
"description": "Statistics breakdown by requested inbound_group_by fields",
|
|
4886
|
+
"items": {
|
|
4887
|
+
"type": "object",
|
|
4888
|
+
"additionalProperties": true
|
|
4889
|
+
}
|
|
4890
|
+
}
|
|
4891
|
+
}
|
|
4892
|
+
},
|
|
4893
|
+
"outbound": {
|
|
4894
|
+
"type": "object",
|
|
4895
|
+
"description": "Statistics for outbound (webhook delivery) events",
|
|
4896
|
+
"required": [
|
|
4897
|
+
"total_events",
|
|
4898
|
+
"success_count",
|
|
4899
|
+
"error_count"
|
|
4900
|
+
],
|
|
4901
|
+
"properties": {
|
|
4902
|
+
"total_events": {
|
|
4903
|
+
"type": "integer",
|
|
4904
|
+
"description": "Total number of outbound events in the period"
|
|
4905
|
+
},
|
|
4906
|
+
"success_count": {
|
|
4907
|
+
"type": "integer",
|
|
4908
|
+
"description": "Number of successful deliveries"
|
|
4909
|
+
},
|
|
4910
|
+
"error_count": {
|
|
4911
|
+
"type": "integer",
|
|
4912
|
+
"description": "Number of failed deliveries"
|
|
4913
|
+
},
|
|
4914
|
+
"pending_count": {
|
|
4915
|
+
"type": "integer",
|
|
4916
|
+
"description": "Number of pending deliveries"
|
|
4917
|
+
},
|
|
4918
|
+
"success_rate": {
|
|
4919
|
+
"type": "number",
|
|
4920
|
+
"format": "float",
|
|
4921
|
+
"description": "Success rate as percentage (0-100)"
|
|
4922
|
+
},
|
|
4923
|
+
"last_error_at": {
|
|
4924
|
+
"type": "string",
|
|
4925
|
+
"format": "date-time",
|
|
4926
|
+
"nullable": true,
|
|
4927
|
+
"description": "Timestamp of the most recent error"
|
|
4928
|
+
},
|
|
4929
|
+
"breakdown": {
|
|
4930
|
+
"type": "array",
|
|
4931
|
+
"description": "Statistics breakdown by requested outbound_group_by fields",
|
|
4932
|
+
"items": {
|
|
4933
|
+
"type": "object",
|
|
4934
|
+
"additionalProperties": true
|
|
4935
|
+
}
|
|
4936
|
+
}
|
|
4937
|
+
}
|
|
4938
|
+
}
|
|
4939
|
+
}
|
|
4940
|
+
},
|
|
4941
|
+
"InboundMonitoringEvent": {
|
|
4383
4942
|
"type": "object",
|
|
4384
4943
|
"required": [
|
|
4385
4944
|
"org_id",
|
|
4386
4945
|
"event_id",
|
|
4387
|
-
"direction",
|
|
4388
|
-
"event_type",
|
|
4389
4946
|
"object_type",
|
|
4390
4947
|
"sync_type",
|
|
4391
4948
|
"status",
|
|
@@ -4416,14 +4973,6 @@
|
|
|
4416
4973
|
"nullable": true,
|
|
4417
4974
|
"description": "Use case ID"
|
|
4418
4975
|
},
|
|
4419
|
-
"direction": {
|
|
4420
|
-
"type": "string",
|
|
4421
|
-
"enum": [
|
|
4422
|
-
"inbound",
|
|
4423
|
-
"outbound"
|
|
4424
|
-
],
|
|
4425
|
-
"description": "Sync direction"
|
|
4426
|
-
},
|
|
4427
4976
|
"event_type": {
|
|
4428
4977
|
"type": "string",
|
|
4429
4978
|
"enum": [
|
|
@@ -4432,7 +4981,7 @@
|
|
|
4432
4981
|
"DELETE",
|
|
4433
4982
|
"TRIGGER"
|
|
4434
4983
|
],
|
|
4435
|
-
"description": "Type of event"
|
|
4984
|
+
"description": "Type of event (optional for V3 events)"
|
|
4436
4985
|
},
|
|
4437
4986
|
"object_type": {
|
|
4438
4987
|
"type": "string",
|
|
@@ -4443,7 +4992,8 @@
|
|
|
4443
4992
|
"enum": [
|
|
4444
4993
|
"entity",
|
|
4445
4994
|
"meter_reading",
|
|
4446
|
-
"webhook"
|
|
4995
|
+
"webhook",
|
|
4996
|
+
"api_deprecation"
|
|
4447
4997
|
],
|
|
4448
4998
|
"description": "Type of sync operation"
|
|
4449
4999
|
},
|
|
@@ -4452,7 +5002,8 @@
|
|
|
4452
5002
|
"enum": [
|
|
4453
5003
|
"success",
|
|
4454
5004
|
"error",
|
|
4455
|
-
"skipped"
|
|
5005
|
+
"skipped",
|
|
5006
|
+
"warning"
|
|
4456
5007
|
],
|
|
4457
5008
|
"description": "Processing status"
|
|
4458
5009
|
},
|
|
@@ -4474,8 +5025,7 @@
|
|
|
4474
5025
|
"configuration",
|
|
4475
5026
|
"downstream_api",
|
|
4476
5027
|
"timeout",
|
|
4477
|
-
"system"
|
|
4478
|
-
"webhook_delivery"
|
|
5028
|
+
"system"
|
|
4479
5029
|
],
|
|
4480
5030
|
"description": "Error category (when status=error)"
|
|
4481
5031
|
},
|
|
@@ -4484,16 +5034,6 @@
|
|
|
4484
5034
|
"nullable": true,
|
|
4485
5035
|
"description": "Processing duration in milliseconds"
|
|
4486
5036
|
},
|
|
4487
|
-
"target_url": {
|
|
4488
|
-
"type": "string",
|
|
4489
|
-
"nullable": true,
|
|
4490
|
-
"description": "Target URL for outbound requests"
|
|
4491
|
-
},
|
|
4492
|
-
"http_status_code": {
|
|
4493
|
-
"type": "integer",
|
|
4494
|
-
"nullable": true,
|
|
4495
|
-
"description": "HTTP status code from target (outbound only)"
|
|
4496
|
-
},
|
|
4497
5037
|
"received_at": {
|
|
4498
5038
|
"type": "string",
|
|
4499
5039
|
"format": "date-time",
|
|
@@ -4505,57 +5045,6 @@
|
|
|
4505
5045
|
"description": "When processing completed"
|
|
4506
5046
|
}
|
|
4507
5047
|
}
|
|
4508
|
-
},
|
|
4509
|
-
"MonitoringStats": {
|
|
4510
|
-
"type": "object",
|
|
4511
|
-
"required": [
|
|
4512
|
-
"total_events",
|
|
4513
|
-
"total_correlations",
|
|
4514
|
-
"success_count",
|
|
4515
|
-
"error_count",
|
|
4516
|
-
"skipped_count"
|
|
4517
|
-
],
|
|
4518
|
-
"properties": {
|
|
4519
|
-
"total_events": {
|
|
4520
|
-
"type": "integer",
|
|
4521
|
-
"description": "Total number of events in the period"
|
|
4522
|
-
},
|
|
4523
|
-
"total_correlations": {
|
|
4524
|
-
"type": "integer",
|
|
4525
|
-
"description": "Total number of unique correlation IDs (a correlation_id groups multiple event_ids)"
|
|
4526
|
-
},
|
|
4527
|
-
"success_count": {
|
|
4528
|
-
"type": "integer",
|
|
4529
|
-
"description": "Number of successful events"
|
|
4530
|
-
},
|
|
4531
|
-
"error_count": {
|
|
4532
|
-
"type": "integer",
|
|
4533
|
-
"description": "Number of failed events"
|
|
4534
|
-
},
|
|
4535
|
-
"skipped_count": {
|
|
4536
|
-
"type": "integer",
|
|
4537
|
-
"description": "Number of skipped events"
|
|
4538
|
-
},
|
|
4539
|
-
"success_rate": {
|
|
4540
|
-
"type": "number",
|
|
4541
|
-
"format": "float",
|
|
4542
|
-
"description": "Success rate as percentage (0-100)"
|
|
4543
|
-
},
|
|
4544
|
-
"last_error_at": {
|
|
4545
|
-
"type": "string",
|
|
4546
|
-
"format": "date-time",
|
|
4547
|
-
"nullable": true,
|
|
4548
|
-
"description": "Timestamp of the most recent error"
|
|
4549
|
-
},
|
|
4550
|
-
"breakdown": {
|
|
4551
|
-
"type": "array",
|
|
4552
|
-
"description": "Statistics breakdown by requested group_by fields",
|
|
4553
|
-
"items": {
|
|
4554
|
-
"type": "object",
|
|
4555
|
-
"additionalProperties": true
|
|
4556
|
-
}
|
|
4557
|
-
}
|
|
4558
|
-
}
|
|
4559
5048
|
}
|
|
4560
5049
|
},
|
|
4561
5050
|
"responses": {
|
|
@@ -4599,8 +5088,8 @@
|
|
|
4599
5088
|
}
|
|
4600
5089
|
}
|
|
4601
5090
|
},
|
|
4602
|
-
"
|
|
4603
|
-
"description": "
|
|
5091
|
+
"QueryInboundMonitoringEventsResponse": {
|
|
5092
|
+
"description": "Inbound monitoring events queried successfully",
|
|
4604
5093
|
"content": {
|
|
4605
5094
|
"application/json": {
|
|
4606
5095
|
"schema": {
|
|
@@ -4609,9 +5098,9 @@
|
|
|
4609
5098
|
"data": {
|
|
4610
5099
|
"type": "array",
|
|
4611
5100
|
"items": {
|
|
4612
|
-
"$ref": "#/components/schemas/
|
|
5101
|
+
"$ref": "#/components/schemas/InboundMonitoringEvent"
|
|
4613
5102
|
},
|
|
4614
|
-
"description": "List of monitoring events"
|
|
5103
|
+
"description": "List of inbound monitoring events"
|
|
4615
5104
|
},
|
|
4616
5105
|
"next_cursor": {
|
|
4617
5106
|
"type": "object",
|
|
@@ -4646,6 +5135,53 @@
|
|
|
4646
5135
|
}
|
|
4647
5136
|
}
|
|
4648
5137
|
},
|
|
5138
|
+
"GetMonitoringTimeSeriesResponse": {
|
|
5139
|
+
"description": "Time-series aggregated event counts retrieved successfully",
|
|
5140
|
+
"content": {
|
|
5141
|
+
"application/json": {
|
|
5142
|
+
"schema": {
|
|
5143
|
+
"type": "object",
|
|
5144
|
+
"required": [
|
|
5145
|
+
"interval",
|
|
5146
|
+
"from_date",
|
|
5147
|
+
"to_date",
|
|
5148
|
+
"buckets"
|
|
5149
|
+
],
|
|
5150
|
+
"properties": {
|
|
5151
|
+
"interval": {
|
|
5152
|
+
"type": "string",
|
|
5153
|
+
"enum": [
|
|
5154
|
+
"5m",
|
|
5155
|
+
"10m",
|
|
5156
|
+
"30m",
|
|
5157
|
+
"1h",
|
|
5158
|
+
"3h",
|
|
5159
|
+
"1d"
|
|
5160
|
+
],
|
|
5161
|
+
"description": "The time bucket interval used for aggregation"
|
|
5162
|
+
},
|
|
5163
|
+
"from_date": {
|
|
5164
|
+
"type": "string",
|
|
5165
|
+
"format": "date-time",
|
|
5166
|
+
"description": "Start date of the time series"
|
|
5167
|
+
},
|
|
5168
|
+
"to_date": {
|
|
5169
|
+
"type": "string",
|
|
5170
|
+
"format": "date-time",
|
|
5171
|
+
"description": "End date of the time series"
|
|
5172
|
+
},
|
|
5173
|
+
"buckets": {
|
|
5174
|
+
"type": "array",
|
|
5175
|
+
"items": {
|
|
5176
|
+
"$ref": "#/components/schemas/TimeSeriesBucket"
|
|
5177
|
+
},
|
|
5178
|
+
"description": "List of time-series buckets with event counts"
|
|
5179
|
+
}
|
|
5180
|
+
}
|
|
5181
|
+
}
|
|
5182
|
+
}
|
|
5183
|
+
}
|
|
5184
|
+
},
|
|
4649
5185
|
"QueryAccessLogsResponse": {
|
|
4650
5186
|
"description": "Access logs queried successfully",
|
|
4651
5187
|
"content": {
|
|
@@ -4683,6 +5219,43 @@
|
|
|
4683
5219
|
}
|
|
4684
5220
|
}
|
|
4685
5221
|
},
|
|
5222
|
+
"QueryOutboundMonitoringEventsResponse": {
|
|
5223
|
+
"description": "Outbound monitoring events queried successfully",
|
|
5224
|
+
"content": {
|
|
5225
|
+
"application/json": {
|
|
5226
|
+
"schema": {
|
|
5227
|
+
"type": "object",
|
|
5228
|
+
"properties": {
|
|
5229
|
+
"data": {
|
|
5230
|
+
"type": "array",
|
|
5231
|
+
"items": {
|
|
5232
|
+
"$ref": "#/components/schemas/OutboundMonitoringEvent"
|
|
5233
|
+
},
|
|
5234
|
+
"description": "List of outbound monitoring events"
|
|
5235
|
+
},
|
|
5236
|
+
"next_cursor": {
|
|
5237
|
+
"type": "object",
|
|
5238
|
+
"nullable": true,
|
|
5239
|
+
"description": "Cursor to fetch the next page. Null if no more results.",
|
|
5240
|
+
"properties": {
|
|
5241
|
+
"created_at": {
|
|
5242
|
+
"type": "string",
|
|
5243
|
+
"format": "date-time"
|
|
5244
|
+
},
|
|
5245
|
+
"event_id": {
|
|
5246
|
+
"type": "string"
|
|
5247
|
+
}
|
|
5248
|
+
}
|
|
5249
|
+
},
|
|
5250
|
+
"has_more": {
|
|
5251
|
+
"type": "boolean",
|
|
5252
|
+
"description": "Indicates if more results are available"
|
|
5253
|
+
}
|
|
5254
|
+
}
|
|
5255
|
+
}
|
|
5256
|
+
}
|
|
5257
|
+
}
|
|
5258
|
+
},
|
|
4686
5259
|
"ReplayEventsResponse": {
|
|
4687
5260
|
"description": "Events replay initiated",
|
|
4688
5261
|
"content": {
|
|
@@ -4731,9 +5304,10 @@
|
|
|
4731
5304
|
"enum": [
|
|
4732
5305
|
"success",
|
|
4733
5306
|
"error",
|
|
4734
|
-
"skipped"
|
|
5307
|
+
"skipped",
|
|
5308
|
+
"ignored"
|
|
4735
5309
|
],
|
|
4736
|
-
"description": "Processing status for the event (skipped indicates duplicate deduplication_id)"
|
|
5310
|
+
"description": "Processing status for the event (skipped indicates duplicate deduplication_id, ignored indicates unconfigured event)"
|
|
4737
5311
|
},
|
|
4738
5312
|
"message": {
|
|
4739
5313
|
"type": "string"
|