@epilot/sdk 2.11.1 → 2.11.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/definitions/automation.json +19 -0
  2. package/definitions/customer-portal.json +21 -0
  3. package/definitions/focus-pocus-runtime.json +1 -0
  4. package/definitions/focus-pocus.json +757 -0
  5. package/definitions/webhooks.json +4 -0
  6. package/dist/apis/access-token.cjs +6 -6
  7. package/dist/apis/access-token.js +1 -1
  8. package/dist/apis/address-suggestions.cjs +6 -6
  9. package/dist/apis/address-suggestions.js +1 -1
  10. package/dist/apis/address.cjs +6 -6
  11. package/dist/apis/address.js +1 -1
  12. package/dist/apis/ai-agents.cjs +6 -6
  13. package/dist/apis/ai-agents.js +1 -1
  14. package/dist/apis/app.cjs +6 -6
  15. package/dist/apis/app.js +1 -1
  16. package/dist/apis/audit-logs.cjs +6 -6
  17. package/dist/apis/audit-logs.js +1 -1
  18. package/dist/apis/automation.cjs +6 -6
  19. package/dist/apis/automation.d.cts +2 -2
  20. package/dist/apis/automation.d.ts +2 -2
  21. package/dist/apis/automation.js +1 -1
  22. package/dist/apis/billing.cjs +6 -6
  23. package/dist/apis/billing.js +1 -1
  24. package/dist/apis/blueprint-manifest.cjs +6 -6
  25. package/dist/apis/blueprint-manifest.js +1 -1
  26. package/dist/apis/calendar.cjs +6 -6
  27. package/dist/apis/calendar.js +1 -1
  28. package/dist/apis/configuration-hub.cjs +6 -6
  29. package/dist/apis/configuration-hub.js +1 -1
  30. package/dist/apis/consent.cjs +6 -6
  31. package/dist/apis/consent.js +1 -1
  32. package/dist/apis/customer-portal.cjs +6 -6
  33. package/dist/apis/customer-portal.d.cts +2 -2
  34. package/dist/apis/customer-portal.d.ts +2 -2
  35. package/dist/apis/customer-portal.js +1 -1
  36. package/dist/apis/dashboard.cjs +6 -6
  37. package/dist/apis/dashboard.js +1 -1
  38. package/dist/apis/data-governance.cjs +6 -6
  39. package/dist/apis/data-governance.js +1 -1
  40. package/dist/apis/deduplication.cjs +6 -6
  41. package/dist/apis/deduplication.js +1 -1
  42. package/dist/apis/design.cjs +6 -6
  43. package/dist/apis/design.js +1 -1
  44. package/dist/apis/document.cjs +6 -6
  45. package/dist/apis/document.js +1 -1
  46. package/dist/apis/email-settings.cjs +6 -6
  47. package/dist/apis/email-settings.js +1 -1
  48. package/dist/apis/email-template.cjs +6 -6
  49. package/dist/apis/email-template.js +1 -1
  50. package/dist/apis/entity-mapping.cjs +6 -6
  51. package/dist/apis/entity-mapping.js +1 -1
  52. package/dist/apis/entity.cjs +6 -6
  53. package/dist/apis/entity.js +1 -1
  54. package/dist/apis/environments.cjs +6 -6
  55. package/dist/apis/environments.js +1 -1
  56. package/dist/apis/event-catalog.cjs +6 -6
  57. package/dist/apis/event-catalog.js +1 -1
  58. package/dist/apis/file.cjs +6 -6
  59. package/dist/apis/file.js +1 -1
  60. package/dist/apis/iban.cjs +6 -6
  61. package/dist/apis/iban.js +1 -1
  62. package/dist/apis/integration-toolkit.cjs +6 -6
  63. package/dist/apis/integration-toolkit.js +1 -1
  64. package/dist/apis/journey.cjs +6 -6
  65. package/dist/apis/journey.js +1 -1
  66. package/dist/apis/kanban.cjs +6 -6
  67. package/dist/apis/kanban.js +1 -1
  68. package/dist/apis/message.cjs +6 -6
  69. package/dist/apis/message.js +1 -1
  70. package/dist/apis/metering.cjs +6 -6
  71. package/dist/apis/metering.js +1 -1
  72. package/dist/apis/notes.cjs +6 -6
  73. package/dist/apis/notes.js +1 -1
  74. package/dist/apis/notification.cjs +6 -6
  75. package/dist/apis/notification.js +1 -1
  76. package/dist/apis/organization.cjs +6 -6
  77. package/dist/apis/organization.js +1 -1
  78. package/dist/apis/partner-directory.cjs +6 -6
  79. package/dist/apis/partner-directory.js +1 -1
  80. package/dist/apis/permissions.cjs +6 -6
  81. package/dist/apis/permissions.js +1 -1
  82. package/dist/apis/pricing-tier.cjs +6 -6
  83. package/dist/apis/pricing-tier.js +1 -1
  84. package/dist/apis/pricing.cjs +6 -6
  85. package/dist/apis/pricing.js +1 -1
  86. package/dist/apis/purpose.cjs +6 -6
  87. package/dist/apis/purpose.js +1 -1
  88. package/dist/apis/query.cjs +6 -6
  89. package/dist/apis/query.js +1 -1
  90. package/dist/apis/sandbox.cjs +6 -6
  91. package/dist/apis/sandbox.js +1 -1
  92. package/dist/apis/sharing.cjs +6 -6
  93. package/dist/apis/sharing.js +1 -1
  94. package/dist/apis/snapshot.cjs +6 -6
  95. package/dist/apis/snapshot.js +1 -1
  96. package/dist/apis/submission.cjs +6 -6
  97. package/dist/apis/submission.js +1 -1
  98. package/dist/apis/target.cjs +6 -6
  99. package/dist/apis/target.js +1 -1
  100. package/dist/apis/targeting.cjs +6 -6
  101. package/dist/apis/targeting.js +1 -1
  102. package/dist/apis/template-variables.cjs +6 -6
  103. package/dist/apis/template-variables.js +1 -1
  104. package/dist/apis/user.cjs +6 -6
  105. package/dist/apis/user.js +1 -1
  106. package/dist/apis/validation-rules.cjs +6 -6
  107. package/dist/apis/validation-rules.js +1 -1
  108. package/dist/apis/webhooks.cjs +6 -6
  109. package/dist/apis/webhooks.d.cts +2 -2
  110. package/dist/apis/webhooks.d.ts +2 -2
  111. package/dist/apis/webhooks.js +1 -1
  112. package/dist/apis/workflow-definition.cjs +6 -6
  113. package/dist/apis/workflow-definition.js +1 -1
  114. package/dist/apis/workflow.cjs +6 -6
  115. package/dist/apis/workflow.js +1 -1
  116. package/dist/automation-5NBZZJK2.cjs +7 -0
  117. package/dist/automation-HKXKZO4Z.js +7 -0
  118. package/dist/{automation.d-DS_YXDE8.d.cts → automation.d-Beojxb43.d.cts} +21 -0
  119. package/dist/{automation.d-DS_YXDE8.d.ts → automation.d-Beojxb43.d.ts} +21 -0
  120. package/dist/{chunk-CF2RGSFQ.js → chunk-2EYCMVMS.js} +3 -3
  121. package/dist/{chunk-LJ4LC3P3.cjs → chunk-665MWZOX.cjs} +3 -3
  122. package/dist/customer-portal-BMRUBRLZ.js +7 -0
  123. package/dist/customer-portal-PCVNGORX.cjs +7 -0
  124. package/dist/{customer-portal.d-C9TeumWq.d.cts → customer-portal.d-dgnYw5xb.d.cts} +25 -0
  125. package/dist/{customer-portal.d-C9TeumWq.d.ts → customer-portal.d-dgnYw5xb.d.ts} +25 -0
  126. package/dist/index.cjs +8 -8
  127. package/dist/index.d.cts +3 -3
  128. package/dist/index.d.ts +3 -3
  129. package/dist/index.js +1 -1
  130. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  131. package/dist/webhooks-HMU5AUDZ.js +7 -0
  132. package/dist/webhooks-KHP3MEVQ.cjs +7 -0
  133. package/dist/{webhooks.d-CVTTnVT9.d.ts → webhooks.d-DytMQF8m.d.cts} +4 -0
  134. package/dist/{webhooks.d-CVTTnVT9.d.cts → webhooks.d-DytMQF8m.d.ts} +4 -0
  135. package/docs/automation.md +28 -15
  136. package/docs/customer-portal.md +9 -4
  137. package/docs/webhooks.md +4 -0
  138. package/package.json +12 -11
  139. package/dist/automation-S6NFS5KU.cjs +0 -7
  140. package/dist/automation-W75XZG7B.js +0 -7
  141. package/dist/customer-portal-K2HBVB7T.cjs +0 -7
  142. package/dist/customer-portal-UAKA5B2P.js +0 -7
  143. package/dist/webhooks-K2SR7P75.cjs +0 -7
  144. package/dist/webhooks-TO24LUVN.js +0 -7
