@epilot/sdk 2.3.8 → 2.3.9

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 (222) hide show
  1. package/dist/apis/access-token.cjs +6 -6
  2. package/dist/apis/access-token.js +1 -1
  3. package/dist/apis/address-suggestions.cjs +6 -6
  4. package/dist/apis/address-suggestions.js +1 -1
  5. package/dist/apis/address.cjs +6 -6
  6. package/dist/apis/address.js +1 -1
  7. package/dist/apis/ai-agents.cjs +6 -6
  8. package/dist/apis/ai-agents.js +1 -1
  9. package/dist/apis/app.cjs +6 -6
  10. package/dist/apis/app.js +1 -1
  11. package/dist/apis/audit-logs.cjs +6 -6
  12. package/dist/apis/audit-logs.js +1 -1
  13. package/dist/apis/automation.cjs +6 -6
  14. package/dist/apis/automation.js +1 -1
  15. package/dist/apis/billing.cjs +6 -6
  16. package/dist/apis/billing.js +1 -1
  17. package/dist/apis/blueprint-manifest.cjs +6 -6
  18. package/dist/apis/blueprint-manifest.js +1 -1
  19. package/dist/apis/configuration-hub.cjs +8 -8
  20. package/dist/apis/configuration-hub.d.cts +2 -2
  21. package/dist/apis/configuration-hub.d.ts +2 -2
  22. package/dist/apis/configuration-hub.js +2 -2
  23. package/dist/apis/consent.cjs +6 -6
  24. package/dist/apis/consent.js +1 -1
  25. package/dist/apis/customer-portal.cjs +6 -6
  26. package/dist/apis/customer-portal.js +1 -1
  27. package/dist/apis/dashboard.cjs +6 -6
  28. package/dist/apis/dashboard.js +1 -1
  29. package/dist/apis/data-governance.cjs +6 -6
  30. package/dist/apis/data-governance.js +1 -1
  31. package/dist/apis/deduplication.cjs +6 -6
  32. package/dist/apis/deduplication.js +1 -1
  33. package/dist/apis/design.cjs +6 -6
  34. package/dist/apis/design.js +1 -1
  35. package/dist/apis/document.cjs +6 -6
  36. package/dist/apis/document.js +1 -1
  37. package/dist/apis/email-settings.cjs +6 -6
  38. package/dist/apis/email-settings.js +1 -1
  39. package/dist/apis/email-template.cjs +6 -6
  40. package/dist/apis/email-template.js +1 -1
  41. package/dist/apis/entity-mapping.cjs +6 -6
  42. package/dist/apis/entity-mapping.js +1 -1
  43. package/dist/apis/entity.cjs +6 -6
  44. package/dist/apis/entity.js +1 -1
  45. package/dist/apis/environments.cjs +6 -6
  46. package/dist/apis/environments.js +1 -1
  47. package/dist/apis/event-catalog.cjs +6 -6
  48. package/dist/apis/event-catalog.js +1 -1
  49. package/dist/apis/file.cjs +6 -6
  50. package/dist/apis/file.js +1 -1
  51. package/dist/apis/iban.cjs +6 -6
  52. package/dist/apis/iban.js +1 -1
  53. package/dist/apis/integration-toolkit.cjs +6 -6
  54. package/dist/apis/integration-toolkit.js +1 -1
  55. package/dist/apis/journey.cjs +6 -6
  56. package/dist/apis/journey.js +1 -1
  57. package/dist/apis/kanban.cjs +6 -6
  58. package/dist/apis/kanban.js +1 -1
  59. package/dist/apis/message.cjs +6 -6
  60. package/dist/apis/message.js +1 -1
  61. package/dist/apis/metering.cjs +6 -6
  62. package/dist/apis/metering.js +1 -1
  63. package/dist/apis/notes.cjs +6 -6
  64. package/dist/apis/notes.js +1 -1
  65. package/dist/apis/notification.cjs +6 -6
  66. package/dist/apis/notification.js +1 -1
  67. package/dist/apis/organization.cjs +6 -6
  68. package/dist/apis/organization.js +1 -1
  69. package/dist/apis/partner-directory.cjs +6 -6
  70. package/dist/apis/partner-directory.js +1 -1
  71. package/dist/apis/permissions.cjs +6 -6
  72. package/dist/apis/permissions.js +1 -1
  73. package/dist/apis/pricing-tier.cjs +6 -6
  74. package/dist/apis/pricing-tier.js +1 -1
  75. package/dist/apis/pricing.cjs +6 -6
  76. package/dist/apis/pricing.js +1 -1
  77. package/dist/apis/purpose.cjs +6 -6
  78. package/dist/apis/purpose.js +1 -1
  79. package/dist/apis/query.cjs +6 -6
  80. package/dist/apis/query.js +1 -1
  81. package/dist/apis/sandbox.cjs +6 -6
  82. package/dist/apis/sandbox.js +1 -1
  83. package/dist/apis/sharing.cjs +6 -6
  84. package/dist/apis/sharing.js +1 -1
  85. package/dist/apis/submission.cjs +6 -6
  86. package/dist/apis/submission.js +1 -1
  87. package/dist/apis/target.cjs +6 -6
  88. package/dist/apis/target.js +1 -1
  89. package/dist/apis/targeting.cjs +6 -6
  90. package/dist/apis/targeting.js +1 -1
  91. package/dist/apis/template-variables.cjs +6 -6
  92. package/dist/apis/template-variables.js +1 -1
  93. package/dist/apis/user.cjs +6 -6
  94. package/dist/apis/user.js +1 -1
  95. package/dist/apis/validation-rules.cjs +6 -6
  96. package/dist/apis/validation-rules.js +1 -1
  97. package/dist/apis/webhooks.cjs +6 -6
  98. package/dist/apis/webhooks.js +1 -1
  99. package/dist/apis/workflow-definition.cjs +6 -6
  100. package/dist/apis/workflow-definition.js +1 -1
  101. package/dist/apis/workflow.cjs +6 -6
  102. package/dist/apis/workflow.js +1 -1
  103. package/dist/chunk-AOFZDDXN.js +14 -0
  104. package/dist/{chunk-6DZXWV2A.cjs → chunk-L37V2R32.cjs} +2 -2
  105. package/dist/{chunk-7TFVO6SP.js → chunk-OMNMMMRJ.js} +2 -2
  106. package/dist/chunk-VFCH5IEL.cjs +14 -0
  107. package/dist/configuration-hub-2F636SNK.js +7 -0
  108. package/dist/configuration-hub-XQGJK2JA.cjs +7 -0
  109. package/dist/{configuration-hub-runtime-TEDEKI7E.js → configuration-hub-runtime-5R6Y4KF7.js} +1 -1
  110. package/dist/{configuration-hub-runtime-B7KKIHHY.cjs → configuration-hub-runtime-TY2X2ECO.cjs} +2 -2
  111. package/dist/configuration-hub.d-DZE3wTQE.d.cts +375 -0
  112. package/dist/configuration-hub.d-DZE3wTQE.d.ts +375 -0
  113. package/dist/index.cjs +10 -10
  114. package/dist/index.d.cts +1 -1
  115. package/dist/index.d.ts +1 -1
  116. package/dist/index.js +2 -2
  117. package/docs/configuration-hub.md +52 -1
  118. package/package.json +1 -1
  119. package/definitions/access-token-runtime.json +0 -1
  120. package/definitions/access-token.json +0 -663
  121. package/definitions/address-runtime.json +0 -1
  122. package/definitions/address-suggestions-runtime.json +0 -1
  123. package/definitions/address-suggestions.json +0 -582
  124. package/definitions/address.json +0 -578
  125. package/definitions/ai-agents-runtime.json +0 -1
  126. package/definitions/ai-agents.json +0 -1711
  127. package/definitions/app-runtime.json +0 -1
  128. package/definitions/app.json +0 -4493
  129. package/definitions/audit-logs-runtime.json +0 -1
  130. package/definitions/audit-logs.json +0 -305
  131. package/definitions/automation-runtime.json +0 -1
  132. package/definitions/automation.json +0 -5028
  133. package/definitions/billing-runtime.json +0 -1
  134. package/definitions/billing.json +0 -837
  135. package/definitions/blueprint-manifest-runtime.json +0 -1
  136. package/definitions/blueprint-manifest.json +0 -4846
  137. package/definitions/configuration-hub-runtime.json +0 -1
  138. package/definitions/configuration-hub.json +0 -399
  139. package/definitions/consent-runtime.json +0 -1
  140. package/definitions/consent.json +0 -344
  141. package/definitions/customer-portal-runtime.json +0 -1
  142. package/definitions/customer-portal.json +0 -16045
  143. package/definitions/dashboard-runtime.json +0 -1
  144. package/definitions/dashboard.json +0 -484
  145. package/definitions/data-governance-runtime.json +0 -1
  146. package/definitions/data-governance.json +0 -1126
  147. package/definitions/deduplication-runtime.json +0 -1
  148. package/definitions/deduplication.json +0 -314
  149. package/definitions/design-runtime.json +0 -1
  150. package/definitions/design.json +0 -1722
  151. package/definitions/document-runtime.json +0 -1
  152. package/definitions/document.json +0 -758
  153. package/definitions/email-settings-runtime.json +0 -1
  154. package/definitions/email-settings.json +0 -2777
  155. package/definitions/email-template-runtime.json +0 -1
  156. package/definitions/email-template.json +0 -1441
  157. package/definitions/entity-mapping-runtime.json +0 -1
  158. package/definitions/entity-mapping.json +0 -1642
  159. package/definitions/entity-runtime.json +0 -1
  160. package/definitions/entity.json +0 -10474
  161. package/definitions/environments-runtime.json +0 -1
  162. package/definitions/environments.json +0 -539
  163. package/definitions/event-catalog-runtime.json +0 -1
  164. package/definitions/event-catalog.json +0 -1051
  165. package/definitions/file-runtime.json +0 -1
  166. package/definitions/file.json +0 -2842
  167. package/definitions/iban-runtime.json +0 -1
  168. package/definitions/iban.json +0 -132
  169. package/definitions/integration-toolkit-runtime.json +0 -1
  170. package/definitions/integration-toolkit.json +0 -7998
  171. package/definitions/journey-runtime.json +0 -1
  172. package/definitions/journey.json +0 -2603
  173. package/definitions/kanban-runtime.json +0 -1
  174. package/definitions/kanban.json +0 -1505
  175. package/definitions/message-runtime.json +0 -1
  176. package/definitions/message.json +0 -2872
  177. package/definitions/metering-runtime.json +0 -1
  178. package/definitions/metering.json +0 -2321
  179. package/definitions/notes-runtime.json +0 -1
  180. package/definitions/notes.json +0 -1531
  181. package/definitions/notification-runtime.json +0 -1
  182. package/definitions/notification.json +0 -1425
  183. package/definitions/organization-runtime.json +0 -1
  184. package/definitions/organization.json +0 -1192
  185. package/definitions/partner-directory-runtime.json +0 -1
  186. package/definitions/partner-directory.json +0 -2284
  187. package/definitions/permissions-runtime.json +0 -1
  188. package/definitions/permissions.json +0 -1515
  189. package/definitions/pricing-runtime.json +0 -1
  190. package/definitions/pricing-tier-runtime.json +0 -1
  191. package/definitions/pricing-tier.json +0 -105
  192. package/definitions/pricing.json +0 -9884
  193. package/definitions/purpose-runtime.json +0 -1
  194. package/definitions/purpose.json +0 -524
  195. package/definitions/query-runtime.json +0 -1
  196. package/definitions/query.json +0 -3178
  197. package/definitions/sandbox-runtime.json +0 -1
  198. package/definitions/sandbox.json +0 -453
  199. package/definitions/sharing-runtime.json +0 -1
  200. package/definitions/sharing.json +0 -956
  201. package/definitions/submission-runtime.json +0 -1
  202. package/definitions/submission.json +0 -313
  203. package/definitions/targeting-runtime.json +0 -1
  204. package/definitions/targeting.json +0 -1474
  205. package/definitions/template-variables-runtime.json +0 -1
  206. package/definitions/template-variables.json +0 -1416
  207. package/definitions/user-runtime.json +0 -1
  208. package/definitions/user.json +0 -2460
  209. package/definitions/validation-rules-runtime.json +0 -1
  210. package/definitions/validation-rules.json +0 -1491
  211. package/definitions/webhooks-runtime.json +0 -1
  212. package/definitions/webhooks.json +0 -1634
  213. package/definitions/workflow-definition-runtime.json +0 -1
  214. package/definitions/workflow-definition.json +0 -3302
  215. package/definitions/workflow-runtime.json +0 -1
  216. package/definitions/workflow.json +0 -4248
  217. package/dist/chunk-4JAOFRYX.js +0 -14
  218. package/dist/chunk-Q7OKRNUG.cjs +0 -14
  219. package/dist/configuration-hub-LKSRCGYT.cjs +0 -7
  220. package/dist/configuration-hub-TZ2ULWV4.js +0 -7
  221. package/dist/configuration-hub.d-CqvhcMOn.d.cts +0 -166
  222. package/dist/configuration-hub.d-CqvhcMOn.d.ts +0 -166