@@ -2060,6 +2060,15 @@ declare namespace Components {
2060
2060
  [name: string]: string;
2061
2061
  };
2062
2062
  };
2063
+ /**
2064
+ * Whether to (re)trigger the registration identifiers check hook, which issues a request
2065
+ * to the connected ERP to (re)sync the contact, in addition to waiting for the entity to
2066
+ * arrive. Defaults to true to preserve existing behaviour. Set to false on retry attempts
2067
+ * to only poll for an already-triggered sync to land, without issuing another upstream
2068
+ * request to the ERP.
2069
+ *
2070
+ */
2071
+ trigger_identifiers_check?: boolean;
2063
2072
  }
2064
2073
  export interface ContentWidget {
2065
2074
  id: string;
@@ -9488,6 +9497,14 @@ declare namespace Paths {
9488
9497
  * 5da0a718-c822-403d-9f5d-20d4584e0528
9489
9498
  */
9490
9499
  Components.Schemas.EntityId /* uuid */;
9500
+ /**
9501
+ * Present only when exists is false. NOT_FOUND means the given identifiers did
9502
+ * not match any contact (definitive - the client should not retry). TIMEOUT
9503
+ * means the contact was not found within the processing window but may still be
9504
+ * ingesting; the client may retry (ideally with trigger_identifiers_check=false).
9505
+ *
9506
+ */
9507
+ reason?: "TIMEOUT" | "NOT_FOUND";
9491
9508
  }
9492
9509
  export type $400 = Components.Responses.InvalidRequest;
9493
9510
  export type $404 = Components.Responses.NotFound;
@@ -9535,6 +9552,14 @@ declare namespace Paths {
9535
9552
  * 5da0a718-c822-403d-9f5d-20d4584e0528
9536
9553
  */
9537
9554
  Components.Schemas.EntityId /* uuid */;
9555
+ /**
9556
+ * Present only when exists is false. NOT_FOUND means the given identifiers did
9557
+ * not match any contact (definitive - the client should not retry). TIMEOUT
9558
+ * means the contact was not found within the processing window but may still be
9559
+ * ingesting; the client may retry (ideally with trigger_identifiers_check=false).
9560
+ *
9561
+ */
9562
+ reason?: "TIMEOUT" | "NOT_FOUND";
9538
9563
  }
9539
9564
  export type $400 = Components.Responses.InvalidRequest;
9540
9565
  export type $404 = Components.Responses.NotFound;
@@ -2060,6 +2060,15 @@ declare namespace Components {
2060
2060
  [name: string]: string;
2061
2061
  };
2062
2062
  };
2063
+ /**
2064
+ * Whether to (re)trigger the registration identifiers check hook, which issues a request
2065
+ * to the connected ERP to (re)sync the contact, in addition to waiting for the entity to
2066
+ * arrive. Defaults to true to preserve existing behaviour. Set to false on retry attempts
2067
+ * to only poll for an already-triggered sync to land, without issuing another upstream
2068
+ * request to the ERP.
2069
+ *
2070
+ */
2071
+ trigger_identifiers_check?: boolean;
2063
2072
  }
2064
2073
  export interface ContentWidget {
2065
2074
  id: string;
@@ -9488,6 +9497,14 @@ declare namespace Paths {
9488
9497
  * 5da0a718-c822-403d-9f5d-20d4584e0528
9489
9498
  */
9490
9499
  Components.Schemas.EntityId /* uuid */;
9500
+ /**
9501
+ * Present only when exists is false. NOT_FOUND means the given identifiers did
9502
+ * not match any contact (definitive - the client should not retry). TIMEOUT
9503
+ * means the contact was not found within the processing window but may still be
9504
+ * ingesting; the client may retry (ideally with trigger_identifiers_check=false).
9505
+ *
9506
+ */
9507
+ reason?: "TIMEOUT" | "NOT_FOUND";
9491
9508
  }
9492
9509
  export type $400 = Components.Responses.InvalidRequest;
9493
9510
  export type $404 = Components.Responses.NotFound;
@@ -9535,6 +9552,14 @@ declare namespace Paths {
9535
9552
  * 5da0a718-c822-403d-9f5d-20d4584e0528
9536
9553
  */
9537
9554
  Components.Schemas.EntityId /* uuid */;
9555
+ /**
9556
+ * Present only when exists is false. NOT_FOUND means the given identifiers did
9557
+ * not match any contact (definitive - the client should not retry). TIMEOUT
9558
+ * means the contact was not found within the processing window but may still be
9559
+ * ingesting; the client may retry (ideally with trigger_identifiers_check=false).
9560
+ *
9561
+ */
9562
+ reason?: "TIMEOUT" | "NOT_FOUND";
9538
9563
  }
9539
9564
  export type $400 = Components.Responses.InvalidRequest;
9540
9565
  export type $404 = Components.Responses.NotFound;
package/dist/index.cjs CHANGED
@@ -158,7 +158,7 @@ var _chunkDVM27A7Ecjs = require('./chunk-DVM27A7E.cjs');
158
158
 
159
159
 
160
160
 
161
- var _chunkLJ4LC3P3cjs = require('./chunk-LJ4LC3P3.cjs');
161
+ var _chunk665MWZOXcjs = require('./chunk-665MWZOX.cjs');
162
162
 
163
163
 
164
164
  var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
225
225
  }
226
226
  if (!entry.instance) {
227
227
  const definition = entry.loader();
228
- entry.instance = _chunkLJ4LC3P3cjs.createApiClient.call(void 0, {
228
+ entry.instance = _chunk665MWZOXcjs.createApiClient.call(void 0, {
229
229
  definition,
230
230
  token: state.token,
231
231
  headers: state.globalHeaders,
@@ -258,7 +258,7 @@ var resetAllClients = (registry) => {
258
258
  };
259
259
 
260
260
  // src/apis/_registry.ts
261
- var expandDef = (mod) => _chunkLJ4LC3P3cjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
261
+ var expandDef = (mod) => _chunk665MWZOXcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
262
262
  var registerBuiltinApis = (registry) => {
263
263
  registerApi({
264
264
  registry,
@@ -601,9 +601,9 @@ var createSDK = () => {
601
601
  const available = [...registry.keys()].join(", ");
602
602
  throw new Error(`Unknown API: "${name}". Available: ${available}`);
603
603
  }
604
- return _chunkLJ4LC3P3cjs.createApiHandle.call(void 0, {
604
+ return _chunk665MWZOXcjs.createApiHandle.call(void 0, {
605
605
  resolveClient: () => resolveClient({ registry, name, state }),
606
- createClient: () => _chunkLJ4LC3P3cjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
606
+ createClient: () => _chunk665MWZOXcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
607
607
  apiName: name
608
608
  });
609
609
  };
@@ -651,9 +651,9 @@ var createSDK = () => {
651
651
  return interceptorUse;
652
652
  }
653
653
  case "help":
654
- return (apiName) => _chunkLJ4LC3P3cjs.help.call(void 0, apiName);
654
+ return (apiName) => _chunk665MWZOXcjs.help.call(void 0, apiName);
655
655
  case "openapi":
656
- return (apiName) => _chunkLJ4LC3P3cjs.openapi.call(void 0, apiName);
656
+ return (apiName) => _chunk665MWZOXcjs.openapi.call(void 0, apiName);
657
657
  case "then":
658
658
  case "catch":
659
659
  case "finally":
@@ -683,4 +683,4 @@ var epilot = createSDK();
683
683
 
684
684
 
685
685
 
686
- exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkLJ4LC3P3cjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkLJ4LC3P3cjs.help; exports.openapi = _chunkLJ4LC3P3cjs.openapi;
686
+ exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunk665MWZOXcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunk665MWZOXcjs.help; exports.openapi = _chunk665MWZOXcjs.openapi;
package/dist/index.d.cts CHANGED
@@ -9,13 +9,13 @@ import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.cjs';
9
9
  import { C as Client$3 } from './ai-agents.d-D-7bTH-9.cjs';
10
10
  import { C as Client$4 } from './app.d-BOR23dso.cjs';
11
11
  import { C as Client$5 } from './audit-logs.d-BRToFqeX.cjs';
12
- import { C as Client$6 } from './automation.d-DS_YXDE8.cjs';
12
+ import { C as Client$6 } from './automation.d-Beojxb43.cjs';
13
13
  import { C as Client$7 } from './billing.d-Bs8Ku9qE.cjs';
14
14
  import { C as Client$8 } from './blueprint-manifest.d-2-TORV8o.cjs';
15
15
  import { C as Client$9 } from './calendar.d-BEjLDagH.cjs';
16
16
  import { C as Client$a } from './configuration-hub.d-CbSJDa7k.cjs';
17
17
  import { C as Client$b } from './consent.d-C2PROHhX.cjs';
18
- import { C as Client$c } from './customer-portal.d-C9TeumWq.cjs';
18
+ import { C as Client$c } from './customer-portal.d-dgnYw5xb.cjs';
19
19
  import { C as Client$d } from './dashboard.d-CsGcA74I.cjs';
20
20
  import { C as Client$e } from './data-governance.d-BbZ466j5.cjs';
21
21
  import { C as Client$f } from './deduplication.d-D5GYddVu.cjs';
@@ -51,7 +51,7 @@ import { C as Client$I } from './targeting.d-Bq3onSes.cjs';
51
51
  import { C as Client$J } from './template-variables.d-Ble9TSBa.cjs';
52
52
  import { C as Client$K } from './user.d-L-C7_K84.cjs';
53
53
  import { C as Client$L } from './validation-rules.d-Db5c5zTf.cjs';
54
- import { C as Client$M } from './webhooks.d-CVTTnVT9.cjs';
54
+ import { C as Client$M } from './webhooks.d-DytMQF8m.cjs';
55
55
  import { C as Client$N } from './workflow.d-eFv0ecBi.cjs';
56
56
  import { C as Client$O } from './workflow-definition.d-DOeb0KVV.cjs';
57
57
 
package/dist/index.d.ts CHANGED
@@ -9,13 +9,13 @@ import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.js';
9
9
  import { C as Client$3 } from './ai-agents.d-D-7bTH-9.js';
10
10
  import { C as Client$4 } from './app.d-BOR23dso.js';
11
11
  import { C as Client$5 } from './audit-logs.d-BRToFqeX.js';
12
- import { C as Client$6 } from './automation.d-DS_YXDE8.js';
12
+ import { C as Client$6 } from './automation.d-Beojxb43.js';
13
13
  import { C as Client$7 } from './billing.d-Bs8Ku9qE.js';
14
14
  import { C as Client$8 } from './blueprint-manifest.d-2-TORV8o.js';
15
15
  import { C as Client$9 } from './calendar.d-BEjLDagH.js';
16
16
  import { C as Client$a } from './configuration-hub.d-CbSJDa7k.js';
17
17
  import { C as Client$b } from './consent.d-C2PROHhX.js';
18
- import { C as Client$c } from './customer-portal.d-C9TeumWq.js';
18
+ import { C as Client$c } from './customer-portal.d-dgnYw5xb.js';
19
19
  import { C as Client$d } from './dashboard.d-CsGcA74I.js';
20
20
  import { C as Client$e } from './data-governance.d-BbZ466j5.js';
21
21
  import { C as Client$f } from './deduplication.d-D5GYddVu.js';
@@ -51,7 +51,7 @@ import { C as Client$I } from './targeting.d-Bq3onSes.js';
51
51
  import { C as Client$J } from './template-variables.d-Ble9TSBa.js';
52
52
  import { C as Client$K } from './user.d-L-C7_K84.js';
53
53
  import { C as Client$L } from './validation-rules.d-Db5c5zTf.js';
54
- import { C as Client$M } from './webhooks.d-CVTTnVT9.js';
54
+ import { C as Client$M } from './webhooks.d-DytMQF8m.js';
55
55
  import { C as Client$N } from './workflow.d-eFv0ecBi.js';
56
56
  import { C as Client$O } from './workflow-definition.d-DOeb0KVV.js';
57
57
 
package/dist/index.js CHANGED
@@ -158,7 +158,7 @@ import {
158
158
  expand,
159
159
  help,
160
160
  openapi
161
- } from "./chunk-CF2RGSFQ.js";
161
+ } from "./chunk-2EYCMVMS.js";
162
162
  import {
163
163
  __require
164
164
  } from "./chunk-YPSWSI3M.js";
File without changes
@@ -0,0 +1,7 @@
1
+ import "./chunk-YPSWSI3M.js";
2
+
3
+ // src/docs/webhooks.json
4
+ var webhooks_default = '# Webhooks\n\n- **Base URL:** `https://webhooks.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/webhooks](https://docs.epilot.io/api/webhooks)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.webhooks.getPublicKey(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/webhooks\'\n\nconst webhooksClient = getClient()\nauthorize(webhooksClient, () => \'<token>\')\nconst { data } = await webhooksClient.getPublicKey(...)\n```\n\n## Operations\n\n**webhooks**\n- [`getPublicKey`](#getpublickey)\n- [`getConfiguredEvents`](#getconfiguredevents)\n- [`getConfigs`](#getconfigs)\n- [`createConfig`](#createconfig)\n- [`getConfig`](#getconfig)\n- [`updateConfig`](#updateconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`testOAuth`](#testoauth)\n- [`triggerWebhook`](#triggerwebhook)\n- [`batchReplayEvents`](#batchreplayevents)\n- [`getEventById`](#geteventbyid)\n- [`replayEvent`](#replayevent)\n- [`getWebhookExample`](#getwebhookexample)\n\n**Events**\n- [`getWebhookEventsV2`](#getwebhookeventsv2)\n\n**Schemas**\n- [`PublicKeyResponse`](#publickeyresponse)\n- [`SearchOptions`](#searchoptions)\n- [`EventListResponse`](#eventlistresponse)\n- [`HttpMethod`](#httpmethod)\n- [`AuthType`](#authtype)\n- [`Filter`](#filter)\n- [`WebhookCondition`](#webhookcondition)\n- [`WebhookConditionGroup`](#webhookconditiongroup)\n- [`Auth`](#auth)\n- [`BasicAuthConfig`](#basicauthconfig)\n- [`OAuthConfig`](#oauthconfig)\n- [`ApiKeyConfig`](#apikeyconfig)\n- [`WebhookConfig`](#webhookconfig)\n- [`EventConfigResp`](#eventconfigresp)\n- [`EventConfigEntry`](#eventconfigentry)\n- [`ErrorResp`](#errorresp)\n- [`TriggerWebhookResp`](#triggerwebhookresp)\n- [`PayloadConfiguration`](#payloadconfiguration)\n- [`CustomHeader`](#customheader)\n- [`CustomOAuthParameter`](#customoauthparameter)\n- [`Metadata`](#metadata)\n- [`ExecutionPayload`](#executionpayload)\n- [`WebhookEvent`](#webhookevent)\n- [`ExampleRequest`](#examplerequest)\n- [`ExampleResponse`](#exampleresponse)\n- [`TestOAuthResponse`](#testoauthresponse)\n- [`ReplayRequest`](#replayrequest)\n- [`BatchReplayRequest`](#batchreplayrequest)\n\n### `getPublicKey`\n\nReturns the platform-level Ed25519 public key used to verify\nasymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is requ\n\n`GET /v1/webhooks/.well-known/public-key`\n\n```ts\nconst { data } = await client.getPublicKey({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "public_key": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEA...\\n-----END PUBLIC KEY-----\\n",\n "algorithm": "ed25519",\n "issuer": "epilot"\n}\n```\n\n</details>\n\n---\n\n### `getConfiguredEvents`\n\nRetrieve events that can trigger webhooks\n\n`GET /v1/webhooks/configured-events`\n\n```ts\nconst { data } = await client.getConfiguredEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "customer_request_created",\n "eventLabel": "Customer Request Created"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConfigs`\n\nSearch Webhook Client Configs\n\n`GET /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.getConfigs({\n eventName: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `createConfig`\n\nCreate Webhook Client Config\n\n`POST /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.createConfig(\n null,\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet webhook config by id\n\n`GET /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.getConfig({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `updateConfig`\n\nUpdate Webhook Client Config\n\n`PUT /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.updateConfig(\n {\n configId: \'example\',\n },\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete Webhook Client Config\n\n`DELETE /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.deleteConfig({\n configId: \'example\',\n})\n```\n\n---\n\n### `testOAuth`\n\nTest OAuth connection\n\n`POST /v1/webhooks/configs/{configId}/test-oauth`\n\n```ts\nconst { data } = await client.testOAuth({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "expires_in": 3600,\n "token_type": "Bearer",\n "message": "OAuth token exchange successful"\n}\n```\n\n</details>\n\n---\n\n### `triggerWebhook`\n\ntriggers a webhook event either async or sync\n\n`POST /v1/webhooks/configs/{configId}/trigger`\n\n```ts\nconst { data } = await client.triggerWebhook(\n {\n sync: true,\n configId: \'example\',\n },\n {\n metadata: {\n action: \'Manual triggered by user with id 123456\',\n origin: \'string\',\n creation_timestamp: \'string\',\n webhook_id: \'string\',\n webhook_name: \'string\',\n automation_name: \'string\',\n organization_id: \'string\',\n user_id: \'string\',\n correlation_id: \'string\',\n execution_id: \'string\',\n action_id: \'string\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status_code": "string",\n "message": "string",\n "body": {},\n "code": "string",\n "status": "succeeded",\n "start_date": "string",\n "end_date": "string",\n "event_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `batchReplayEvents`\n\nReplay a batch of webhook events\n\n`POST /v1/webhooks/configs/{configId}/events/replay-batch`\n\n```ts\nconst { data } = await client.batchReplayEvents(\n {\n configId: \'example\',\n },\n {\n eventIds: [\'2f1b7cf8-ff55-4359-966f-e56f39a52c94\', \'48c984bf-466b-470b-b743-d07cea168243\'],\n reapply_transform: false\n },\n)\n```\n\n---\n\n### `getEventById`\n\nGet a webhook event by its id\n\n`GET /v1/webhooks/configs/{configId}/events/{eventId}`\n\n```ts\nconst { data } = await client.getEventById({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string",\n "original_payload": "string",\n "retry_attempt": 0,\n "can_reapply_transform": true,\n "can_reapply_transform_reason": "available"\n}\n```\n\n</details>\n\n---\n\n### `replayEvent`\n\nReplay a webhook event\n\n`POST /v1/webhooks/configs/{configId}/events/{eventId}/replay`\n\n```ts\nconst { data } = await client.replayEvent(\n {\n configId: \'example\',\n eventId: \'example\',\n },\n {\n reapply_transform: false\n },\n)\n```\n\n---\n\n### `getWebhookExample`\n\nGenerate an example payload for a webhook configuration based on trigger type\n\n`POST /v1/webhooks/configs/{configId}/example`\n\n```ts\nconst { data } = await client.getWebhookExample(\n {\n configId: \'example\',\n },\n {\n automation_id: \'automation_123\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "entity": {},\n "relations": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `getWebhookEventsV2`\n\nList webhook events and filter them by status, timestamp, etc.\n\n`POST /v2/webhooks/configs/{configId}/events`\n\n```ts\nconst { data } = await client.getWebhookEventsV2(\n {\n configId: \'example\',\n },\n {\n limit: 25,\n cursor: {\n created_at: \'2025-10-31T12:34:56Z\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\',\n status: \'succeeded\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "data": [\n {\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string",\n "original_payload": "string",\n "retry_attempt": 0,\n "can_reapply_transform": true,\n "can_reapply_transform_reason": "available"\n }\n ],\n "next_cursor": {\n "created_at": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n },\n "has_more": true\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `PublicKeyResponse`\n\n```ts\ntype PublicKeyResponse = {\n public_key: string\n algorithm: string\n issuer?: string\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n limit?: number\n cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n status?: "succeeded" | "failed" | "skipped"\n}\n```\n\n### `EventListResponse`\n\n```ts\ntype EventListResponse = {\n data?: Array<{\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: { ... }\n message?: { ... }\n body?: { ... }\n code?: { ... }\n }\n metadata?: {\n action?: { ... }\n origin?: { ... }\n creation_timestamp?: { ... }\n webhook_id?: { ... }\n webhook_name?: { ... }\n automation_name?: { ... }\n organization_id: { ... }\n user_id?: { ... }\n correlation_id?: { ... }\n execution_id?: { ... }\n action_id?: { ... }\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n original_payload?: string\n retry_attempt?: number\n can_reapply_transform?: boolean\n can_reapply_transform_reason?: "available" | "no_transform_configured" | "no_original_source"\n }>\n next_cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n has_more?: boolean\n}\n```\n\n### `HttpMethod`\n\n```ts\ntype HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n```\n\n### `AuthType`\n\n```ts\ntype AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n```\n\n### `Filter`\n\n```ts\ntype Filter = {\n keyToFilter: string\n supportedValues: string[]\n}\n```\n\n### `WebhookCondition`\n\nA condition that must be met for the webhook to fire.\n\n```ts\ntype WebhookCondition = {\n field: string\n operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n}\n```\n\n### `WebhookConditionGroup`\n\nA group of conditions with a logical operator. Multiple conditions are AND-ed by default.\n\n```ts\ntype WebhookConditionGroup = {\n conditions?: Array<{\n field: string\n operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n }>\n logical_operator?: "AND" | "OR"\n}\n```\n\n### `Auth`\n\n```ts\ntype Auth = {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n }\n oauthConfig?: {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: { ... }\n key: { ... }\n value: { ... }\n }>\n }\n apiKeyConfig?: {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n }\n}\n```\n\n### `BasicAuthConfig`\n\nTo be sent only if authType is BASIC\n\n```ts\ntype BasicAuthConfig = {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n}\n```\n\n### `OAuthConfig`\n\nTo be sent only if authType is OAUTH_CLIENT_CREDENTIALS\n\n```ts\ntype OAuthConfig = {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: "body" | "query" | "header"\n key: string\n value: string\n }>\n}\n```\n\n### `ApiKeyConfig`\n\nTo be sent only if authType is API_KEY\n\n```ts\ntype ApiKeyConfig = {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n}\n```\n\n### `WebhookConfig`\n\n```ts\ntype WebhookConfig = {\n id?: string\n name: string\n eventName: string\n eventVersion?: string\n url?: string\n creationTime?: string\n updatedTime?: string\n httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n enabled?: boolean\n auth?: {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: { ... }\n password?: { ... }\n passwordIsEnvVar?: { ... }\n }\n oauthConfig?: {\n clientId: { ... }\n clientSecret?: { ... }\n clientSecretIsEnvVar?: { ... }\n endpoint: { ... }\n httpMethod: { ... }\n customParameterList?: { ... }\n }\n apiKeyConfig?: {\n keyName: { ... }\n keyValue?: { ... }\n keyValueIsEnvVar?: { ... }\n }\n }\n filter?: {\n keyToFilter: string\n supportedValues: string[]\n }\n payloadConfiguration?: {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n apply_changesets?: boolean\n custom_headers?: Record<string, string>\n }\n enableStaticIP?: boolean\n protected?: boolean\n secureProxy?: {\n integration_id: string // uuid\n use_case_slug: string\n }\n status?: "active" | "inactive" | "incomplete"\n jsonataExpression?: string\n deliveryMode?: "json_base64" | "binary_multipart"\n multipartConfig?: {\n fileFieldName?: string\n fileFieldStrategy?: "single" | "multi"\n fileSource?: string\n extraFields?: Record<string, string>\n }\n retryPolicy?: {\n enabled: boolean\n maxAttempts?: number\n }\n filterConditions?: {\n conditions?: Array<{\n field: { ... }\n operation: { ... }\n values?: { ... }\n field_type?: { ... }\n is_array_field?: { ... }\n repeatable_item_op?: { ... }\n }>\n logical_operator?: "AND" | "OR"\n }\n _manifest?: string // uuid[]\n signingSecret?: string\n}\n```\n\n### `EventConfigResp`\n\n```ts\ntype EventConfigResp = Array<{\n eventName?: string\n eventLabel?: string\n}>\n```\n\n### `EventConfigEntry`\n\n```ts\ntype EventConfigEntry = {\n eventName?: string\n eventLabel?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n}\n```\n\n### `TriggerWebhookResp`\n\n```ts\ntype TriggerWebhookResp = {\n status_code?: string\n message?: string\n body?: object\n code?: string\n status?: "succeeded" | "failed"\n start_date?: string\n end_date?: string\n event_id: string\n}\n```\n\n### `PayloadConfiguration`\n\nConfiguration for the webhook payload\n\n```ts\ntype PayloadConfiguration = {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n apply_changesets?: boolean\n custom_headers?: Record<string, string>\n}\n```\n\n### `CustomHeader`\n\nObject representing custom headers as key-value pairs.\n\n```ts\ntype CustomHeader = Record<string, string>\n```\n\n### `CustomOAuthParameter`\n\nCustom key/value pair of either type body, query or header\n\n```ts\ntype CustomOAuthParameter = {\n type: "body" | "query" | "header"\n key: string\n value: string\n}\n```\n\n### `Metadata`\n\nContains the metadata about the configured event\n\n```ts\ntype Metadata = {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n}\n```\n\n### `ExecutionPayload`\n\nPayload for triggering a webhook\n\n```ts\ntype ExecutionPayload = {\n metadata: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n}\n```\n\n### `WebhookEvent`\n\n```ts\ntype WebhookEvent = {\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: number\n message?: string\n body?: object\n code?: string\n }\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n original_payload?: string\n retry_attempt?: number\n can_reapply_transform?: boolean\n can_reapply_transform_reason?: "available" | "no_transform_configured" | "no_original_source"\n}\n```\n\n### `ExampleRequest`\n\n```ts\ntype ExampleRequest = {\n automation_id?: string\n}\n```\n\n### `ExampleResponse`\n\n```ts\ntype ExampleResponse = {\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n entity?: Record<string, unknown>\n relations?: Record<string, unknown>[]\n}\n```\n\n### `TestOAuthResponse`\n\n```ts\ntype TestOAuthResponse = {\n success: boolean\n expires_in?: number\n token_type?: string\n message: string\n}\n```\n\n### `ReplayRequest`\n\n```ts\ntype ReplayRequest = {\n reapply_transform?: boolean\n}\n```\n\n### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n eventIds: string[]\n reapply_transform?: boolean\n}\n```\n';
5
+ export {
6
+ webhooks_default as default
7
+ };
@@ -0,0 +1,7 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
2
+
3
+ // src/docs/webhooks.json
4
+ var webhooks_default = '# Webhooks\n\n- **Base URL:** `https://webhooks.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/webhooks](https://docs.epilot.io/api/webhooks)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.webhooks.getPublicKey(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/webhooks\'\n\nconst webhooksClient = getClient()\nauthorize(webhooksClient, () => \'<token>\')\nconst { data } = await webhooksClient.getPublicKey(...)\n```\n\n## Operations\n\n**webhooks**\n- [`getPublicKey`](#getpublickey)\n- [`getConfiguredEvents`](#getconfiguredevents)\n- [`getConfigs`](#getconfigs)\n- [`createConfig`](#createconfig)\n- [`getConfig`](#getconfig)\n- [`updateConfig`](#updateconfig)\n- [`deleteConfig`](#deleteconfig)\n- [`testOAuth`](#testoauth)\n- [`triggerWebhook`](#triggerwebhook)\n- [`batchReplayEvents`](#batchreplayevents)\n- [`getEventById`](#geteventbyid)\n- [`replayEvent`](#replayevent)\n- [`getWebhookExample`](#getwebhookexample)\n\n**Events**\n- [`getWebhookEventsV2`](#getwebhookeventsv2)\n\n**Schemas**\n- [`PublicKeyResponse`](#publickeyresponse)\n- [`SearchOptions`](#searchoptions)\n- [`EventListResponse`](#eventlistresponse)\n- [`HttpMethod`](#httpmethod)\n- [`AuthType`](#authtype)\n- [`Filter`](#filter)\n- [`WebhookCondition`](#webhookcondition)\n- [`WebhookConditionGroup`](#webhookconditiongroup)\n- [`Auth`](#auth)\n- [`BasicAuthConfig`](#basicauthconfig)\n- [`OAuthConfig`](#oauthconfig)\n- [`ApiKeyConfig`](#apikeyconfig)\n- [`WebhookConfig`](#webhookconfig)\n- [`EventConfigResp`](#eventconfigresp)\n- [`EventConfigEntry`](#eventconfigentry)\n- [`ErrorResp`](#errorresp)\n- [`TriggerWebhookResp`](#triggerwebhookresp)\n- [`PayloadConfiguration`](#payloadconfiguration)\n- [`CustomHeader`](#customheader)\n- [`CustomOAuthParameter`](#customoauthparameter)\n- [`Metadata`](#metadata)\n- [`ExecutionPayload`](#executionpayload)\n- [`WebhookEvent`](#webhookevent)\n- [`ExampleRequest`](#examplerequest)\n- [`ExampleResponse`](#exampleresponse)\n- [`TestOAuthResponse`](#testoauthresponse)\n- [`ReplayRequest`](#replayrequest)\n- [`BatchReplayRequest`](#batchreplayrequest)\n\n### `getPublicKey`\n\nReturns the platform-level Ed25519 public key used to verify\nasymmetric (v1a) webhook signatures. This endpoint is unauthenticated since the public key is not a secret, but the orgId parameter is requ\n\n`GET /v1/webhooks/.well-known/public-key`\n\n```ts\nconst { data } = await client.getPublicKey({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "public_key": "-----BEGIN PUBLIC KEY-----\\nMCowBQYDK2VwAyEA...\\n-----END PUBLIC KEY-----\\n",\n "algorithm": "ed25519",\n "issuer": "epilot"\n}\n```\n\n</details>\n\n---\n\n### `getConfiguredEvents`\n\nRetrieve events that can trigger webhooks\n\n`GET /v1/webhooks/configured-events`\n\n```ts\nconst { data } = await client.getConfiguredEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "customer_request_created",\n "eventLabel": "Customer Request Created"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConfigs`\n\nSearch Webhook Client Configs\n\n`GET /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.getConfigs({\n eventName: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n }\n]\n```\n\n</details>\n\n---\n\n### `createConfig`\n\nCreate Webhook Client Config\n\n`POST /v1/webhooks/configs`\n\n```ts\nconst { data } = await client.createConfig(\n null,\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `getConfig`\n\nGet webhook config by id\n\n`GET /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.getConfig({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `updateConfig`\n\nUpdate Webhook Client Config\n\n`PUT /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.updateConfig(\n {\n configId: \'example\',\n },\n {\n eventName: \'CustomerRequest_Created\',\n url: \'https://my-partner-service.api.com\',\n httpMethod: \'POST\',\n enabled: true,\n auth: {\n authType: \'BASIC\',\n basicAuthConfig: {\n username: \'secretUsername\',\n password: \'secret7825@!\'\n }\n },\n filter: {\n keyToFilter: \'customer_request.productId\',\n supportedValues: [\'2324245\', \'5253642\']\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "eventName": "CustomerRequest_Created",\n "url": "https://my-partner-service.api.com",\n "httpMethod": "POST",\n "enabled": true,\n "auth": {\n "authType": "BASIC",\n "basicAuthConfig": {\n "username": "secretUsername",\n "password": "secret7825@!"\n }\n },\n "filter": {\n "keyToFilter": "customer_request.productId",\n "supportedValues": ["2324245", "5253642"]\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteConfig`\n\nDelete Webhook Client Config\n\n`DELETE /v1/webhooks/configs/{configId}`\n\n```ts\nconst { data } = await client.deleteConfig({\n configId: \'example\',\n})\n```\n\n---\n\n### `testOAuth`\n\nTest OAuth connection\n\n`POST /v1/webhooks/configs/{configId}/test-oauth`\n\n```ts\nconst { data } = await client.testOAuth({\n configId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "expires_in": 3600,\n "token_type": "Bearer",\n "message": "OAuth token exchange successful"\n}\n```\n\n</details>\n\n---\n\n### `triggerWebhook`\n\ntriggers a webhook event either async or sync\n\n`POST /v1/webhooks/configs/{configId}/trigger`\n\n```ts\nconst { data } = await client.triggerWebhook(\n {\n sync: true,\n configId: \'example\',\n },\n {\n metadata: {\n action: \'Manual triggered by user with id 123456\',\n origin: \'string\',\n creation_timestamp: \'string\',\n webhook_id: \'string\',\n webhook_name: \'string\',\n automation_name: \'string\',\n organization_id: \'string\',\n user_id: \'string\',\n correlation_id: \'string\',\n execution_id: \'string\',\n action_id: \'string\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status_code": "string",\n "message": "string",\n "body": {},\n "code": "string",\n "status": "succeeded",\n "start_date": "string",\n "end_date": "string",\n "event_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `batchReplayEvents`\n\nReplay a batch of webhook events\n\n`POST /v1/webhooks/configs/{configId}/events/replay-batch`\n\n```ts\nconst { data } = await client.batchReplayEvents(\n {\n configId: \'example\',\n },\n {\n eventIds: [\'2f1b7cf8-ff55-4359-966f-e56f39a52c94\', \'48c984bf-466b-470b-b743-d07cea168243\'],\n reapply_transform: false\n },\n)\n```\n\n---\n\n### `getEventById`\n\nGet a webhook event by its id\n\n`GET /v1/webhooks/configs/{configId}/events/{eventId}`\n\n```ts\nconst { data } = await client.getEventById({\n configId: \'example\',\n eventId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string",\n "original_payload": "string",\n "retry_attempt": 0,\n "can_reapply_transform": true,\n "can_reapply_transform_reason": "available"\n}\n```\n\n</details>\n\n---\n\n### `replayEvent`\n\nReplay a webhook event\n\n`POST /v1/webhooks/configs/{configId}/events/{eventId}/replay`\n\n```ts\nconst { data } = await client.replayEvent(\n {\n configId: \'example\',\n eventId: \'example\',\n },\n {\n reapply_transform: false\n },\n)\n```\n\n---\n\n### `getWebhookExample`\n\nGenerate an example payload for a webhook configuration based on trigger type\n\n`POST /v1/webhooks/configs/{configId}/example`\n\n```ts\nconst { data } = await client.getWebhookExample(\n {\n configId: \'example\',\n },\n {\n automation_id: \'automation_123\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "entity": {},\n "relations": [\n {}\n ]\n}\n```\n\n</details>\n\n---\n\n### `getWebhookEventsV2`\n\nList webhook events and filter them by status, timestamp, etc.\n\n`POST /v2/webhooks/configs/{configId}/events`\n\n```ts\nconst { data } = await client.getWebhookEventsV2(\n {\n configId: \'example\',\n },\n {\n limit: 25,\n cursor: {\n created_at: \'2025-10-31T12:34:56Z\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\',\n status: \'succeeded\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "data": [\n {\n "event_id": "string",\n "org_id": "string",\n "webhook_config_id": "string",\n "url": "string",\n "created_at": "2021-04-27T12:01:13.000Z",\n "event_name": "string",\n "http_response": {\n "status_code": 0,\n "message": "string",\n "body": {},\n "code": "string"\n },\n "metadata": {\n "action": "Manual triggered by user with id 123456",\n "origin": "string",\n "creation_timestamp": "string",\n "webhook_id": "string",\n "webhook_name": "string",\n "automation_name": "string",\n "organization_id": "string",\n "user_id": "string",\n "correlation_id": "string",\n "execution_id": "string",\n "action_id": "string"\n },\n "status": "succeeded",\n "http_method": "GET",\n "payload": "string",\n "original_payload": "string",\n "retry_attempt": 0,\n "can_reapply_transform": true,\n "can_reapply_transform_reason": "available"\n }\n ],\n "next_cursor": {\n "created_at": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n },\n "has_more": true\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `PublicKeyResponse`\n\n```ts\ntype PublicKeyResponse = {\n public_key: string\n algorithm: string\n issuer?: string\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n limit?: number\n cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n status?: "succeeded" | "failed" | "skipped"\n}\n```\n\n### `EventListResponse`\n\n```ts\ntype EventListResponse = {\n data?: Array<{\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: { ... }\n message?: { ... }\n body?: { ... }\n code?: { ... }\n }\n metadata?: {\n action?: { ... }\n origin?: { ... }\n creation_timestamp?: { ... }\n webhook_id?: { ... }\n webhook_name?: { ... }\n automation_name?: { ... }\n organization_id: { ... }\n user_id?: { ... }\n correlation_id?: { ... }\n execution_id?: { ... }\n action_id?: { ... }\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n original_payload?: string\n retry_attempt?: number\n can_reapply_transform?: boolean\n can_reapply_transform_reason?: "available" | "no_transform_configured" | "no_original_source"\n }>\n next_cursor?: {\n created_at?: string // date-time\n event_id?: string\n }\n has_more?: boolean\n}\n```\n\n### `HttpMethod`\n\n```ts\ntype HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n```\n\n### `AuthType`\n\n```ts\ntype AuthType = "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n```\n\n### `Filter`\n\n```ts\ntype Filter = {\n keyToFilter: string\n supportedValues: string[]\n}\n```\n\n### `WebhookCondition`\n\nA condition that must be met for the webhook to fire.\n\n```ts\ntype WebhookCondition = {\n field: string\n operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n}\n```\n\n### `WebhookConditionGroup`\n\nA group of conditions with a logical operator. Multiple conditions are AND-ed by default.\n\n```ts\ntype WebhookConditionGroup = {\n conditions?: Array<{\n field: string\n operation: "equals" | "not_equals" | "any_of" | "none_of" | "contains" | "not_contains" | "starts_with" | "ends_with" | "greater_than" | "less_than" | "greater_than_or_equals" | "less_than_or_equals" | "is_empty" | "is_not_empty"\n values?: string[]\n field_type?: "string" | "number" | "boolean" | "date" | "datetime"\n is_array_field?: boolean\n repeatable_item_op?: boolean\n }>\n logical_operator?: "AND" | "OR"\n}\n```\n\n### `Auth`\n\n```ts\ntype Auth = {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n }\n oauthConfig?: {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: { ... }\n key: { ... }\n value: { ... }\n }>\n }\n apiKeyConfig?: {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n }\n}\n```\n\n### `BasicAuthConfig`\n\nTo be sent only if authType is BASIC\n\n```ts\ntype BasicAuthConfig = {\n username: string\n password?: string\n passwordIsEnvVar?: boolean\n}\n```\n\n### `OAuthConfig`\n\nTo be sent only if authType is OAUTH_CLIENT_CREDENTIALS\n\n```ts\ntype OAuthConfig = {\n clientId: string\n clientSecret?: string\n clientSecretIsEnvVar?: boolean\n endpoint: string\n httpMethod: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n customParameterList?: Array<{\n type: "body" | "query" | "header"\n key: string\n value: string\n }>\n}\n```\n\n### `ApiKeyConfig`\n\nTo be sent only if authType is API_KEY\n\n```ts\ntype ApiKeyConfig = {\n keyName: string\n keyValue?: string\n keyValueIsEnvVar?: boolean\n}\n```\n\n### `WebhookConfig`\n\n```ts\ntype WebhookConfig = {\n id?: string\n name: string\n eventName: string\n eventVersion?: string\n url?: string\n creationTime?: string\n updatedTime?: string\n httpMethod?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD"\n enabled?: boolean\n auth?: {\n authType: "BASIC" | "OAUTH_CLIENT_CREDENTIALS" | "API_KEY" | "NONE"\n basicAuthConfig?: {\n username: { ... }\n password?: { ... }\n passwordIsEnvVar?: { ... }\n }\n oauthConfig?: {\n clientId: { ... }\n clientSecret?: { ... }\n clientSecretIsEnvVar?: { ... }\n endpoint: { ... }\n httpMethod: { ... }\n customParameterList?: { ... }\n }\n apiKeyConfig?: {\n keyName: { ... }\n keyValue?: { ... }\n keyValueIsEnvVar?: { ... }\n }\n }\n filter?: {\n keyToFilter: string\n supportedValues: string[]\n }\n payloadConfiguration?: {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n apply_changesets?: boolean\n custom_headers?: Record<string, string>\n }\n enableStaticIP?: boolean\n protected?: boolean\n secureProxy?: {\n integration_id: string // uuid\n use_case_slug: string\n }\n status?: "active" | "inactive" | "incomplete"\n jsonataExpression?: string\n deliveryMode?: "json_base64" | "binary_multipart"\n multipartConfig?: {\n fileFieldName?: string\n fileFieldStrategy?: "single" | "multi"\n fileSource?: string\n extraFields?: Record<string, string>\n }\n retryPolicy?: {\n enabled: boolean\n maxAttempts?: number\n }\n filterConditions?: {\n conditions?: Array<{\n field: { ... }\n operation: { ... }\n values?: { ... }\n field_type?: { ... }\n is_array_field?: { ... }\n repeatable_item_op?: { ... }\n }>\n logical_operator?: "AND" | "OR"\n }\n _manifest?: string // uuid[]\n signingSecret?: string\n}\n```\n\n### `EventConfigResp`\n\n```ts\ntype EventConfigResp = Array<{\n eventName?: string\n eventLabel?: string\n}>\n```\n\n### `EventConfigEntry`\n\n```ts\ntype EventConfigEntry = {\n eventName?: string\n eventLabel?: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n}\n```\n\n### `TriggerWebhookResp`\n\n```ts\ntype TriggerWebhookResp = {\n status_code?: string\n message?: string\n body?: object\n code?: string\n status?: "succeeded" | "failed"\n start_date?: string\n end_date?: string\n event_id: string\n}\n```\n\n### `PayloadConfiguration`\n\nConfiguration for the webhook payload\n\n```ts\ntype PayloadConfiguration = {\n hydrate_entity?: boolean\n include_relations?: boolean\n include_activity?: boolean\n include_changed_attributes?: boolean\n apply_changesets?: boolean\n custom_headers?: Record<string, string>\n}\n```\n\n### `CustomHeader`\n\nObject representing custom headers as key-value pairs.\n\n```ts\ntype CustomHeader = Record<string, string>\n```\n\n### `CustomOAuthParameter`\n\nCustom key/value pair of either type body, query or header\n\n```ts\ntype CustomOAuthParameter = {\n type: "body" | "query" | "header"\n key: string\n value: string\n}\n```\n\n### `Metadata`\n\nContains the metadata about the configured event\n\n```ts\ntype Metadata = {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n}\n```\n\n### `ExecutionPayload`\n\nPayload for triggering a webhook\n\n```ts\ntype ExecutionPayload = {\n metadata: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n}\n```\n\n### `WebhookEvent`\n\n```ts\ntype WebhookEvent = {\n event_id: string\n org_id: string\n webhook_config_id: string\n url?: string\n created_at?: string\n event_name?: string\n http_response?: {\n status_code?: number\n message?: string\n body?: object\n code?: string\n }\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n status?: "succeeded" | "failed" | "in_progress" | "skipped"\n http_method?: "GET" | "POST" | "PUT"\n payload?: string\n original_payload?: string\n retry_attempt?: number\n can_reapply_transform?: boolean\n can_reapply_transform_reason?: "available" | "no_transform_configured" | "no_original_source"\n}\n```\n\n### `ExampleRequest`\n\n```ts\ntype ExampleRequest = {\n automation_id?: string\n}\n```\n\n### `ExampleResponse`\n\n```ts\ntype ExampleResponse = {\n metadata?: {\n action?: string\n origin?: string\n creation_timestamp?: string\n webhook_id?: string\n webhook_name?: string\n automation_name?: string\n organization_id: string\n user_id?: string\n correlation_id?: string\n execution_id?: string\n action_id?: string\n }\n entity?: Record<string, unknown>\n relations?: Record<string, unknown>[]\n}\n```\n\n### `TestOAuthResponse`\n\n```ts\ntype TestOAuthResponse = {\n success: boolean\n expires_in?: number\n token_type?: string\n message: string\n}\n```\n\n### `ReplayRequest`\n\n```ts\ntype ReplayRequest = {\n reapply_transform?: boolean\n}\n```\n\n### `BatchReplayRequest`\n\n```ts\ntype BatchReplayRequest = {\n eventIds: string[]\n reapply_transform?: boolean\n}\n```\n';
5
+
6
+
7
+ exports.default = webhooks_default;
@@ -699,6 +699,10 @@ declare namespace Components {
699
699
  * stringified payload of the webhook request
700
700
  */
701
701
  payload?: string;
702
+ /**
703
+ * Stringified pre-transform original payload — the raw input captured before any JSONata transform was applied. Returned by getEventById for non-catalog events that have a locally stored original source (inline or claim-checked to S3, hydrated here). Omitted when no original source exists or when the payload would exceed the inline response size limit. Catalog-backed events (event_-prefixed) do not carry a local original — their pre-transform payload is sourced from the event catalog instead.
704
+ */
705
+ original_payload?: string;
702
706
  /**
703
707
  * Number of automatic delivery retries that preceded this terminal outcome. 0 means the event was delivered (or finally failed) on the first attempt.
704
708
  */
@@ -699,6 +699,10 @@ declare namespace Components {
699
699
  * stringified payload of the webhook request
700
700
  */
701
701
  payload?: string;
702
+ /**
703
+ * Stringified pre-transform original payload — the raw input captured before any JSONata transform was applied. Returned by getEventById for non-catalog events that have a locally stored original source (inline or claim-checked to S3, hydrated here). Omitted when no original source exists or when the payload would exceed the inline response size limit. Catalog-backed events (event_-prefixed) do not carry a local original — their pre-transform payload is sourced from the event catalog instead.
704
+ */
705
+ original_payload?: string;
702
706
  /**
703
707
  * Number of automatic delivery retries that preceded this terminal outcome. 0 means the event was delivered (or finally failed) on the first attempt.
704
708
  */
@@ -316,7 +316,8 @@ const { data } = await client.getExecutions({
316
316
  "trigger_event": {},
317
317
  "workflow_context": {},
318
318
  "loops": [],
319
- "loop_state": {}
319
+ "loop_state": {},
320
+ "chain": ["string"]
320
321
  }
321
322
  ]
322
323
  }
@@ -389,8 +390,10 @@ const { data } = await client.startExecution(
389
390
  {
390
391
  "id": "string",
391
392
  "schedule_id": "string",
393
+ "evaluation_order": "AFTER_SCHEDULE",
392
394
  "evaluationResult": true,
393
395
  "error_output": {},
396
+ "allow_failure": true,
394
397
  "statements": []
395
398
  }
396
399
  ],
@@ -482,7 +485,8 @@ const { data } = await client.startExecution(
482
485
  "length": 0
483
486
  }
484
487
  ],
485
- "loop_state": {}
488
+ "loop_state": {},
489
+ "chain": ["string"]
486
490
  }
487
491
  ```
488
492
 
@@ -690,8 +694,10 @@ const { data } = await client.getExecution({
690
694
  {
691
695
  "id": "string",
692
696
  "schedule_id": "string",
697
+ "evaluation_order": "AFTER_SCHEDULE",
693
698
  "evaluationResult": true,
694
699
  "error_output": {},
700
+ "allow_failure": true,
695
701
  "statements": []
696
702
  }
697
703
  ],
@@ -783,7 +789,8 @@ const { data } = await client.getExecution({
783
789
  "length": 0
784
790
  }
785
791
  ],
786
- "loop_state": {}
792
+ "loop_state": {},
793
+ "chain": ["string"]
787
794
  }
788
795
  ```
789
796
 
@@ -831,8 +838,10 @@ const { data } = await client.cancelExecution({
831
838
  {
832
839
  "id": "string",
833
840
  "schedule_id": "string",
841
+ "evaluation_order": "AFTER_SCHEDULE",
834
842
  "evaluationResult": true,
835
843
  "error_output": {},
844
+ "allow_failure": true,
836
845
  "statements": []
837
846
  }
838
847
  ],
@@ -924,7 +933,8 @@ const { data } = await client.cancelExecution({
924
933
  "length": 0
925
934
  }
926
935
  ],
927
- "loop_state": {}
936
+ "loop_state": {},
937
+ "chain": ["string"]
928
938
  }
929
939
  ```
930
940
 
@@ -1024,7 +1034,8 @@ const { data } = await client.resumeExecutionWithToken(
1024
1034
  "loops": [
1025
1035
  {}
1026
1036
  ],
1027
- "loop_state": {}
1037
+ "loop_state": {},
1038
+ "chain": ["string"]
1028
1039
  },
1029
1040
  "resumedAction": {
1030
1041
  "id": "9ec3711b-db63-449c-b894-54d5bb622a8f",
@@ -1206,12 +1217,14 @@ type AutomationFlow = {
1206
1217
  conditions?: Array<{
1207
1218
  id?: string
1208
1219
  schedule_id?: string
1220
+ evaluation_order?: "AFTER_SCHEDULE" | "BEFORE_SCHEDULE"
1209
1221
  evaluationResult?: boolean
1210
1222
  error_output?: {
1211
1223
  error_code: { ... }
1212
1224
  error_reason: { ... }
1213
1225
  error_info?: { ... }
1214
1226
  }
1227
+ allow_failure?: boolean
1215
1228
  statements?: Array<{
1216
1229
  id?: { ... }
1217
1230
  source?: { ... }
@@ -1224,8 +1237,6 @@ type AutomationFlow = {
1224
1237
  scheduleApiId?: string
1225
1238
  numberOfUnits?: number
1226
1239
  timePeriod?: "minutes" | "hours" | "days" | "weeks" | "months"
1227
- timeRelation?: "after" | "before"
1228
- source: {
1229
1240
  // ...
1230
1241
  }
1231
1242
  ```
@@ -1298,8 +1309,10 @@ type SearchAutomationsResp = {
1298
1309
  conditions?: Array<{
1299
1310
  id?: { ... }
1300
1311
  schedule_id?: { ... }
1312
+ evaluation_order?: { ... }
1301
1313
  evaluationResult?: { ... }
1302
1314
  error_output?: { ... }
1315
+ allow_failure?: { ... }
1303
1316
  statements?: { ... }
1304
1317
  }>
1305
1318
  schedules?: Array<{
@@ -1339,8 +1352,6 @@ type SearchAutomationsResp = {
1339
1352
  config?: { ... }
1340
1353
  } | {
1341
1354
  type?: { ... }
1342
- config?: { ... }
1343
- } | {
1344
1355
  // ...
1345
1356
  }
1346
1357
  ```
@@ -2971,6 +2982,7 @@ type ConditionStatement = {
2971
2982
  type ActionCondition = {
2972
2983
  id?: string
2973
2984
  schedule_id?: string
2985
+ evaluation_order?: "AFTER_SCHEDULE" | "BEFORE_SCHEDULE"
2974
2986
  evaluationResult?: boolean
2975
2987
  error_output?: {
2976
2988
  error_code: "MAPPING_ERROR" | "REFRESH_RELATIONS_ERROR" | "DUPLICATE_ENTITY_ERROR" | "TRIGGER_WORKFLOW_ERROR" | "TIMEOUT_ERROR" | "BAD_CONFIG" | "INTERNAL_ERROR" | "TRIGGER_WEBHOOK_ERROR" | "TEMPLATE_ERROR" | "INVALID_PAYLOAD" | "INVALID_SCHEDULE_CONFIG" | "CUSTOM_ACTION_ERROR" | "ORDER_CREATION_ERROR" | "DOCUMENT_GENERATION_ERROR" | "BULK_EMAIL_ERROR" | "SHARING_ERROR" | "CANCEL_FLOW_EXECUTION_ERROR" | "METER_READING_NOT_FOUND" | "ENTITY_NOT_FOUND"
@@ -2979,6 +2991,7 @@ type ActionCondition = {
2979
2991
  details?: { ... }
2980
2992
  }
2981
2993
  }
2994
+ allow_failure?: boolean
2982
2995
  statements?: Array<{
2983
2996
  id?: string // uuid
2984
2997
  source?: {
@@ -3061,12 +3074,14 @@ type AutomationExecution = {
3061
3074
  conditions?: Array<{
3062
3075
  id?: string
3063
3076
  schedule_id?: string
3077
+ evaluation_order?: "AFTER_SCHEDULE" | "BEFORE_SCHEDULE"
3064
3078
  evaluationResult?: boolean
3065
3079
  error_output?: {
3066
3080
  error_code: { ... }
3067
3081
  error_reason: { ... }
3068
3082
  error_info?: { ... }
3069
3083
  }
3084
+ allow_failure?: boolean
3070
3085
  statements?: Array<{
3071
3086
  id?: { ... }
3072
3087
  source?: { ... }
@@ -3136,8 +3151,6 @@ type AutomationExecution = {
3136
3151
  } | {
3137
3152
  type?: "create-document"
3138
3153
  config?: {
3139
- template_id?: { ... }
3140
- filename?: { ... }
3141
3154
  // ...
3142
3155
  }
3143
3156
  ```
@@ -3310,8 +3323,10 @@ type GetExecutionsResp = {
3310
3323
  conditions?: Array<{
3311
3324
  id?: { ... }
3312
3325
  schedule_id?: { ... }
3326
+ evaluation_order?: { ... }
3313
3327
  evaluationResult?: { ... }
3314
3328
  error_output?: { ... }
3329
+ allow_failure?: { ... }
3315
3330
  statements?: { ... }
3316
3331
  }>
3317
3332
  schedules?: Array<{
@@ -3383,8 +3398,6 @@ type GetExecutionsResp = {
3383
3398
  config?: { ... }
3384
3399
  }>
3385
3400
  resume_token?: string
3386
- trigger_context?: Record<string, string>
3387
- version?: number
3388
3401
  // ...
3389
3402
  }
3390
3403
  ```
@@ -4260,8 +4273,10 @@ type ResumeResp = {
4260
4273
  conditions?: Array<{
4261
4274
  id?: { ... }
4262
4275
  schedule_id?: { ... }
4276
+ evaluation_order?: { ... }
4263
4277
  evaluationResult?: { ... }
4264
4278
  error_output?: { ... }
4279
+ allow_failure?: { ... }
4265
4280
  statements?: { ... }
4266
4281
  }>
4267
4282
  schedules?: Array<{
@@ -4334,8 +4349,6 @@ type ResumeResp = {
4334
4349
  }>
4335
4350
  resume_token?: string
4336
4351
  trigger_context?: Record<string, string>
4337
- version?: number
4338
- trigger_event?: {
4339
4352
  // ...
4340
4353
  }
4341
4354
  ```
@@ -4196,7 +4196,8 @@ const { data } = await client.checkContactExists(
4196
4196
  contract: {
4197
4197
  contract_number: '123456'
4198
4198
  }
4199
- }
4199
+ },
4200
+ trigger_identifiers_check: true
4200
4201
  },
4201
4202
  )
4202
4203
  ```
@@ -4207,7 +4208,8 @@ const { data } = await client.checkContactExists(
4207
4208
  ```json
4208
4209
  {
4209
4210
  "exists": true,
4210
- "contactId": "5da0a718-c822-403d-9f5d-20d4584e0528"
4211
+ "contactId": "5da0a718-c822-403d-9f5d-20d4584e0528",
4212
+ "reason": "TIMEOUT"
4211
4213
  }
4212
4214
  ```
4213
4215
 
@@ -4239,7 +4241,8 @@ const { data } = await client.checkContactExistsV3(
4239
4241
  contract: {
4240
4242
  contract_number: '123456'
4241
4243
  }
4242
- }
4244
+ },
4245
+ trigger_identifiers_check: true
4243
4246
  },
4244
4247
  )
4245
4248
  ```
@@ -4251,7 +4254,8 @@ const { data } = await client.checkContactExistsV3(
4251
4254
  {
4252
4255
  "exists": true,
4253
4256
  "contactId": "5da0a718-c822-403d-9f5d-20d4584e0528",
4254
- "accountId": "5da0a718-c822-403d-9f5d-20d4584e0528"
4257
+ "accountId": "5da0a718-c822-403d-9f5d-20d4584e0528",
4258
+ "reason": "TIMEOUT"
4255
4259
  }
4256
4260
  ```
4257
4261
 
@@ -10459,6 +10463,7 @@ type ContactCountRequest = {
10459
10463
  type ContactExistsRequest = {
10460
10464
  org_id: string
10461
10465
  registration_identifiers: Record<string, Record<string, string>>
10466
+ trigger_identifiers_check?: boolean
10462
10467
  }
10463
10468
  ```
10464
10469