package/definitions/workflow-definition.json DELETED
@@ -1,3302 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "Workflows Definitions",
5
- "version": "1.1.0",
6
- "description": "Service for Workflow Definitions for different processes inside of an Organization\n"
7
- },
8
- "servers": [
9
- {
10
- "url": "https://workflows-definition.sls.epilot.io"
11
- }
12
- ],
13
- "security": [
14
- {
15
- "BearerAuth": []
16
- }
17
- ],
18
- "paths": {
19
- "/v1/workflows/limits/max-allowed": {
20
- "get": {
21
- "operationId": "getMaxAllowedLimit",
22
- "summary": "getMaxAllowedLimit",
23
- "description": "Get limits and number of created executions for an Organization.",
24
- "tags": [
25
- "Workflows"
26
- ],
27
- "responses": {
28
- "200": {
29
- "description": "A combo of current number of workflows, and the max allowed number of workflows.",
30
- "content": {
31
- "application/json": {
32
- "schema": {
33
- "$ref": "#/components/schemas/MaxAllowedLimit"
34
- },
35
- "example": {
36
- "currentNoOfWorkflows": 5,
37
- "maxAllowed": 7
38
- }
39
- }
40
- }
41
- },
42
- "500": {
43
- "description": "Other errors",
44
- "content": {
45
- "application/json": {
46
- "schema": {
47
- "$ref": "#/components/schemas/ErrorResp"
48
- }
49
- }
50
- }
51
- }
52
- }
53
- }
54
- },
55
- "/v1/workflows/definitions": {
56
- "get": {
57
- "operationId": "getDefinitions",
58
- "summary": "getDefinitions",
59
- "description": "Retrieve all Workflow Definitions from an Organization",
60
- "tags": [
61
- "Workflows"
62
- ],
63
- "responses": {
64
- "200": {
65
- "description": "Success - definitions loaded with success. Empty array if org has no definitions.",
66
- "content": {
67
- "application/json": {
68
- "schema": {
69
- "type": "array",
70
- "items": {
71
- "$ref": "#/components/schemas/WorkflowDefinition"
72
- }
73
- },
74
- "example": [
75
- {
76
- "id": "25n2k52ja",
77
- "name": "Lead Qualification",
78
- "assignedTo": [
79
- "18625",
80
- "90252"
81
- ],
82
- "description": "Lead Qualification description",
83
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
84
- "creationTime": "2021-08-04T21:13:50.373Z",
85
- "dueDate": "2021-08-04T21:13:50.373Z",
86
- "flow": [
87
- {
88
- "id": "5892na2",
89
- "name": "Initial Information Gathering",
90
- "order": 1,
91
- "type": "SECTION",
92
- "steps": [
93
- {
94
- "id": "2hja82a",
95
- "name": "Call client and confirm address and product",
96
- "type": "STEP",
97
- "order": 1,
98
- "assignedTo": [
99
- "123482"
100
- ]
101
- },
102
- {
103
- "id": "ga92ha2",
104
- "name": "Check product availability",
105
- "type": "STEP",
106
- "order": 2,
107
- "assignedTo": [
108
- "123482"
109
- ]
110
- },
111
- {
112
- "id": "jga92ha",
113
- "name": "Send email confirming contact with the client",
114
- "type": "STEP",
115
- "order": 3,
116
- "assignedTo": [
117
- "123482"
118
- ]
119
- }
120
- ]
121
- },
122
- {
123
- "id": "0a7g22a",
124
- "name": "Print and send catalog",
125
- "type": "STEP",
126
- "order": 2,
127
- "assignedTo": [
128
- "123482"
129
- ]
130
- }
131
- ]
132
- }
133
- ]
134
- }
135
- }
136
- },
137
- "500": {
138
- "description": "Other errors",
139
- "content": {
140
- "application/json": {
141
- "schema": {
142
- "$ref": "#/components/schemas/ErrorResp"
143
- }
144
- }
145
- }
146
- }
147
- }
148
- },
149
- "post": {
150
- "operationId": "createDefinition",
151
- "summary": "createDefinition",
152
- "description": "Create a Workflow Definition.",
153
- "tags": [
154
- "Workflows"
155
- ],
156
- "requestBody": {
157
- "description": "Workflow Definition payload",
158
- "required": true,
159
- "content": {
160
- "application/json": {
161
- "schema": {
162
- "$ref": "#/components/schemas/WorkflowDefinition"
163
- },
164
- "example": {
165
- "name": "Lead Qualification",
166
- "description": "Lead Qualification description",
167
- "dueDate": "2022-08-04T12:00:00.000Z",
168
- "assignedTo": [
169
- "952802",
170
- "80225"
171
- ],
172
- "flow": [
173
- {
174
- "name": "Initial Information Gathering",
175
- "order": 1,
176
- "type": "SECTION",
177
- "steps": [
178
- {
179
- "name": "Call client and confirm address and product",
180
- "type": "STEP",
181
- "order": 1,
182
- "assignedTo": [
183
- "123482"
184
- ]
185
- },
186
- {
187
- "name": "Check product availability",
188
- "type": "STEP",
189
- "order": 2,
190
- "assignedTo": [
191
- "123482"
192
- ]
193
- },
194
- {
195
- "name": "Send email confirming contact with the client",
196
- "type": "STEP",
197
- "order": 3,
198
- "assignedTo": [
199
- "123482"
200
- ]
201
- }
202
- ]
203
- },
204
- {
205
- "name": "Print and send catalog",
206
- "type": "STEP",
207
- "order": 2,
208
- "assignedTo": [
209
- "123482"
210
- ]
211
- }
212
- ]
213
- }
214
- }
215
- }
216
- },
217
- "responses": {
218
- "201": {
219
- "description": "Success - if the definition is created successfully",
220
- "content": {
221
- "application/json": {
222
- "schema": {
223
- "$ref": "#/components/schemas/WorkflowDefinition"
224
- },
225
- "example": {
226
- "id": "25n2k52ja",
227
- "name": "Lead Qualification",
228
- "description": "Lead Qualification description",
229
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
230
- "creationTime": "2021-08-04T21:13:50.373Z",
231
- "dueDate": "2022-08-04T12:00:00.000Z",
232
- "assignedTo": [
233
- "952802",
234
- "80225"
235
- ],
236
- "flow": [
237
- {
238
- "id": "5892na2",
239
- "name": "Initial Information Gathering",
240
- "order": 1,
241
- "type": "SECTION",
242
- "steps": [
243
- {
244
- "id": "2hja82a",
245
- "name": "Call client and confirm address and product",
246
- "type": "STEP",
247
- "order": 1,
248
- "assignedTo": [
249
- "48829"
250
- ]
251
- },
252
- {
253
- "id": "ga92ha2",
254
- "name": "Check product availability",
255
- "type": "STEP",
256
- "order": 2,
257
- "assignedTo": [
258
- "45390"
259
- ]
260
- },
261
- {
262
- "id": "jga92ha",
263
- "name": "Send email confirming contact with the client",
264
- "type": "STEP",
265
- "order": 3,
266
- "assignedTo": [
267
- "8230"
268
- ]
269
- }
270
- ]
271
- },
272
- {
273
- "id": "0a7g22a",
274
- "name": "Print and send catalog",
275
- "type": "STEP",
276
- "order": 2,
277
- "assignedTo": [
278
- "8239"
279
- ]
280
- }
281
- ]
282
- }
283
- }
284
- }
285
- },
286
- "400": {
287
- "description": "Validation Errors",
288
- "content": {
289
- "application/json": {
290
- "schema": {
291
- "$ref": "#/components/schemas/ErrorResp"
292
- }
293
- }
294
- }
295
- },
296
- "401": {
297
- "description": "Authentication Errors",
298
- "content": {
299
- "application/json": {
300
- "schema": {
301
- "$ref": "#/components/schemas/ErrorResp"
302
- }
303
- }
304
- }
305
- },
306
- "500": {
307
- "description": "Other errors",
308
- "content": {
309
- "application/json": {
310
- "schema": {
311
- "$ref": "#/components/schemas/ErrorResp"
312
- }
313
- }
314
- }
315
- }
316
- }
317
- }
318
- },
319
- "/v2/flows/templates": {
320
- "get": {
321
- "operationId": "listFlowTemplates",
322
- "summary": "listFlowTemplates",
323
- "description": "List all Flow Templates for a customer. Optionally, you can filter flow templates by trigger values.",
324
- "tags": [
325
- "Flows V2"
326
- ],
327
- "parameters": [
328
- {
329
- "in": "query",
330
- "name": "trigger_type",
331
- "schema": {
332
- "type": "string",
333
- "enum": [
334
- "automation",
335
- "manual",
336
- "journey_submission"
337
- ]
338
- },
339
- "required": false,
340
- "description": "Type of trigger for whom to filter flow templates",
341
- "example": "journey_submission"
342
- },
343
- {
344
- "in": "query",
345
- "name": "trigger_source_id",
346
- "schema": {
347
- "type": "string"
348
- },
349
- "required": false,
350
- "description": "Id of the trigger source to filter flow templates. Interpretation depends on **trigger_type**:\n- **automation**: use an `{automation_flow_id}` value\n- **journey_submission**: use a `{journey_id}` value\n- **manual**: this parameter is ignored; you can optionally filter by `{trigger_schema}`\n",
351
- "example": "j208g0aj-08g9agajggak-g9aug9-892kgl1m"
352
- },
353
- {
354
- "in": "query",
355
- "name": "trigger_schema",
356
- "schema": {
357
- "type": "string"
358
- },
359
- "required": false,
360
- "description": "Schema of the trigger source to filter flow templates. This parameter only makes sense when **trigger_type** is `manual`\n",
361
- "example": "opportunity"
362
- }
363
- ],
364
- "responses": {
365
- "200": {
366
- "description": "Success - flow templates loaded with success. Empty array if customer has no flows defined.",
367
- "content": {
368
- "application/json": {
369
- "schema": {
370
- "$ref": "#/components/schemas/FlowTemplatesList"
371
- }
372
- }
373
- }
374
- },
375
- "500": {
376
- "description": "Other errors",
377
- "content": {
378
- "application/json": {
379
- "schema": {
380
- "$ref": "#/components/schemas/ErrorResp"
381
- }
382
- }
383
- }
384
- }
385
- }
386
- },
387
- "post": {
388
- "operationId": "createFlowTemplate",
389
- "summary": "createFlowTemplate",
390
- "description": "Create a new Flow Template.",
391
- "tags": [
392
- "Flows V2"
393
- ],
394
- "requestBody": {
395
- "description": "Flow Template payload",
396
- "required": true,
397
- "content": {
398
- "application/json": {
399
- "schema": {
400
- "$ref": "#/components/schemas/CreateFlowTemplate"
401
- }
402
- }
403
- }
404
- },
405
- "responses": {
406
- "201": {
407
- "description": "Success - if the flow template is created successfully",
408
- "content": {
409
- "application/json": {
410
- "schema": {
411
- "$ref": "#/components/schemas/FlowTemplate"
412
- }
413
- }
414
- }
415
- },
416
- "400": {
417
- "description": "Validation Errors",
418
- "content": {
419
- "application/json": {
420
- "schema": {
421
- "$ref": "#/components/schemas/ErrorResp"
422
- }
423
- }
424
- }
425
- },
426
- "401": {
427
- "description": "Authentication Errors",
428
- "content": {
429
- "application/json": {
430
- "schema": {
431
- "$ref": "#/components/schemas/ErrorResp"
432
- }
433
- }
434
- }
435
- },
436
- "500": {
437
- "description": "Other errors",
438
- "content": {
439
- "application/json": {
440
- "schema": {
441
- "$ref": "#/components/schemas/ErrorResp"
442
- }
443
- }
444
- }
445
- }
446
- }
447
- }
448
- },
449
- "/v2/flows/templates:search": {
450
- "post": {
451
- "operationId": "searchFlowTemplates",
452
- "summary": "searchFlowTemplates",
453
- "description": "Search for flow templates by name, trigger type, enabled status, and more.",
454
- "tags": [
455
- "Flows V2"
456
- ],
457
- "requestBody": {
458
- "description": "Search for flow templates by name, trigger type, enabled status, and more.",
459
- "required": true,
460
- "content": {
461
- "application/json": {
462
- "schema": {
463
- "$ref": "#/components/schemas/SearchFlowTemplates"
464
- },
465
- "example": {
466
- "name": "Lead Qualification",
467
- "definition_id": "25n2k52ja",
468
- "trigger_type": "journey_submission",
469
- "enabled": true,
470
- "from": 0,
471
- "size": 10
472
- }
473
- }
474
- }
475
- },
476
- "responses": {
477
- "200": {
478
- "description": "Success - flow templates loaded with success. Empty array if customer has no flows defined.",
479
- "content": {
480
- "application/json": {
481
- "schema": {
482
- "type": "object",
483
- "properties": {
484
- "hits": {
485
- "type": "number"
486
- },
487
- "results": {
488
- "type": "array",
489
- "items": {
490
- "$ref": "#/components/schemas/FlowTemplate"
491
- }
492
- }
493
- }
494
- }
495
- }
496
- }
497
- },
498
- "500": {
499
- "description": "Other errors",
500
- "content": {
501
- "application/json": {
502
- "schema": {
503
- "$ref": "#/components/schemas/ErrorResp"
504
- }
505
- }
506
- }
507
- }
508
- }
509
- }
510
- },
511
- "/v2/flows/templates/{flowId}": {
512
- "get": {
513
- "operationId": "getFlowTemplate",
514
- "summary": "getFlowTemplate",
515
- "description": "Get specific FLow template for a customer",
516
- "tags": [
517
- "Flows V2"
518
- ],
519
- "parameters": [
520
- {
521
- "in": "path",
522
- "name": "flowId",
523
- "schema": {
524
- "$ref": "#/components/schemas/FlowTemplateId"
525
- },
526
- "required": true
527
- }
528
- ],
529
- "responses": {
530
- "200": {
531
- "description": "Returns the Flow Template",
532
- "content": {
533
- "application/json": {
534
- "schema": {
535
- "$ref": "#/components/schemas/FlowTemplate"
536
- }
537
- }
538
- }
539
- },
540
- "400": {
541
- "description": "Validation Errors",
542
- "content": {
543
- "application/json": {
544
- "schema": {
545
- "$ref": "#/components/schemas/ErrorResp"
546
- }
547
- }
548
- }
549
- },
550
- "401": {
551
- "description": "Authentication Errors",
552
- "content": {
553
- "application/json": {
554
- "schema": {
555
- "$ref": "#/components/schemas/ErrorResp"
556
- }
557
- }
558
- }
559
- },
560
- "404": {
561
- "description": "Definition Not found",
562
- "content": {
563
- "application/json": {
564
- "schema": {
565
- "$ref": "#/components/schemas/DefinitionNotFoundResp"
566
- }
567
- }
568
- }
569
- },
570
- "500": {
571
- "description": "Other errors",
572
- "content": {
573
- "application/json": {
574
- "schema": {
575
- "$ref": "#/components/schemas/ErrorResp"
576
- }
577
- }
578
- }
579
- }
580
- }
581
- },
582
- "put": {
583
- "operationId": "updateFlowTemplate",
584
- "summary": "updateFlowTemplate",
585
- "description": "Update Flow Template.",
586
- "tags": [
587
- "Flows V2"
588
- ],
589
- "parameters": [
590
- {
591
- "in": "path",
592
- "name": "flowId",
593
- "schema": {
594
- "$ref": "#/components/schemas/FlowTemplateId"
595
- },
596
- "required": true
597
- }
598
- ],
599
- "requestBody": {
600
- "description": "Flow Template payload",
601
- "required": true,
602
- "content": {
603
- "application/json": {
604
- "schema": {
605
- "$ref": "#/components/schemas/FlowTemplate"
606
- }
607
- }
608
- }
609
- },
610
- "responses": {
611
- "200": {
612
- "description": "Flow template has been updated successfully",
613
- "content": {
614
- "application/json": {
615
- "schema": {
616
- "$ref": "#/components/schemas/FlowTemplate"
617
- }
618
- }
619
- }
620
- },
621
- "400": {
622
- "description": "Validation Errors",
623
- "content": {
624
- "application/json": {
625
- "schema": {
626
- "$ref": "#/components/schemas/ErrorResp"
627
- }
628
- }
629
- }
630
- },
631
- "401": {
632
- "description": "Authentication Errors",
633
- "content": {
634
- "application/json": {
635
- "schema": {
636
- "$ref": "#/components/schemas/ErrorResp"
637
- }
638
- }
639
- }
640
- },
641
- "500": {
642
- "description": "Other errors",
643
- "content": {
644
- "application/json": {
645
- "schema": {
646
- "$ref": "#/components/schemas/ErrorResp"
647
- }
648
- }
649
- }
650
- }
651
- }
652
- },
653
- "delete": {
654
- "operationId": "deleteFlowTemplate",
655
- "summary": "deleteFlowTemplate",
656
- "description": "Delete Flow Template.",
657
- "tags": [
658
- "Flows V2"
659
- ],
660
- "parameters": [
661
- {
662
- "in": "path",
663
- "name": "flowId",
664
- "schema": {
665
- "$ref": "#/components/schemas/FlowTemplateId"
666
- },
667
- "required": true,
668
- "description": "Id of the flow template to de deleted."
669
- }
670
- ],
671
- "responses": {
672
- "204": {
673
- "description": "Flow template has been deleted successfully"
674
- },
675
- "401": {
676
- "description": "Failed to authenticate",
677
- "content": {
678
- "application/json": {
679
- "schema": {
680
- "$ref": "#/components/schemas/ErrorResp"
681
- }
682
- }
683
- }
684
- },
685
- "404": {
686
- "description": "No definition found"
687
- }
688
- }
689
- }
690
- },
691
- "/v2/flows/templates/{flowId}/duplicate": {
692
- "post": {
693
- "operationId": "duplicateFlowTemplate",
694
- "summary": "duplicateFlowTemplate",
695
- "description": "Duplicate a Flow Template from an existing workflow.",
696
- "tags": [
697
- "Flows V2"
698
- ],
699
- "parameters": [
700
- {
701
- "in": "path",
702
- "name": "flowId",
703
- "schema": {
704
- "$ref": "#/components/schemas/FlowTemplateId"
705
- },
706
- "required": true
707
- }
708
- ],
709
- "responses": {
710
- "201": {
711
- "description": "Flow template has been duplicated successfully",
712
- "content": {
713
- "application/json": {
714
- "schema": {
715
- "$ref": "#/components/schemas/FlowTemplate"
716
- }
717
- }
718
- }
719
- },
720
- "400": {
721
- "description": "Validation Errors",
722
- "content": {
723
- "application/json": {
724
- "schema": {
725
- "$ref": "#/components/schemas/ErrorResp"
726
- }
727
- }
728
- }
729
- },
730
- "401": {
731
- "description": "Authentication Errors",
732
- "content": {
733
- "application/json": {
734
- "schema": {
735
- "$ref": "#/components/schemas/ErrorResp"
736
- }
737
- }
738
- }
739
- },
740
- "500": {
741
- "description": "Other errors",
742
- "content": {
743
- "application/json": {
744
- "schema": {
745
- "$ref": "#/components/schemas/ErrorResp"
746
- }
747
- }
748
- }
749
- }
750
- }
751
- }
752
- },
753
- "/v1/workflows/definitions/{definitionId}": {
754
- "get": {
755
- "operationId": "getDefinition",
756
- "summary": "getDefinition",
757
- "description": "Get specific Definition by id from the Organization.",
758
- "tags": [
759
- "Workflows"
760
- ],
761
- "parameters": [
762
- {
763
- "in": "path",
764
- "name": "definitionId",
765
- "schema": {
766
- "type": "string"
767
- },
768
- "required": true,
769
- "description": "Short uuid (length 8) to identify the Workflow Definition.",
770
- "example": "7hj28a"
771
- }
772
- ],
773
- "responses": {
774
- "200": {
775
- "description": "Returns the Workflow definition",
776
- "content": {
777
- "application/json": {
778
- "schema": {
779
- "$ref": "#/components/schemas/WorkflowDefinition"
780
- },
781
- "example": {
782
- "id": "25n2k52ja",
783
- "name": "Lead Qualification",
784
- "dueDate": "2022-08-04T12:00:00.000Z",
785
- "assignedTo": [
786
- "952802",
787
- "80225"
788
- ],
789
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
790
- "creationTime": "2021-08-04T21:13:50.373Z",
791
- "flow": [
792
- {
793
- "id": "5892na2",
794
- "name": "Initial Information Gathering",
795
- "order": 1,
796
- "type": "SECTION",
797
- "steps": [
798
- {
799
- "id": "2hja82a",
800
- "name": "Call client and confirm address and product",
801
- "type": "STEP",
802
- "order": 1,
803
- "assignedTo": [
804
- "923432"
805
- ]
806
- },
807
- {
808
- "id": "ga92ha2",
809
- "name": "Check product availability",
810
- "type": "STEP",
811
- "order": 2,
812
- "assignedTo": [
813
- "45488"
814
- ]
815
- },
816
- {
817
- "id": "jga92ha",
818
- "name": "Send email confirming contact with the client",
819
- "type": "STEP",
820
- "order": 3,
821
- "assignedTo": [
822
- "45488"
823
- ]
824
- }
825
- ]
826
- },
827
- {
828
- "id": "0a7g22a",
829
- "name": "Print and send catalog",
830
- "type": "STEP",
831
- "order": 2,
832
- "assignedTo": [
833
- "8988"
834
- ]
835
- }
836
- ],
837
- "closingReasons": [
838
- {
839
- "id": "ffoowef",
840
- "title": "test"
841
- },
842
- {
843
- "id": "hebwoeu",
844
- "title": "Closing because all"
845
- },
846
- {
847
- "id": "mbnoenq",
848
- "title": "Better offer"
849
- }
850
- ]
851
- }
852
- }
853
- }
854
- },
855
- "400": {
856
- "description": "Validation Errors",
857
- "content": {
858
- "application/json": {
859
- "schema": {
860
- "$ref": "#/components/schemas/ErrorResp"
861
- }
862
- }
863
- }
864
- },
865
- "401": {
866
- "description": "Authentication Errors",
867
- "content": {
868
- "application/json": {
869
- "schema": {
870
- "$ref": "#/components/schemas/ErrorResp"
871
- }
872
- }
873
- }
874
- },
875
- "404": {
876
- "description": "Definition Not found",
877
- "content": {
878
- "application/json": {
879
- "schema": {
880
- "$ref": "#/components/schemas/DefinitionNotFoundResp"
881
- }
882
- }
883
- }
884
- },
885
- "500": {
886
- "description": "Other errors",
887
- "content": {
888
- "application/json": {
889
- "schema": {
890
- "$ref": "#/components/schemas/ErrorResp"
891
- }
892
- }
893
- }
894
- }
895
- }
896
- },
897
- "put": {
898
- "operationId": "updateDefinition",
899
- "summary": "updateDefinition",
900
- "description": "Update Workflow Definition.",
901
- "tags": [
902
- "Workflows"
903
- ],
904
- "parameters": [
905
- {
906
- "in": "path",
907
- "name": "definitionId",
908
- "schema": {
909
- "type": "string"
910
- },
911
- "required": true,
912
- "description": "Short uuid (length 8) to identify the Workflow Definition.",
913
- "example": "7hj28a"
914
- }
915
- ],
916
- "requestBody": {
917
- "description": "Workflow Definition payload",
918
- "required": true,
919
- "content": {
920
- "application/json": {
921
- "schema": {
922
- "$ref": "#/components/schemas/WorkflowDefinition"
923
- },
924
- "example": {
925
- "id": "25n2k52ja",
926
- "name": "Lead Qualification",
927
- "dueDate": "2022-08-04T12:00:00.000Z",
928
- "assignedTo": [
929
- "952802",
930
- "80225"
931
- ],
932
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
933
- "creationTime": "2021-08-04T21:13:50.373Z",
934
- "flow": [
935
- {
936
- "id": "5892na2",
937
- "name": "Initial Information Gathering",
938
- "order": 1,
939
- "type": "SECTION",
940
- "steps": [
941
- {
942
- "id": "2hja82a",
943
- "name": "Call client and confirm address and product",
944
- "type": "STEP",
945
- "order": 1,
946
- "assignedTo": [
947
- "8988"
948
- ]
949
- },
950
- {
951
- "id": "ga92ha2",
952
- "name": "Check product availability",
953
- "type": "STEP",
954
- "order": 2,
955
- "assignedTo": [
956
- "8988"
957
- ]
958
- },
959
- {
960
- "id": "jga92ha",
961
- "name": "Send email confirming contact with the client",
962
- "type": "STEP",
963
- "order": 3,
964
- "assignedTo": [
965
- "8988"
966
- ]
967
- }
968
- ]
969
- },
970
- {
971
- "id": "0a7g22a",
972
- "name": "Print and send catalog",
973
- "type": "STEP",
974
- "order": 2,
975
- "assignedTo": [
976
- "8988"
977
- ]
978
- }
979
- ]
980
- }
981
- }
982
- }
983
- },
984
- "responses": {
985
- "200": {
986
- "description": "Success - if the definition is updated successfully",
987
- "content": {
988
- "application/json": {
989
- "schema": {
990
- "$ref": "#/components/schemas/WorkflowDefinition"
991
- },
992
- "example": {
993
- "id": "25n2k52ja",
994
- "name": "Lead Qualification",
995
- "dueDate": "2022-08-04T12:00:00.000Z",
996
- "assignedTo": [
997
- "952802",
998
- "80225"
999
- ],
1000
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
1001
- "creationTime": "2021-08-04T21:13:50.373Z",
1002
- "flow": [
1003
- {
1004
- "id": "5892na2",
1005
- "name": "Initial Information Gathering",
1006
- "order": 1,
1007
- "type": "SECTION",
1008
- "steps": [
1009
- {
1010
- "id": "2hja82a",
1011
- "name": "Call client and confirm address and product",
1012
- "type": "STEP",
1013
- "order": 1,
1014
- "assignedTo": [
1015
- "1"
1016
- ]
1017
- },
1018
- {
1019
- "id": "ga92ha2",
1020
- "name": "Check product availability",
1021
- "type": "STEP",
1022
- "order": 2,
1023
- "assignedTo": [
1024
- "56645"
1025
- ]
1026
- },
1027
- {
1028
- "id": "jga92ha",
1029
- "name": "Send email confirming contact with the client",
1030
- "type": "STEP",
1031
- "order": 3,
1032
- "assignedTo": [
1033
- "949923"
1034
- ]
1035
- }
1036
- ]
1037
- },
1038
- {
1039
- "id": "0a7g22a",
1040
- "name": "Print and send catalog",
1041
- "type": "STEP",
1042
- "order": 2,
1043
- "assignedTo": [
1044
- "156645"
1045
- ]
1046
- }
1047
- ]
1048
- }
1049
- }
1050
- }
1051
- },
1052
- "400": {
1053
- "description": "Validation Errors",
1054
- "content": {
1055
- "application/json": {
1056
- "schema": {
1057
- "$ref": "#/components/schemas/ErrorResp"
1058
- }
1059
- }
1060
- }
1061
- },
1062
- "401": {
1063
- "description": "Authentication Errors",
1064
- "content": {
1065
- "application/json": {
1066
- "schema": {
1067
- "$ref": "#/components/schemas/ErrorResp"
1068
- }
1069
- }
1070
- }
1071
- },
1072
- "500": {
1073
- "description": "Other errors",
1074
- "content": {
1075
- "application/json": {
1076
- "schema": {
1077
- "$ref": "#/components/schemas/ErrorResp"
1078
- }
1079
- }
1080
- }
1081
- }
1082
- }
1083
- },
1084
- "delete": {
1085
- "operationId": "deleteDefinition",
1086
- "summary": "deleteDefinition",
1087
- "description": "Delete Workflow Definition.",
1088
- "tags": [
1089
- "Workflows"
1090
- ],
1091
- "parameters": [
1092
- {
1093
- "in": "path",
1094
- "name": "definitionId",
1095
- "schema": {
1096
- "type": "string"
1097
- },
1098
- "required": true,
1099
- "description": "Id of the definition to de deleted.",
1100
- "example": "CustomerRequest"
1101
- }
1102
- ],
1103
- "responses": {
1104
- "204": {
1105
- "description": "Success - if the definition is deleted successfully"
1106
- },
1107
- "401": {
1108
- "description": "Failed to authenticate",
1109
- "content": {
1110
- "application/json": {
1111
- "schema": {
1112
- "$ref": "#/components/schemas/ErrorResp"
1113
- }
1114
- }
1115
- }
1116
- },
1117
- "404": {
1118
- "description": "No definition found"
1119
- }
1120
- }
1121
- }
1122
- },
1123
- "/v1/workflows/closing-reasons": {
1124
- "get": {
1125
- "operationId": "getAllClosingReasons",
1126
- "summary": "getAllClosingReasons",
1127
- "description": "Get all Closing Reasons defined in the organization by default all Active.",
1128
- "parameters": [
1129
- {
1130
- "in": "query",
1131
- "name": "includeInactive",
1132
- "schema": {
1133
- "type": "boolean"
1134
- },
1135
- "required": false,
1136
- "description": "Filter Closing Reasons by status like active inactiv",
1137
- "example": true
1138
- }
1139
- ],
1140
- "tags": [
1141
- "Closing Reason"
1142
- ],
1143
- "responses": {
1144
- "200": {
1145
- "description": "Returns the entire catalog of closing reasons per organization",
1146
- "content": {
1147
- "application/json": {
1148
- "schema": {
1149
- "$ref": "#/components/schemas/ClosingReasons"
1150
- }
1151
- }
1152
- }
1153
- }
1154
- }
1155
- },
1156
- "post": {
1157
- "operationId": "createClosingReason",
1158
- "summary": "createClosingReason",
1159
- "description": "A created Closing Reason is stored for the organization and will be displayed in the library of reasons.",
1160
- "tags": [
1161
- "Closing Reason"
1162
- ],
1163
- "requestBody": {
1164
- "description": "closing reason to store",
1165
- "required": true,
1166
- "content": {
1167
- "application/json": {
1168
- "schema": {
1169
- "$ref": "#/components/schemas/ClosingReason"
1170
- },
1171
- "example": {
1172
- "title": "better offer",
1173
- "description": "A customer closes the process because he found something better"
1174
- }
1175
- }
1176
- }
1177
- },
1178
- "responses": {
1179
- "201": {
1180
- "description": "closing reason is stored successfully in the repository",
1181
- "content": {
1182
- "application/json": {
1183
- "schema": {
1184
- "$ref": "#/components/schemas/ClosingReason"
1185
- }
1186
- }
1187
- }
1188
- }
1189
- }
1190
- }
1191
- },
1192
- "/v2/workflows/closing-reasons/{reasonId}": {
1193
- "get": {
1194
- "operationId": "getClosingReason",
1195
- "summary": "getClosingReason",
1196
- "description": "Get specific closing reason by id from the organisation.",
1197
- "tags": [
1198
- "Closing Reason"
1199
- ],
1200
- "parameters": [
1201
- {
1202
- "in": "path",
1203
- "name": "reasonId",
1204
- "schema": {
1205
- "type": "string",
1206
- "example": "x739cew"
1207
- },
1208
- "required": true,
1209
- "description": "unique id to identify the closing reason."
1210
- }
1211
- ],
1212
- "responses": {
1213
- "200": {
1214
- "description": "Returns the closing reason",
1215
- "content": {
1216
- "application/json": {
1217
- "schema": {
1218
- "$ref": "#/components/schemas/ClosingReason"
1219
- }
1220
- }
1221
- }
1222
- },
1223
- "400": {
1224
- "description": "Validation Errors",
1225
- "content": {
1226
- "application/json": {
1227
- "schema": {
1228
- "$ref": "#/components/schemas/ErrorResp"
1229
- }
1230
- }
1231
- }
1232
- },
1233
- "403": {
1234
- "description": "Forbidden",
1235
- "content": {
1236
- "application/json": {
1237
- "schema": {
1238
- "$ref": "#/components/schemas/ErrorResp"
1239
- }
1240
- }
1241
- }
1242
- },
1243
- "404": {
1244
- "description": "Closing reason not found",
1245
- "content": {
1246
- "application/json": {
1247
- "schema": {
1248
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1249
- }
1250
- }
1251
- }
1252
- }
1253
- }
1254
- },
1255
- "patch": {
1256
- "operationId": "updateClosingReason",
1257
- "summary": "updateClosingReason",
1258
- "description": "Update an existing closing reason",
1259
- "tags": [
1260
- "Closing Reason"
1261
- ],
1262
- "parameters": [
1263
- {
1264
- "in": "path",
1265
- "name": "reasonId",
1266
- "schema": {
1267
- "type": "string",
1268
- "example": "x739cew"
1269
- },
1270
- "required": true,
1271
- "description": "unique id to identify the closing reason."
1272
- }
1273
- ],
1274
- "requestBody": {
1275
- "description": "Updated closing reason fields",
1276
- "required": true,
1277
- "content": {
1278
- "application/json": {
1279
- "schema": {
1280
- "$ref": "#/components/schemas/ClosingReason"
1281
- }
1282
- }
1283
- }
1284
- },
1285
- "responses": {
1286
- "200": {
1287
- "description": "Closing reason updated successfully",
1288
- "content": {
1289
- "application/json": {
1290
- "schema": {
1291
- "$ref": "#/components/schemas/ClosingReason"
1292
- }
1293
- }
1294
- }
1295
- },
1296
- "400": {
1297
- "description": "Validation Errors",
1298
- "content": {
1299
- "application/json": {
1300
- "schema": {
1301
- "$ref": "#/components/schemas/ErrorResp"
1302
- }
1303
- }
1304
- }
1305
- },
1306
- "403": {
1307
- "description": "Forbidden",
1308
- "content": {
1309
- "application/json": {
1310
- "schema": {
1311
- "$ref": "#/components/schemas/ErrorResp"
1312
- }
1313
- }
1314
- }
1315
- },
1316
- "404": {
1317
- "description": "Closing reason not found",
1318
- "content": {
1319
- "application/json": {
1320
- "schema": {
1321
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1322
- }
1323
- }
1324
- }
1325
- }
1326
- }
1327
- },
1328
- "delete": {
1329
- "operationId": "deleteClosingReason",
1330
- "summary": "deleteClosingReason",
1331
- "description": "Permanently delete a closing reason (Using INACTIVE status is recommended instead)",
1332
- "tags": [
1333
- "Closing Reason"
1334
- ],
1335
- "parameters": [
1336
- {
1337
- "in": "path",
1338
- "name": "reasonId",
1339
- "schema": {
1340
- "type": "string",
1341
- "example": "x739cew"
1342
- },
1343
- "required": true,
1344
- "description": "unique id to identify the closing reason."
1345
- }
1346
- ],
1347
- "responses": {
1348
- "204": {
1349
- "description": "Closing reason deleted successfully"
1350
- },
1351
- "403": {
1352
- "description": "Forbidden",
1353
- "content": {
1354
- "application/json": {
1355
- "schema": {
1356
- "$ref": "#/components/schemas/ErrorResp"
1357
- }
1358
- }
1359
- }
1360
- },
1361
- "404": {
1362
- "description": "Closing reason not found",
1363
- "content": {
1364
- "application/json": {
1365
- "schema": {
1366
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1367
- }
1368
- }
1369
- }
1370
- }
1371
- }
1372
- }
1373
- },
1374
- "/v1/workflows/closing-reasons/{reasonId}": {
1375
- "get": {
1376
- "deprecated": true,
1377
- "operationId": "getClosingReasonV1",
1378
- "summary": "getClosingReasonV1",
1379
- "description": "Get specific closing reason by id from the organisation.",
1380
- "tags": [
1381
- "Closing Reason"
1382
- ],
1383
- "parameters": [
1384
- {
1385
- "in": "path",
1386
- "name": "reasonId",
1387
- "schema": {
1388
- "type": "string"
1389
- },
1390
- "required": true,
1391
- "description": "uuid to identify the closing reason.",
1392
- "example": "-poOAPBa-jFZA_AWV3zN0"
1393
- }
1394
- ],
1395
- "responses": {
1396
- "200": {
1397
- "description": "Returns the closing reason",
1398
- "content": {
1399
- "application/json": {
1400
- "schema": {
1401
- "$ref": "#/components/schemas/ClosingReason"
1402
- },
1403
- "example": {
1404
- "id": "-poOAPBa-jFZA_AWV3zN0",
1405
- "title": "Closing due to example reason",
1406
- "status": "ACTIVE",
1407
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
1408
- "creationTime": "2021-08-04T21:13:50.373Z"
1409
- }
1410
- }
1411
- }
1412
- },
1413
- "400": {
1414
- "description": "Validation Errors",
1415
- "content": {
1416
- "application/json": {
1417
- "schema": {
1418
- "$ref": "#/components/schemas/ErrorResp"
1419
- }
1420
- }
1421
- }
1422
- },
1423
- "401": {
1424
- "description": "Authentication Errors",
1425
- "content": {
1426
- "application/json": {
1427
- "schema": {
1428
- "$ref": "#/components/schemas/ErrorResp"
1429
- }
1430
- }
1431
- }
1432
- },
1433
- "404": {
1434
- "description": "Closing reason not found",
1435
- "content": {
1436
- "application/json": {
1437
- "schema": {
1438
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1439
- }
1440
- }
1441
- }
1442
- },
1443
- "500": {
1444
- "description": "Other errors",
1445
- "content": {
1446
- "application/json": {
1447
- "schema": {
1448
- "$ref": "#/components/schemas/ErrorResp"
1449
- }
1450
- }
1451
- }
1452
- }
1453
- }
1454
- },
1455
- "patch": {
1456
- "operationId": "changeReasonStatus",
1457
- "summary": "changeReasonStatus",
1458
- "description": "Change the status of a Closing Reason (eg. ACTIVE to INACTIVE).",
1459
- "tags": [
1460
- "Closing Reason"
1461
- ],
1462
- "parameters": [
1463
- {
1464
- "in": "path",
1465
- "name": "reasonId",
1466
- "required": true,
1467
- "schema": {
1468
- "type": "string"
1469
- }
1470
- }
1471
- ],
1472
- "requestBody": {
1473
- "description": "change the status of a closing reason",
1474
- "content": {
1475
- "application/json": {
1476
- "schema": {
1477
- "$ref": "#/components/schemas/ChangeReasonStatusReq"
1478
- }
1479
- }
1480
- }
1481
- },
1482
- "responses": {
1483
- "202": {
1484
- "description": "The status change was accepted"
1485
- },
1486
- "400": {
1487
- "description": "bad request",
1488
- "content": {
1489
- "application/json": {
1490
- "schema": {
1491
- "$ref": "#/components/schemas/ErrorResp"
1492
- }
1493
- }
1494
- }
1495
- },
1496
- "500": {
1497
- "description": "Internal server error",
1498
- "content": {
1499
- "application/json": {
1500
- "schema": {
1501
- "$ref": "#/components/schemas/ErrorResp"
1502
- }
1503
- }
1504
- }
1505
- }
1506
- }
1507
- }
1508
- },
1509
- "/v1/workflows/definitions/{definitionId}/closing-reasons": {
1510
- "get": {
1511
- "operationId": "getWorkflowClosingReasons",
1512
- "summary": "getWorkflowClosingReasons",
1513
- "description": "Returns all closing reasons defined for the workflow.",
1514
- "parameters": [
1515
- {
1516
- "in": "path",
1517
- "name": "definitionId",
1518
- "schema": {
1519
- "type": "string"
1520
- },
1521
- "required": true,
1522
- "description": "ID of a workflow definition",
1523
- "example": "fxcwfw"
1524
- }
1525
- ],
1526
- "tags": [
1527
- "Workflows"
1528
- ],
1529
- "responses": {
1530
- "200": {
1531
- "description": "Returns the entire catalog of closing reasons for a specific workflow",
1532
- "content": {
1533
- "application/json": {
1534
- "schema": {
1535
- "$ref": "#/components/schemas/ClosingReasonsIds"
1536
- }
1537
- }
1538
- }
1539
- }
1540
- }
1541
- },
1542
- "patch": {
1543
- "operationId": "setWorkflowClosingReasons",
1544
- "summary": "setWorkflowClosingReasons",
1545
- "description": "Sets which closing reasons are defined for this workflow, based on the entire closing reasons catalog.",
1546
- "tags": [
1547
- "Workflows"
1548
- ],
1549
- "parameters": [
1550
- {
1551
- "in": "path",
1552
- "name": "definitionId",
1553
- "schema": {
1554
- "type": "string"
1555
- },
1556
- "required": true,
1557
- "description": "ID of a workflow definition",
1558
- "example": 7889
1559
- }
1560
- ],
1561
- "requestBody": {
1562
- "description": "set all closing reasons for a specific definition",
1563
- "required": true,
1564
- "content": {
1565
- "application/json": {
1566
- "schema": {
1567
- "$ref": "#/components/schemas/ClosingReasonsIds"
1568
- }
1569
- }
1570
- }
1571
- },
1572
- "responses": {
1573
- "201": {
1574
- "description": "closing reasons are set for this workflow"
1575
- }
1576
- }
1577
- }
1578
- }
1579
- },
1580
- "components": {
1581
- "securitySchemes": {
1582
- "BearerAuth": {
1583
- "type": "http",
1584
- "scheme": "bearer",
1585
- "bearerFormat": "JWT"
1586
- }
1587
- },
1588
- "schemas": {
1589
- "FlowTemplateBase": {
1590
- "type": "object",
1591
- "required": [
1592
- "name",
1593
- "tasks",
1594
- "edges"
1595
- ],
1596
- "properties": {
1597
- "id": {
1598
- "type": "string"
1599
- },
1600
- "org_id": {
1601
- "type": "string"
1602
- },
1603
- "name": {
1604
- "type": "string"
1605
- },
1606
- "description": {
1607
- "type": "string"
1608
- },
1609
- "trigger": {
1610
- "$ref": "#/components/schemas/Trigger"
1611
- },
1612
- "enabled": {
1613
- "type": "boolean",
1614
- "description": "Whether the workflow is enabled or not",
1615
- "default": true
1616
- },
1617
- "version": {
1618
- "$ref": "#/components/schemas/Version"
1619
- },
1620
- "created_at": {
1621
- "type": "string",
1622
- "description": "ISO String Date & Time",
1623
- "example": "2021-04-27T12:01:13.000Z"
1624
- },
1625
- "updated_at": {
1626
- "type": "string",
1627
- "description": "ISO String Date & Time",
1628
- "example": "2021-04-27T12:01:13.000Z"
1629
- },
1630
- "due_date": {
1631
- "type": "string",
1632
- "example": "2021-04-27T12:00:00.000Z"
1633
- },
1634
- "due_date_config": {
1635
- "$ref": "#/components/schemas/DueDateConfig"
1636
- },
1637
- "assigned_to": {
1638
- "type": "array",
1639
- "items": {
1640
- "oneOf": [
1641
- {
1642
- "type": "string"
1643
- },
1644
- {
1645
- "$ref": "#/components/schemas/VariableAssignment"
1646
- }
1647
- ]
1648
- }
1649
- },
1650
- "available_in_ecp": {
1651
- "type": "boolean",
1652
- "description": "Indicates whether this workflow is available for End Customer Portal or not. By default it's not."
1653
- },
1654
- "additional_triggers": {
1655
- "type": "array",
1656
- "description": "Additional trigger configurations that can also start this flow. Useful for flows that should be startable via multiple methods (e.g., both automation AND manual).",
1657
- "items": {
1658
- "$ref": "#/components/schemas/Trigger"
1659
- }
1660
- },
1661
- "phases": {
1662
- "type": "array",
1663
- "items": {
1664
- "$ref": "#/components/schemas/Phase"
1665
- }
1666
- },
1667
- "tasks": {
1668
- "type": "array",
1669
- "items": {
1670
- "$ref": "#/components/schemas/Task"
1671
- }
1672
- },
1673
- "edges": {
1674
- "type": "array",
1675
- "items": {
1676
- "$ref": "#/components/schemas/Edge"
1677
- }
1678
- },
1679
- "closing_reasons": {
1680
- "type": "array",
1681
- "items": {
1682
- "$ref": "#/components/schemas/ClosingReason"
1683
- }
1684
- },
1685
- "entity_sync": {
1686
- "type": "array",
1687
- "items": {
1688
- "$ref": "#/components/schemas/EntitySync"
1689
- }
1690
- },
1691
- "taxonomies": {
1692
- "type": "array",
1693
- "items": {
1694
- "type": "string"
1695
- },
1696
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
1697
- },
1698
- "singleClosingReasonSelection": {
1699
- "type": "boolean",
1700
- "description": "Whether only a single closing reason can be selected"
1701
- },
1702
- "_manifest": {
1703
- "type": "array",
1704
- "description": "The manifest IDs associated with this workflow",
1705
- "items": {
1706
- "type": "string"
1707
- }
1708
- }
1709
- }
1710
- },
1711
- "FlowTemplate": {
1712
- "allOf": [
1713
- {
1714
- "$ref": "#/components/schemas/FlowTemplateBase"
1715
- },
1716
- {
1717
- "type": "object",
1718
- "properties": {
1719
- "closing_reasons": {
1720
- "type": "array",
1721
- "items": {
1722
- "$ref": "#/components/schemas/ClosingReason"
1723
- }
1724
- }
1725
- }
1726
- }
1727
- ]
1728
- },
1729
- "Version": {
1730
- "type": "string",
1731
- "enum": [
1732
- "v1",
1733
- "v2",
1734
- "v3"
1735
- ],
1736
- "description": "Version of the workflow schema.\n\n- `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities.\n- `v2` – Linear workflows. Supports sequential task execution with basic automation triggers.\n- `v3` – Advanced workflows. Adds support for branching logic (conditions), parallel paths, and enhanced automation features such as dynamic triggers and flow control.\n",
1737
- "example": 2
1738
- },
1739
- "Trigger": {
1740
- "anyOf": [
1741
- {
1742
- "$ref": "#/components/schemas/ManualTrigger"
1743
- },
1744
- {
1745
- "$ref": "#/components/schemas/AutomationTrigger"
1746
- },
1747
- {
1748
- "$ref": "#/components/schemas/JourneySubmissionTrigger"
1749
- },
1750
- {
1751
- "$ref": "#/components/schemas/JourneyAutomationTrigger"
1752
- }
1753
- ],
1754
- "example": {
1755
- "type": "automation",
1756
- "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
1757
- }
1758
- },
1759
- "ManualTrigger": {
1760
- "type": "object",
1761
- "required": [
1762
- "type"
1763
- ],
1764
- "properties": {
1765
- "id": {
1766
- "type": "string"
1767
- },
1768
- "type": {
1769
- "type": "string",
1770
- "enum": [
1771
- "manual"
1772
- ]
1773
- },
1774
- "entity_schema": {
1775
- "type": "string"
1776
- }
1777
- }
1778
- },
1779
- "AutomationTrigger": {
1780
- "type": "object",
1781
- "required": [
1782
- "type"
1783
- ],
1784
- "properties": {
1785
- "id": {
1786
- "type": "string"
1787
- },
1788
- "type": {
1789
- "type": "string",
1790
- "enum": [
1791
- "automation"
1792
- ]
1793
- },
1794
- "automation_id": {
1795
- "type": "string",
1796
- "description": "Id of the automation config that triggers this workflow"
1797
- },
1798
- "trigger_config": {
1799
- "type": "array",
1800
- "items": {
1801
- "type": "object",
1802
- "required": [
1803
- "type"
1804
- ],
1805
- "properties": {
1806
- "type": {
1807
- "type": "string",
1808
- "description": "The trigger type (e.g. entity_operation, activity)"
1809
- },
1810
- "configuration": {
1811
- "type": "object",
1812
- "additionalProperties": true,
1813
- "description": "Trigger-specific configuration"
1814
- }
1815
- },
1816
- "additionalProperties": true
1817
- },
1818
- "description": "Transient field. Trigger configurations for creating or updating the trigger automation flow. Each item follows the automation API trigger schema. Processed by the backend during create/update and stripped before storage.\n"
1819
- }
1820
- }
1821
- },
1822
- "JourneyAutomationTrigger": {
1823
- "type": "object",
1824
- "required": [
1825
- "type"
1826
- ],
1827
- "properties": {
1828
- "id": {
1829
- "type": "string"
1830
- },
1831
- "type": {
1832
- "type": "string",
1833
- "enum": [
1834
- "journey_automation"
1835
- ]
1836
- },
1837
- "entity_schema": {
1838
- "type": "string",
1839
- "description": "Schema of the main entity where flow will be triggered. The entity will be picked from automation context."
1840
- }
1841
- }
1842
- },
1843
- "JourneySubmissionTrigger": {
1844
- "type": "object",
1845
- "required": [
1846
- "type",
1847
- "journey_id"
1848
- ],
1849
- "properties": {
1850
- "id": {
1851
- "type": "string"
1852
- },
1853
- "type": {
1854
- "type": "string",
1855
- "enum": [
1856
- "journey_submission"
1857
- ]
1858
- },
1859
- "journey_id": {
1860
- "type": "string",
1861
- "description": "ID of the journey that will trigger this flow"
1862
- },
1863
- "journey_name": {
1864
- "type": "string",
1865
- "description": "Name of the journey that will trigger this flow"
1866
- },
1867
- "automation_id": {
1868
- "type": "string"
1869
- }
1870
- }
1871
- },
1872
- "CreateFlowTemplate": {
1873
- "allOf": [
1874
- {
1875
- "$ref": "#/components/schemas/FlowTemplateBase"
1876
- },
1877
- {
1878
- "type": "object",
1879
- "properties": {
1880
- "closing_reasons": {
1881
- "type": "array",
1882
- "items": {
1883
- "type": "object",
1884
- "required": [
1885
- "id"
1886
- ],
1887
- "properties": {
1888
- "id": {
1889
- "type": "string"
1890
- }
1891
- }
1892
- }
1893
- }
1894
- }
1895
- }
1896
- ]
1897
- },
1898
- "SearchFlowTemplates": {
1899
- "type": "object",
1900
- "properties": {
1901
- "name": {
1902
- "type": "string"
1903
- },
1904
- "definition_id": {
1905
- "type": "string"
1906
- },
1907
- "trigger_type": {
1908
- "type": "string",
1909
- "enum": [
1910
- "journey_submission",
1911
- "manual",
1912
- "automation"
1913
- ]
1914
- },
1915
- "enabled": {
1916
- "type": "boolean"
1917
- },
1918
- "from": {
1919
- "type": "integer"
1920
- },
1921
- "size": {
1922
- "type": "integer"
1923
- },
1924
- "sort_by": {
1925
- "type": "string",
1926
- "enum": [
1927
- "created_at",
1928
- "updated_at"
1929
- ],
1930
- "default": "updated_at"
1931
- },
1932
- "sort_order": {
1933
- "type": "string",
1934
- "enum": [
1935
- "asc",
1936
- "desc"
1937
- ],
1938
- "default": "desc"
1939
- }
1940
- }
1941
- },
1942
- "FlowTemplatesList": {
1943
- "type": "object",
1944
- "properties": {
1945
- "results": {
1946
- "type": "array",
1947
- "items": {
1948
- "$ref": "#/components/schemas/FlowTemplate"
1949
- }
1950
- }
1951
- },
1952
- "required": [
1953
- "results"
1954
- ]
1955
- },
1956
- "FlowTemplateId": {
1957
- "type": "string",
1958
- "description": "Short unique id (length 8) to identify the Flow Template.",
1959
- "example": "7hj28akg"
1960
- },
1961
- "Task": {
1962
- "anyOf": [
1963
- {
1964
- "$ref": "#/components/schemas/ManualTask"
1965
- },
1966
- {
1967
- "$ref": "#/components/schemas/AutomationTask"
1968
- },
1969
- {
1970
- "$ref": "#/components/schemas/DecisionTask"
1971
- },
1972
- {
1973
- "$ref": "#/components/schemas/AiAgentTask"
1974
- }
1975
- ]
1976
- },
1977
- "ManualTask": {
1978
- "allOf": [
1979
- {
1980
- "$ref": "#/components/schemas/TaskBase"
1981
- }
1982
- ]
1983
- },
1984
- "AutomationTask": {
1985
- "allOf": [
1986
- {
1987
- "$ref": "#/components/schemas/TaskBase"
1988
- },
1989
- {
1990
- "type": "object",
1991
- "required": [
1992
- "automation_config"
1993
- ],
1994
- "properties": {
1995
- "automation_config": {
1996
- "$ref": "#/components/schemas/AutomationConfig"
1997
- },
1998
- "trigger_mode": {
1999
- "$ref": "#/components/schemas/TriggerMode"
2000
- },
2001
- "schedule": {
2002
- "$ref": "#/components/schemas/ActionSchedule"
2003
- },
2004
- "created_automatically": {
2005
- "type": "boolean",
2006
- "description": "Indicates whether this task was created automatically by journeys or manually by an user",
2007
- "default": false
2008
- }
2009
- }
2010
- }
2011
- ]
2012
- },
2013
- "AutomationConfig": {
2014
- "type": "object",
2015
- "description": "Configuration for automation execution to run",
2016
- "properties": {
2017
- "flow_id": {
2018
- "type": "string",
2019
- "description": "Id of the configured automation to run"
2020
- },
2021
- "action_config": {
2022
- "type": "object",
2023
- "required": [
2024
- "type"
2025
- ],
2026
- "properties": {
2027
- "type": {
2028
- "type": "string",
2029
- "description": "The action type (e.g. send-email, trigger-workflow)"
2030
- },
2031
- "config": {
2032
- "type": "object",
2033
- "additionalProperties": true,
2034
- "description": "Action-specific configuration"
2035
- }
2036
- },
2037
- "additionalProperties": true,
2038
- "description": "Transient field. The full automation action configuration following the automation API action schema. Processed by the backend during create/update and stripped before storage. When present without a flow_id, a new automation flow is created. When present with a flow_id, the existing automation flow is updated.\n"
2039
- }
2040
- }
2041
- },
2042
- "AiAgentTask": {
2043
- "allOf": [
2044
- {
2045
- "$ref": "#/components/schemas/TaskBase"
2046
- },
2047
- {
2048
- "type": "object",
2049
- "properties": {
2050
- "agent_config": {
2051
- "$ref": "#/components/schemas/AgentConfig"
2052
- }
2053
- }
2054
- }
2055
- ]
2056
- },
2057
- "AgentConfig": {
2058
- "type": "object",
2059
- "description": "Configuration for AI Agent to run",
2060
- "required": [
2061
- "agent_id"
2062
- ],
2063
- "properties": {
2064
- "agent_id": {
2065
- "type": "string",
2066
- "description": "Id of the configured AI Agent to run"
2067
- }
2068
- },
2069
- "additionalProperties": true
2070
- },
2071
- "TriggerMode": {
2072
- "type": "string",
2073
- "enum": [
2074
- "manual",
2075
- "automatic"
2076
- ]
2077
- },
2078
- "ActionSchedule": {
2079
- "anyOf": [
2080
- {
2081
- "$ref": "#/components/schemas/ImmediateSchedule"
2082
- },
2083
- {
2084
- "$ref": "#/components/schemas/DelayedSchedule"
2085
- },
2086
- {
2087
- "$ref": "#/components/schemas/RelativeSchedule"
2088
- }
2089
- ]
2090
- },
2091
- "ImmediateSchedule": {
2092
- "type": "object",
2093
- "properties": {
2094
- "mode": {
2095
- "enum": [
2096
- "immediate"
2097
- ]
2098
- }
2099
- }
2100
- },
2101
- "DelayedSchedule": {
2102
- "type": "object",
2103
- "required": [
2104
- "mode",
2105
- "duration",
2106
- "unit"
2107
- ],
2108
- "properties": {
2109
- "mode": {
2110
- "enum": [
2111
- "delayed"
2112
- ]
2113
- },
2114
- "duration": {
2115
- "type": "number"
2116
- },
2117
- "unit": {
2118
- "$ref": "#/components/schemas/TimeUnit"
2119
- }
2120
- }
2121
- },
2122
- "RelativeSchedule": {
2123
- "type": "object",
2124
- "properties": {
2125
- "mode": {
2126
- "enum": [
2127
- "relative"
2128
- ]
2129
- },
2130
- "direction": {
2131
- "type": "string",
2132
- "enum": [
2133
- "before",
2134
- "after"
2135
- ]
2136
- },
2137
- "duration": {
2138
- "type": "number"
2139
- },
2140
- "unit": {
2141
- "$ref": "#/components/schemas/TimeUnit"
2142
- },
2143
- "reference": {
2144
- "type": "object",
2145
- "required": [
2146
- "id",
2147
- "origin"
2148
- ],
2149
- "properties": {
2150
- "id": {
2151
- "type": "string",
2152
- "description": "The id of the entity / workflow / task, based on the origin of the schedule. For all_preceding_tasks_completed, use the sentinel value \"all_preceding_tasks_completed\"."
2153
- },
2154
- "origin": {
2155
- "type": "string",
2156
- "enum": [
2157
- "flow_started",
2158
- "task_completed",
2159
- "trigger_entity_attribute",
2160
- "all_preceding_tasks_completed"
2161
- ]
2162
- },
2163
- "schema": {
2164
- "type": "string",
2165
- "description": "The schema of the entity"
2166
- },
2167
- "attribute": {
2168
- "type": "string",
2169
- "description": "An entity attribute that identifies a date / datetime"
2170
- }
2171
- }
2172
- }
2173
- },
2174
- "required": [
2175
- "mode",
2176
- "direction",
2177
- "duration",
2178
- "unit",
2179
- "reference"
2180
- ]
2181
- },
2182
- "DecisionTask": {
2183
- "allOf": [
2184
- {
2185
- "$ref": "#/components/schemas/TaskBase"
2186
- },
2187
- {
2188
- "type": "object",
2189
- "properties": {
2190
- "trigger_mode": {
2191
- "$ref": "#/components/schemas/TriggerMode"
2192
- },
2193
- "conditions": {
2194
- "type": "array",
2195
- "items": {
2196
- "$ref": "#/components/schemas/Condition"
2197
- }
2198
- },
2199
- "schedule": {
2200
- "anyOf": [
2201
- {
2202
- "$ref": "#/components/schemas/DelayedSchedule"
2203
- },
2204
- {
2205
- "$ref": "#/components/schemas/RelativeSchedule"
2206
- }
2207
- ]
2208
- },
2209
- "loop_config": {
2210
- "type": "object",
2211
- "properties": {
2212
- "loop_branch_id": {
2213
- "type": "string",
2214
- "description": "The id of the branch that will be looped"
2215
- },
2216
- "exit_branch_id": {
2217
- "type": "string",
2218
- "description": "The id of the branch that will be used to exit the loop"
2219
- },
2220
- "max_iterations": {
2221
- "type": "integer",
2222
- "description": "Maximum number of iterations for the loop branch",
2223
- "default": 3,
2224
- "minimum": 1,
2225
- "maximum": 100
2226
- }
2227
- },
2228
- "required": [
2229
- "loop_branch_id",
2230
- "exit_branch_id",
2231
- "max_iterations"
2232
- ]
2233
- }
2234
- },
2235
- "required": [
2236
- "trigger_mode",
2237
- "conditions"
2238
- ]
2239
- }
2240
- ]
2241
- },
2242
- "TaskBase": {
2243
- "type": "object",
2244
- "properties": {
2245
- "id": {
2246
- "type": "string"
2247
- },
2248
- "name": {
2249
- "type": "string"
2250
- },
2251
- "description": {
2252
- "$ref": "#/components/schemas/StepDescription"
2253
- },
2254
- "journey": {
2255
- "$ref": "#/components/schemas/StepJourney"
2256
- },
2257
- "due_date": {
2258
- "type": "string",
2259
- "example": "2021-04-27T12:00:00.000Z"
2260
- },
2261
- "due_date_config": {
2262
- "$ref": "#/components/schemas/DueDateConfig"
2263
- },
2264
- "requirements": {
2265
- "type": "array",
2266
- "description": "requirements that need to be fulfilled in order to enable the task while flow instances are running",
2267
- "items": {
2268
- "$ref": "#/components/schemas/EnableRequirement"
2269
- }
2270
- },
2271
- "assigned_to": {
2272
- "type": "array",
2273
- "items": {
2274
- "oneOf": [
2275
- {
2276
- "type": "string"
2277
- },
2278
- {
2279
- "$ref": "#/components/schemas/VariableAssignment"
2280
- }
2281
- ]
2282
- }
2283
- },
2284
- "ecp": {
2285
- "$ref": "#/components/schemas/ECPDetails"
2286
- },
2287
- "installer": {
2288
- "$ref": "#/components/schemas/ECPDetails"
2289
- },
2290
- "partner": {
2291
- "$ref": "#/components/schemas/PartnerDetails",
2292
- "description": "Partner-specific task details shown to partner org users viewing shared resources"
2293
- },
2294
- "taxonomies": {
2295
- "type": "array",
2296
- "items": {
2297
- "type": "string"
2298
- },
2299
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2300
- },
2301
- "phase_id": {
2302
- "type": "string"
2303
- },
2304
- "task_type": {
2305
- "$ref": "#/components/schemas/TaskType"
2306
- }
2307
- },
2308
- "required": [
2309
- "id",
2310
- "name",
2311
- "task_type"
2312
- ]
2313
- },
2314
- "Phase": {
2315
- "type": "object",
2316
- "properties": {
2317
- "id": {
2318
- "type": "string"
2319
- },
2320
- "name": {
2321
- "type": "string"
2322
- },
2323
- "due_date": {
2324
- "type": "string",
2325
- "example": "2021-04-27T12:00:00.000Z"
2326
- },
2327
- "due_date_config": {
2328
- "$ref": "#/components/schemas/DueDateConfig"
2329
- },
2330
- "assigned_to": {
2331
- "type": "array",
2332
- "items": {
2333
- "oneOf": [
2334
- {
2335
- "type": "string"
2336
- },
2337
- {
2338
- "$ref": "#/components/schemas/VariableAssignment"
2339
- }
2340
- ]
2341
- }
2342
- },
2343
- "taxonomies": {
2344
- "type": "array",
2345
- "items": {
2346
- "type": "string"
2347
- },
2348
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2349
- }
2350
- },
2351
- "required": [
2352
- "id",
2353
- "name"
2354
- ]
2355
- },
2356
- "VariableAssignment": {
2357
- "type": "object",
2358
- "description": "Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution.",
2359
- "properties": {
2360
- "variable": {
2361
- "type": "string",
2362
- "description": "The variable expression, e.g., \"{{entity.owner}}\"",
2363
- "example": "{{entity.owner}}"
2364
- },
2365
- "value": {
2366
- "type": "array",
2367
- "items": {
2368
- "type": "string"
2369
- },
2370
- "description": "The resolved values after variable evaluation (populated during execution)",
2371
- "example": [
2372
- "user_12345"
2373
- ]
2374
- }
2375
- },
2376
- "required": [
2377
- "variable"
2378
- ]
2379
- },
2380
- "TaskType": {
2381
- "type": "string",
2382
- "enum": [
2383
- "MANUAL",
2384
- "AUTOMATION",
2385
- "DECISION",
2386
- "AI_AGENT"
2387
- ]
2388
- },
2389
- "Edge": {
2390
- "type": "object",
2391
- "properties": {
2392
- "id": {
2393
- "type": "string"
2394
- },
2395
- "from_id": {
2396
- "type": "string"
2397
- },
2398
- "to_id": {
2399
- "type": "string",
2400
- "nullable": true
2401
- },
2402
- "condition_id": {
2403
- "type": "string"
2404
- },
2405
- "none_met": {
2406
- "type": "boolean",
2407
- "description": "Indicates a default case for a decision task. Only decision task edges can have this field and the flow advances using this edge if no conditions are met."
2408
- }
2409
- },
2410
- "required": [
2411
- "id",
2412
- "from_id"
2413
- ]
2414
- },
2415
- "Condition": {
2416
- "type": "object",
2417
- "properties": {
2418
- "id": {
2419
- "type": "string"
2420
- },
2421
- "branch_name": {
2422
- "type": "string",
2423
- "description": "The name of the branch",
2424
- "maxLength": 255,
2425
- "example": "Branch 1"
2426
- },
2427
- "logical_operator": {
2428
- "type": "string",
2429
- "enum": [
2430
- "AND",
2431
- "OR"
2432
- ]
2433
- },
2434
- "statements": {
2435
- "type": "array",
2436
- "nullable": true,
2437
- "items": {
2438
- "$ref": "#/components/schemas/Statement"
2439
- }
2440
- }
2441
- },
2442
- "required": [
2443
- "id",
2444
- "branch_name",
2445
- "logical_operator",
2446
- "statements"
2447
- ]
2448
- },
2449
- "Statement": {
2450
- "type": "object",
2451
- "properties": {
2452
- "id": {
2453
- "type": "string"
2454
- },
2455
- "source": {
2456
- "$ref": "#/components/schemas/EvaluationSource"
2457
- },
2458
- "operator": {
2459
- "$ref": "#/components/schemas/Operator"
2460
- },
2461
- "values": {
2462
- "type": "array",
2463
- "items": {
2464
- "type": "string"
2465
- }
2466
- },
2467
- "value_type": {
2468
- "type": "string",
2469
- "enum": [
2470
- "static",
2471
- "relative_date"
2472
- ],
2473
- "description": "How to interpret values. \"static\" (default) means literal values. \"relative_date\" means values[0] is a dynamic date token like \"today\"."
2474
- }
2475
- },
2476
- "required": [
2477
- "id",
2478
- "source",
2479
- "operator",
2480
- "values"
2481
- ]
2482
- },
2483
- "EvaluationSource": {
2484
- "type": "object",
2485
- "properties": {
2486
- "id": {
2487
- "type": "string",
2488
- "description": "The id of the action or trigger"
2489
- },
2490
- "origin": {
2491
- "type": "string",
2492
- "enum": [
2493
- "trigger",
2494
- "action"
2495
- ]
2496
- },
2497
- "origin_type": {
2498
- "type": "string",
2499
- "enum": [
2500
- "entity",
2501
- "workflow",
2502
- "journey_block"
2503
- ]
2504
- },
2505
- "schema": {
2506
- "type": "string"
2507
- },
2508
- "attribute": {
2509
- "type": "string"
2510
- },
2511
- "attribute_type": {
2512
- "type": "string",
2513
- "enum": [
2514
- "string",
2515
- "text",
2516
- "number",
2517
- "boolean",
2518
- "date",
2519
- "datetime",
2520
- "tags",
2521
- "country",
2522
- "email",
2523
- "phone",
2524
- "product",
2525
- "price",
2526
- "status",
2527
- "relation",
2528
- "multiselect",
2529
- "select",
2530
- "radio",
2531
- "relation_user",
2532
- "purpose",
2533
- "label",
2534
- "message_email_address"
2535
- ]
2536
- },
2537
- "attribute_repeatable": {
2538
- "type": "boolean"
2539
- },
2540
- "attribute_operation": {
2541
- "enum": [
2542
- "all",
2543
- "updated",
2544
- "added",
2545
- "deleted"
2546
- ]
2547
- },
2548
- "attribute_sub_field": {
2549
- "type": "string",
2550
- "description": "For complex attribute types, specifies which sub-field to extract (e.g., \"address\", \"name\", \"email_type\")"
2551
- },
2552
- "date_offset": {
2553
- "type": "object",
2554
- "description": "Offset to apply to the source date value before comparison (e.g., +18 years for age check, +30 days for expiry)",
2555
- "properties": {
2556
- "amount": {
2557
- "type": "integer",
2558
- "description": "Number of units to offset"
2559
- },
2560
- "unit": {
2561
- "type": "string",
2562
- "enum": [
2563
- "days",
2564
- "months",
2565
- "years"
2566
- ],
2567
- "description": "Unit of the offset"
2568
- }
2569
- }
2570
- }
2571
- }
2572
- },
2573
- "Operator": {
2574
- "type": "string",
2575
- "enum": [
2576
- "equals",
2577
- "not_equals",
2578
- "any_of",
2579
- "none_of",
2580
- "contains",
2581
- "not_contains",
2582
- "starts_with",
2583
- "ends_with",
2584
- "greater_than",
2585
- "less_than",
2586
- "greater_than_or_equals",
2587
- "less_than_or_equals",
2588
- "is_empty",
2589
- "is_not_empty"
2590
- ]
2591
- },
2592
- "DueDateConfig": {
2593
- "description": "Set due date for the task based on a dynamic condition",
2594
- "type": "object",
2595
- "properties": {
2596
- "duration": {
2597
- "type": "number"
2598
- },
2599
- "unit": {
2600
- "$ref": "#/components/schemas/TimeUnit"
2601
- },
2602
- "type": {
2603
- "type": "string",
2604
- "enum": [
2605
- "WORKFLOW_STARTED",
2606
- "TASK_FINISHED",
2607
- "PHASE_FINISHED",
2608
- "A_PRECEDING_TASK_COMPLETED",
2609
- "ALL_PRECEDING_TASKS_COMPLETED"
2610
- ]
2611
- },
2612
- "task_id": {
2613
- "type": "string"
2614
- },
2615
- "phase_id": {
2616
- "type": "string"
2617
- }
2618
- },
2619
- "required": [
2620
- "duration",
2621
- "unit",
2622
- "type"
2623
- ]
2624
- },
2625
- "TimeUnit": {
2626
- "type": "string",
2627
- "enum": [
2628
- "minutes",
2629
- "hours",
2630
- "days",
2631
- "weeks",
2632
- "months"
2633
- ]
2634
- },
2635
- "EnableRequirement": {
2636
- "description": "describe the requirement for a task to be enabled",
2637
- "type": "object",
2638
- "properties": {
2639
- "task_id": {
2640
- "type": "string",
2641
- "description": "The id of the task that it points to"
2642
- },
2643
- "phase_id": {
2644
- "type": "string",
2645
- "description": "The id of the phase that it points to"
2646
- },
2647
- "when": {
2648
- "type": "string",
2649
- "enum": [
2650
- "TASK_FINISHED",
2651
- "PHASE_FINISHED"
2652
- ]
2653
- }
2654
- },
2655
- "required": [
2656
- "when"
2657
- ]
2658
- },
2659
- "WorkflowDefinition": {
2660
- "type": "object",
2661
- "properties": {
2662
- "id": {
2663
- "type": "string"
2664
- },
2665
- "name": {
2666
- "type": "string"
2667
- },
2668
- "description": {
2669
- "type": "string"
2670
- },
2671
- "creationTime": {
2672
- "type": "string",
2673
- "description": "ISO String Date & Time",
2674
- "example": "2021-04-27T12:01:13.000Z"
2675
- },
2676
- "enabled": {
2677
- "type": "boolean",
2678
- "description": "Whether the workflow is enabled or not",
2679
- "default": true
2680
- },
2681
- "lastUpdateTime": {
2682
- "type": "string",
2683
- "description": "ISO String Date & Time",
2684
- "example": "2021-04-27T12:01:13.000Z"
2685
- },
2686
- "dueDate": {
2687
- "type": "string",
2688
- "example": "2021-04-27T12:00:00.000Z"
2689
- },
2690
- "dynamicDueDate": {
2691
- "$ref": "#/components/schemas/DynamicDueDate"
2692
- },
2693
- "userIds": {
2694
- "type": "array",
2695
- "items": {
2696
- "type": "number"
2697
- },
2698
- "deprecated": true,
2699
- "description": "This field is deprecated. Please use assignedTo"
2700
- },
2701
- "assignedTo": {
2702
- "type": "array",
2703
- "items": {
2704
- "type": "string"
2705
- }
2706
- },
2707
- "enableECPWorkflow": {
2708
- "type": "boolean",
2709
- "description": "Indicates whether this workflow is available for End Customer Portal or not. By default it's not."
2710
- },
2711
- "flow": {
2712
- "type": "array",
2713
- "items": {
2714
- "anyOf": [
2715
- {
2716
- "$ref": "#/components/schemas/Section"
2717
- },
2718
- {
2719
- "$ref": "#/components/schemas/Step"
2720
- }
2721
- ]
2722
- }
2723
- },
2724
- "closingReasons": {
2725
- "type": "array",
2726
- "items": {
2727
- "$ref": "#/components/schemas/ClosingReasonId"
2728
- }
2729
- },
2730
- "updateEntityAttributes": {
2731
- "type": "array",
2732
- "items": {
2733
- "$ref": "#/components/schemas/UpdateEntityAttributes"
2734
- }
2735
- },
2736
- "taxonomies": {
2737
- "type": "array",
2738
- "items": {
2739
- "type": "string"
2740
- },
2741
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2742
- },
2743
- "singleClosingReasonSelection": {
2744
- "type": "boolean",
2745
- "description": "Whether only a single closing reason can be selected"
2746
- },
2747
- "_manifest": {
2748
- "type": "array",
2749
- "description": "The manifest IDs associated with this workflow",
2750
- "items": {
2751
- "type": "string"
2752
- }
2753
- }
2754
- },
2755
- "required": [
2756
- "name",
2757
- "flow"
2758
- ]
2759
- },
2760
- "Step": {
2761
- "type": "object",
2762
- "description": "Action that needs to be done in a Workflow",
2763
- "properties": {
2764
- "id": {
2765
- "type": "string"
2766
- },
2767
- "name": {
2768
- "type": "string"
2769
- },
2770
- "description": {
2771
- "$ref": "#/components/schemas/StepDescription"
2772
- },
2773
- "executionType": {
2774
- "$ref": "#/components/schemas/StepType"
2775
- },
2776
- "automationConfig": {
2777
- "type": "object",
2778
- "properties": {
2779
- "flowId": {
2780
- "type": "string",
2781
- "description": "Id of the configured automation to run"
2782
- }
2783
- },
2784
- "required": [
2785
- "flowId"
2786
- ]
2787
- },
2788
- "journey": {
2789
- "$ref": "#/components/schemas/StepJourney"
2790
- },
2791
- "order": {
2792
- "type": "number"
2793
- },
2794
- "dueDate": {
2795
- "type": "string",
2796
- "example": "2021-04-27T12:00:00.000Z"
2797
- },
2798
- "dynamicDueDate": {
2799
- "$ref": "#/components/schemas/DynamicDueDate"
2800
- },
2801
- "userIds": {
2802
- "type": "array",
2803
- "items": {
2804
- "type": "number"
2805
- },
2806
- "deprecated": true,
2807
- "description": "This field is deprecated. Please use assignedTo"
2808
- },
2809
- "requirements": {
2810
- "type": "array",
2811
- "description": "requirements that need to be fulfilled in order to enable the step execution",
2812
- "items": {
2813
- "$ref": "#/components/schemas/StepRequirement"
2814
- }
2815
- },
2816
- "assignedTo": {
2817
- "type": "array",
2818
- "items": {
2819
- "type": "string"
2820
- }
2821
- },
2822
- "type": {
2823
- "$ref": "#/components/schemas/ItemType"
2824
- },
2825
- "ecp": {
2826
- "$ref": "#/components/schemas/ECPDetails"
2827
- },
2828
- "installer": {
2829
- "$ref": "#/components/schemas/ECPDetails"
2830
- },
2831
- "partner": {
2832
- "$ref": "#/components/schemas/PartnerDetails",
2833
- "description": "Partner-specific task details shown to partner org users viewing shared resources"
2834
- },
2835
- "taxonomies": {
2836
- "type": "array",
2837
- "items": {
2838
- "type": "string"
2839
- },
2840
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2841
- }
2842
- },
2843
- "required": [
2844
- "name",
2845
- "order",
2846
- "type"
2847
- ]
2848
- },
2849
- "Section": {
2850
- "type": "object",
2851
- "description": "A group of Steps that define the progress of the Workflow",
2852
- "properties": {
2853
- "id": {
2854
- "type": "string"
2855
- },
2856
- "name": {
2857
- "type": "string"
2858
- },
2859
- "order": {
2860
- "type": "number"
2861
- },
2862
- "type": {
2863
- "$ref": "#/components/schemas/ItemType"
2864
- },
2865
- "dueDate": {
2866
- "type": "string",
2867
- "example": "2021-04-27T12:00:00.000Z"
2868
- },
2869
- "dynamicDueDate": {
2870
- "$ref": "#/components/schemas/DynamicDueDate"
2871
- },
2872
- "assignedTo": {
2873
- "type": "array",
2874
- "items": {
2875
- "type": "string"
2876
- }
2877
- },
2878
- "steps": {
2879
- "type": "array",
2880
- "items": {
2881
- "$ref": "#/components/schemas/Step"
2882
- }
2883
- },
2884
- "taxonomies": {
2885
- "type": "array",
2886
- "items": {
2887
- "type": "string"
2888
- },
2889
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2890
- }
2891
- },
2892
- "required": [
2893
- "name",
2894
- "order",
2895
- "type",
2896
- "steps"
2897
- ]
2898
- },
2899
- "TriggerType": {
2900
- "type": "string",
2901
- "enum": [
2902
- "MANUAL",
2903
- "AUTOMATIC"
2904
- ]
2905
- },
2906
- "ItemType": {
2907
- "type": "string",
2908
- "enum": [
2909
- "STEP",
2910
- "SECTION"
2911
- ]
2912
- },
2913
- "StepType": {
2914
- "type": "string",
2915
- "enum": [
2916
- "MANUAL",
2917
- "AUTOMATION"
2918
- ]
2919
- },
2920
- "StepJourney": {
2921
- "type": "object",
2922
- "properties": {
2923
- "id": {
2924
- "type": "string"
2925
- },
2926
- "journeyId": {
2927
- "type": "string"
2928
- },
2929
- "name": {
2930
- "type": "string"
2931
- },
2932
- "complete_task_automatically": {
2933
- "type": "boolean",
2934
- "default": true,
2935
- "description": "If true, the task be auto completed when the journey is completed. By default it is true."
2936
- }
2937
- }
2938
- },
2939
- "ECPDetails": {
2940
- "type": "object",
2941
- "description": "Details regarding ECP for the workflow step",
2942
- "properties": {
2943
- "enabled": {
2944
- "type": "boolean"
2945
- },
2946
- "label": {
2947
- "type": "string"
2948
- },
2949
- "description": {
2950
- "type": "string"
2951
- },
2952
- "journey": {
2953
- "$ref": "#/components/schemas/StepJourney"
2954
- }
2955
- }
2956
- },
2957
- "PartnerDetails": {
2958
- "type": "object",
2959
- "description": "Details regarding partner for the workflow step",
2960
- "properties": {
2961
- "enabled": {
2962
- "type": "boolean"
2963
- },
2964
- "label": {
2965
- "type": "string"
2966
- },
2967
- "description": {
2968
- "type": "string"
2969
- }
2970
- }
2971
- },
2972
- "StepDescription": {
2973
- "type": "object",
2974
- "description": "Longer information regarding Task",
2975
- "properties": {
2976
- "enabled": {
2977
- "type": "boolean"
2978
- },
2979
- "value": {
2980
- "type": "string"
2981
- }
2982
- }
2983
- },
2984
- "MaxAllowedLimit": {
2985
- "type": "object",
2986
- "properties": {
2987
- "currentNoOfWorkflows": {
2988
- "type": "number"
2989
- },
2990
- "maxAllowed": {
2991
- "type": "number"
2992
- }
2993
- }
2994
- },
2995
- "DefinitionNotFoundResp": {
2996
- "description": "Definition could be not found",
2997
- "properties": {
2998
- "message": {
2999
- "type": "string"
3000
- }
3001
- }
3002
- },
3003
- "ClosingReasonNotFoundResp": {
3004
- "description": "Closing reason could be not found",
3005
- "properties": {
3006
- "message": {
3007
- "type": "string"
3008
- }
3009
- }
3010
- },
3011
- "ChangeReasonStatusReq": {
3012
- "type": "object",
3013
- "properties": {
3014
- "status": {
3015
- "$ref": "#/components/schemas/ClosingReasonsStatus"
3016
- }
3017
- },
3018
- "required": [
3019
- "status"
3020
- ]
3021
- },
3022
- "ClosingReasons": {
3023
- "type": "object",
3024
- "properties": {
3025
- "reasons": {
3026
- "type": "array",
3027
- "items": {
3028
- "$ref": "#/components/schemas/ClosingReason"
3029
- }
3030
- }
3031
- },
3032
- "required": [
3033
- "reasons"
3034
- ]
3035
- },
3036
- "ClosingReason": {
3037
- "type": "object",
3038
- "description": "One Closing reason for a workflow",
3039
- "properties": {
3040
- "id": {
3041
- "type": "string"
3042
- },
3043
- "title": {
3044
- "type": "string"
3045
- },
3046
- "status": {
3047
- "$ref": "#/components/schemas/ClosingReasonsStatus"
3048
- },
3049
- "lastUpdateTime": {
3050
- "type": "string",
3051
- "readOnly": true
3052
- },
3053
- "creationTime": {
3054
- "type": "string",
3055
- "readOnly": true
3056
- }
3057
- }
3058
- },
3059
- "ClosingReasonsStatus": {
3060
- "type": "string",
3061
- "enum": [
3062
- "ACTIVE",
3063
- "INACTIVE"
3064
- ]
3065
- },
3066
- "ClosingReasonsIds": {
3067
- "type": "object",
3068
- "properties": {
3069
- "reasons": {
3070
- "type": "array",
3071
- "items": {
3072
- "$ref": "#/components/schemas/ClosingReasonId"
3073
- }
3074
- }
3075
- },
3076
- "required": [
3077
- "reasons"
3078
- ]
3079
- },
3080
- "ClosingReasonId": {
3081
- "type": "object",
3082
- "properties": {
3083
- "id": {
3084
- "type": "string",
3085
- "example": "x739cew"
3086
- }
3087
- },
3088
- "required": [
3089
- "id"
3090
- ]
3091
- },
3092
- "ErrorResp": {
3093
- "type": "object",
3094
- "properties": {
3095
- "message": {
3096
- "type": "string"
3097
- }
3098
- }
3099
- },
3100
- "UpdateEntityAttributes": {
3101
- "type": "object",
3102
- "properties": {
3103
- "source": {
3104
- "type": "string",
3105
- "enum": [
3106
- "workflow_status",
3107
- "current_section",
3108
- "current_step"
3109
- ]
3110
- },
3111
- "target": {
3112
- "type": "object",
3113
- "properties": {
3114
- "entitySchema": {
3115
- "type": "string",
3116
- "example": "opportunity"
3117
- },
3118
- "entityAttribute": {
3119
- "type": "string",
3120
- "example": "my_status"
3121
- }
3122
- },
3123
- "required": [
3124
- "entitySchema",
3125
- "entityAttribute"
3126
- ]
3127
- }
3128
- },
3129
- "required": [
3130
- "source",
3131
- "target"
3132
- ]
3133
- },
3134
- "EntitySync": {
3135
- "type": "object",
3136
- "properties": {
3137
- "trigger": {
3138
- "type": "object",
3139
- "description": "Trigger configuration that determines when entity sync occurs.\nContains the event type and optional filter to target specific tasks/phases.\n",
3140
- "required": [
3141
- "event"
3142
- ],
3143
- "properties": {
3144
- "event": {
3145
- "type": "string",
3146
- "description": "Event or condition that triggers the entity sync.\nDirect triggers match EventBridge event names (PascalCase).\nStatus triggers are deduced from event + entity status combination.\n",
3147
- "enum": [
3148
- "FlowStarted",
3149
- "FlowCompleted",
3150
- "FlowCancelled",
3151
- "FlowReopened",
3152
- "FlowDeleted",
3153
- "FlowAssigned",
3154
- "FlowDueDateChanged",
3155
- "FlowContextsChanged",
3156
- "TaskUpdated",
3157
- "CurrTaskChanged",
3158
- "TaskCompleted",
3159
- "TaskSkipped",
3160
- "TaskMarkedInProgress",
3161
- "TaskMarkedOnHold",
3162
- "PhaseUpdated",
3163
- "PhaseCompleted",
3164
- "PhaseSkipped",
3165
- "PhaseMarkedInProgress"
3166
- ]
3167
- },
3168
- "filter": {
3169
- "type": "object",
3170
- "description": "Optional filter to target specific tasks or phases.\nSpecify either task_template_id OR phase_template_id (mutually exclusive).\nIf omitted, trigger applies to all tasks/phases.\n",
3171
- "properties": {
3172
- "task_template_id": {
3173
- "type": "string",
3174
- "description": "Target a specific task by its template ID (stable across executions)"
3175
- },
3176
- "phase_template_id": {
3177
- "type": "string",
3178
- "description": "Target a specific phase by its template ID (stable across executions)"
3179
- }
3180
- }
3181
- }
3182
- }
3183
- },
3184
- "value": {
3185
- "type": "object",
3186
- "properties": {
3187
- "source": {
3188
- "type": "string",
3189
- "enum": [
3190
- "workflow_name",
3191
- "workflow_status",
3192
- "workflow_assigned_to",
3193
- "task_name",
3194
- "task_status",
3195
- "task_assigned_to",
3196
- "phase_name",
3197
- "phase_status",
3198
- "phase_assigned_to",
3199
- "custom_value"
3200
- ]
3201
- },
3202
- "value": {
3203
- "type": "string"
3204
- }
3205
- },
3206
- "required": [
3207
- "source"
3208
- ]
3209
- },
3210
- "target": {
3211
- "type": "object",
3212
- "properties": {
3213
- "entitySchema": {
3214
- "type": "string",
3215
- "example": "opportunity"
3216
- },
3217
- "entityAttribute": {
3218
- "type": "string",
3219
- "example": "title"
3220
- }
3221
- },
3222
- "required": [
3223
- "entitySchema",
3224
- "entityAttribute"
3225
- ]
3226
- }
3227
- },
3228
- "example": {
3229
- "trigger": {
3230
- "event": "FlowStarted"
3231
- },
3232
- "target": {
3233
- "entitySchema": "opportunity",
3234
- "entityAttribute": "title"
3235
- },
3236
- "value": {
3237
- "source": "workflow_name"
3238
- }
3239
- },
3240
- "required": [
3241
- "trigger",
3242
- "target",
3243
- "value"
3244
- ]
3245
- },
3246
- "DynamicDueDate": {
3247
- "description": "set a Duedate for a step then a specific",
3248
- "type": "object",
3249
- "properties": {
3250
- "numberOfUnits": {
3251
- "type": "number"
3252
- },
3253
- "timePeriod": {
3254
- "$ref": "#/components/schemas/TimeUnit"
3255
- },
3256
- "actionTypeCondition": {
3257
- "type": "string",
3258
- "enum": [
3259
- "WORKFLOW_STARTED",
3260
- "STEP_CLOSED",
3261
- "PHASE_FINISHED"
3262
- ]
3263
- },
3264
- "stepId": {
3265
- "type": "string"
3266
- },
3267
- "phaseId": {
3268
- "type": "string"
3269
- }
3270
- },
3271
- "required": [
3272
- "numberOfUnits",
3273
- "timePeriod",
3274
- "actionTypeCondition"
3275
- ]
3276
- },
3277
- "StepRequirement": {
3278
- "description": "describe the requirement for step enablement",
3279
- "type": "object",
3280
- "properties": {
3281
- "definitionId": {
3282
- "type": "string"
3283
- },
3284
- "type": {
3285
- "$ref": "#/components/schemas/ItemType"
3286
- },
3287
- "condition": {
3288
- "type": "string",
3289
- "enum": [
3290
- "CLOSED"
3291
- ]
3292
- }
3293
- },
3294
- "required": [
3295
- "definitionId",
3296
- "type",
3297
- "condition"
3298
- ]
3299
- }
3300
- }
3301
- }
3302
- }