@epilot/sdk 2.1.10 → 2.2.1

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 (95) hide show
  1. package/dist/bin/cli.js +66 -12
  2. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  3. package/package.json +1 -1
  4. package/definitions/access-token-runtime.json +0 -1
  5. package/definitions/access-token.json +0 -663
  6. package/definitions/address-runtime.json +0 -1
  7. package/definitions/address-suggestions-runtime.json +0 -1
  8. package/definitions/address-suggestions.json +0 -582
  9. package/definitions/address.json +0 -578
  10. package/definitions/ai-agents-runtime.json +0 -1
  11. package/definitions/ai-agents.json +0 -1711
  12. package/definitions/app-runtime.json +0 -1
  13. package/definitions/app.json +0 -4493
  14. package/definitions/audit-logs-runtime.json +0 -1
  15. package/definitions/audit-logs.json +0 -305
  16. package/definitions/automation-runtime.json +0 -1
  17. package/definitions/automation.json +0 -4815
  18. package/definitions/billing-runtime.json +0 -1
  19. package/definitions/billing.json +0 -837
  20. package/definitions/blueprint-manifest-runtime.json +0 -1
  21. package/definitions/blueprint-manifest.json +0 -3490
  22. package/definitions/consent-runtime.json +0 -1
  23. package/definitions/consent.json +0 -344
  24. package/definitions/customer-portal-runtime.json +0 -1
  25. package/definitions/customer-portal.json +0 -15676
  26. package/definitions/dashboard-runtime.json +0 -1
  27. package/definitions/dashboard.json +0 -484
  28. package/definitions/data-management-runtime.json +0 -1
  29. package/definitions/data-management.json +0 -972
  30. package/definitions/deduplication-runtime.json +0 -1
  31. package/definitions/deduplication.json +0 -183
  32. package/definitions/design-runtime.json +0 -1
  33. package/definitions/design.json +0 -1423
  34. package/definitions/document-runtime.json +0 -1
  35. package/definitions/document.json +0 -758
  36. package/definitions/email-settings-runtime.json +0 -1
  37. package/definitions/email-settings.json +0 -2748
  38. package/definitions/email-template-runtime.json +0 -1
  39. package/definitions/email-template.json +0 -1441
  40. package/definitions/entity-mapping-runtime.json +0 -1
  41. package/definitions/entity-mapping.json +0 -1642
  42. package/definitions/entity-runtime.json +0 -1
  43. package/definitions/entity.json +0 -10276
  44. package/definitions/environments-runtime.json +0 -1
  45. package/definitions/environments.json +0 -363
  46. package/definitions/erp-integration-runtime.json +0 -1
  47. package/definitions/erp-integration.json +0 -6304
  48. package/definitions/event-catalog-runtime.json +0 -1
  49. package/definitions/event-catalog.json +0 -1051
  50. package/definitions/file-runtime.json +0 -1
  51. package/definitions/file.json +0 -2842
  52. package/definitions/iban-runtime.json +0 -1
  53. package/definitions/iban.json +0 -132
  54. package/definitions/journey-runtime.json +0 -1
  55. package/definitions/journey.json +0 -2603
  56. package/definitions/kanban-runtime.json +0 -1
  57. package/definitions/kanban.json +0 -1505
  58. package/definitions/message-runtime.json +0 -1
  59. package/definitions/message.json +0 -2660
  60. package/definitions/metering-runtime.json +0 -1
  61. package/definitions/metering.json +0 -2321
  62. package/definitions/notes-runtime.json +0 -1
  63. package/definitions/notes.json +0 -1531
  64. package/definitions/notification-runtime.json +0 -1
  65. package/definitions/notification.json +0 -1425
  66. package/definitions/organization-runtime.json +0 -1
  67. package/definitions/organization.json +0 -1192
  68. package/definitions/partner-directory-runtime.json +0 -1
  69. package/definitions/partner-directory.json +0 -2284
  70. package/definitions/permissions-runtime.json +0 -1
  71. package/definitions/permissions.json +0 -1515
  72. package/definitions/pricing-runtime.json +0 -1
  73. package/definitions/pricing-tier-runtime.json +0 -1
  74. package/definitions/pricing-tier.json +0 -105
  75. package/definitions/pricing.json +0 -9884
  76. package/definitions/purpose-runtime.json +0 -1
  77. package/definitions/purpose.json +0 -524
  78. package/definitions/sandbox-runtime.json +0 -1
  79. package/definitions/sandbox.json +0 -453
  80. package/definitions/submission-runtime.json +0 -1
  81. package/definitions/submission.json +0 -313
  82. package/definitions/targeting-runtime.json +0 -1
  83. package/definitions/targeting.json +0 -1474
  84. package/definitions/template-variables-runtime.json +0 -1
  85. package/definitions/template-variables.json +0 -1408
  86. package/definitions/user-runtime.json +0 -1
  87. package/definitions/user.json +0 -2408
  88. package/definitions/validation-rules-runtime.json +0 -1
  89. package/definitions/validation-rules.json +0 -1491
  90. package/definitions/webhooks-runtime.json +0 -1
  91. package/definitions/webhooks.json +0 -1634
  92. package/definitions/workflow-definition-runtime.json +0 -1
  93. package/definitions/workflow-definition.json +0 -3417
  94. package/definitions/workflow-runtime.json +0 -1
  95. package/definitions/workflow.json +0 -4146
@@ -1,1634 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "Webhooks",
5
- "version": "1.0.0",
6
- "description": "Service for configuring webhooks on different events\n"
7
- },
8
- "tags": [
9
- {
10
- "name": "webhooks",
11
- "description": "Configure and trigger webhooks"
12
- },
13
- {
14
- "name": "example",
15
- "description": "Generate example payloads for webhooks"
16
- }
17
- ],
18
- "paths": {
19
- "/v1/webhooks/.well-known/public-key": {
20
- "get": {
21
- "operationId": "getPublicKey",
22
- "summary": "getPublicKey",
23
- "parameters": [
24
- {
25
- "in": "query",
26
- "name": "orgId",
27
- "schema": {
28
- "type": "string"
29
- },
30
- "required": true,
31
- "description": "Organization ID to retrieve the public key for."
32
- }
33
- ],
34
- "description": "Returns 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 required to ensure clients retrieve the correct key for their organization in case of key rotation.\n",
35
- "tags": [
36
- "webhooks"
37
- ],
38
- "security": [],
39
- "responses": {
40
- "200": {
41
- "description": "Success - public key returned",
42
- "content": {
43
- "application/json": {
44
- "schema": {
45
- "$ref": "#/components/schemas/PublicKeyResponse"
46
- }
47
- }
48
- }
49
- },
50
- "500": {
51
- "description": "Internal server error",
52
- "content": {
53
- "application/json": {
54
- "schema": {
55
- "$ref": "#/components/schemas/ErrorResp"
56
- }
57
- }
58
- }
59
- }
60
- }
61
- }
62
- },
63
- "/v1/webhooks/configured-events": {
64
- "get": {
65
- "operationId": "getConfiguredEvents",
66
- "summary": "getConfiguredEvents",
67
- "description": "Retrieve events that can trigger webhooks",
68
- "tags": [
69
- "webhooks"
70
- ],
71
- "responses": {
72
- "200": {
73
- "description": "Success - configured events loaded with success. Empty array if no events have been configured.",
74
- "content": {
75
- "application/json": {
76
- "schema": {
77
- "$ref": "#/components/schemas/EventConfigResp"
78
- }
79
- }
80
- }
81
- }
82
- }
83
- }
84
- },
85
- "/v1/webhooks/configs": {
86
- "get": {
87
- "operationId": "getConfigs",
88
- "summary": "getConfigs",
89
- "description": "Search Webhook Client Configs",
90
- "tags": [
91
- "webhooks"
92
- ],
93
- "parameters": [
94
- {
95
- "in": "query",
96
- "name": "eventName",
97
- "schema": {
98
- "type": "string"
99
- },
100
- "required": false,
101
- "description": "Filter configurations by event Name",
102
- "example": "customer_request_created"
103
- }
104
- ],
105
- "responses": {
106
- "200": {
107
- "description": "Success - configs loaded with success. Empty array if org has configs.",
108
- "content": {
109
- "application/json": {
110
- "schema": {
111
- "type": "array",
112
- "items": {
113
- "$ref": "#/components/schemas/WebhookConfig"
114
- }
115
- }
116
- }
117
- }
118
- },
119
- "500": {
120
- "description": "Other errors",
121
- "content": {
122
- "application/json": {
123
- "schema": {
124
- "$ref": "#/components/schemas/ErrorResp"
125
- }
126
- }
127
- }
128
- }
129
- }
130
- },
131
- "post": {
132
- "operationId": "createConfig",
133
- "summary": "createConfig",
134
- "description": "Create Webhook Client Config",
135
- "tags": [
136
- "webhooks"
137
- ],
138
- "requestBody": {
139
- "description": "Webhook config payload",
140
- "required": true,
141
- "content": {
142
- "application/json": {
143
- "schema": {
144
- "$ref": "#/components/schemas/WebhookConfig"
145
- }
146
- }
147
- }
148
- },
149
- "responses": {
150
- "201": {
151
- "description": "Success - if the config is created successfully",
152
- "content": {
153
- "application/json": {
154
- "schema": {
155
- "$ref": "#/components/schemas/WebhookConfig"
156
- }
157
- }
158
- }
159
- },
160
- "400": {
161
- "description": "Validation Errors",
162
- "content": {
163
- "application/json": {
164
- "schema": {
165
- "$ref": "#/components/schemas/ErrorResp"
166
- }
167
- }
168
- }
169
- },
170
- "401": {
171
- "description": "Authentication Errors",
172
- "content": {
173
- "application/json": {
174
- "schema": {
175
- "$ref": "#/components/schemas/ErrorResp"
176
- }
177
- }
178
- }
179
- },
180
- "500": {
181
- "description": "Other errors",
182
- "content": {
183
- "application/json": {
184
- "schema": {
185
- "$ref": "#/components/schemas/ErrorResp"
186
- }
187
- }
188
- }
189
- }
190
- }
191
- }
192
- },
193
- "/v1/webhooks/configs/{configId}": {
194
- "get": {
195
- "operationId": "getConfig",
196
- "summary": "getConfig",
197
- "description": "Get webhook config by id",
198
- "tags": [
199
- "webhooks"
200
- ],
201
- "parameters": [
202
- {
203
- "in": "path",
204
- "name": "configId",
205
- "schema": {
206
- "type": "string"
207
- },
208
- "required": true,
209
- "description": "Short uuid to identify the webhook configuration.",
210
- "example": "7hj28aasgag2gha2"
211
- }
212
- ],
213
- "responses": {
214
- "200": {
215
- "description": "Success - if the config is updated successfully",
216
- "content": {
217
- "application/json": {
218
- "schema": {
219
- "$ref": "#/components/schemas/WebhookConfig"
220
- }
221
- }
222
- }
223
- },
224
- "404": {
225
- "description": "No configuration found for this id",
226
- "content": {
227
- "application/json": {
228
- "schema": {
229
- "$ref": "#/components/schemas/ErrorResp"
230
- }
231
- }
232
- }
233
- },
234
- "500": {
235
- "description": "Other errors",
236
- "content": {
237
- "application/json": {
238
- "schema": {
239
- "$ref": "#/components/schemas/ErrorResp"
240
- }
241
- }
242
- }
243
- }
244
- }
245
- },
246
- "put": {
247
- "operationId": "updateConfig",
248
- "summary": "updateConfig",
249
- "description": "Update Webhook Client Config",
250
- "tags": [
251
- "webhooks"
252
- ],
253
- "parameters": [
254
- {
255
- "in": "path",
256
- "name": "configId",
257
- "schema": {
258
- "type": "string"
259
- },
260
- "required": true,
261
- "description": "Short uuid (length 6) to identify the webhook configuration.",
262
- "example": "7hj28a"
263
- }
264
- ],
265
- "requestBody": {
266
- "description": "Webhook config payload",
267
- "required": true,
268
- "content": {
269
- "application/json": {
270
- "schema": {
271
- "$ref": "#/components/schemas/WebhookConfig"
272
- }
273
- }
274
- }
275
- },
276
- "responses": {
277
- "200": {
278
- "description": "Success - if the config is updated successfully",
279
- "content": {
280
- "application/json": {
281
- "schema": {
282
- "$ref": "#/components/schemas/WebhookConfig"
283
- }
284
- }
285
- }
286
- },
287
- "400": {
288
- "description": "Validation Errors",
289
- "content": {
290
- "application/json": {
291
- "schema": {
292
- "$ref": "#/components/schemas/ErrorResp"
293
- }
294
- }
295
- }
296
- },
297
- "401": {
298
- "description": "Authentication Errors",
299
- "content": {
300
- "application/json": {
301
- "schema": {
302
- "$ref": "#/components/schemas/ErrorResp"
303
- }
304
- }
305
- }
306
- },
307
- "500": {
308
- "description": "Other errors",
309
- "content": {
310
- "application/json": {
311
- "schema": {
312
- "$ref": "#/components/schemas/ErrorResp"
313
- }
314
- }
315
- }
316
- }
317
- }
318
- },
319
- "delete": {
320
- "operationId": "deleteConfig",
321
- "summary": "deleteConfig",
322
- "description": "Delete Webhook Client Config",
323
- "tags": [
324
- "webhooks"
325
- ],
326
- "parameters": [
327
- {
328
- "in": "path",
329
- "name": "configId",
330
- "schema": {
331
- "type": "string"
332
- },
333
- "required": true,
334
- "description": "Id of the config to de deleted.",
335
- "example": "CustomerRequest"
336
- }
337
- ],
338
- "responses": {
339
- "204": {
340
- "description": "Success - if the config is deleted successfully"
341
- },
342
- "401": {
343
- "description": "Failed to authenticate",
344
- "content": {
345
- "application/json": {
346
- "schema": {
347
- "$ref": "#/components/schemas/ErrorResp"
348
- }
349
- }
350
- }
351
- },
352
- "404": {
353
- "description": "No config found"
354
- }
355
- }
356
- }
357
- },
358
- "/v1/webhooks/configs/{configId}/trigger": {
359
- "post": {
360
- "operationId": "triggerWebhook",
361
- "summary": "triggers a webhook event either async or sync",
362
- "description": "Trigger a webhook",
363
- "tags": [
364
- "webhooks",
365
- "trigger"
366
- ],
367
- "parameters": [
368
- {
369
- "in": "query",
370
- "name": "sync",
371
- "description": "If set to true, the webhook will be triggered synchronously. Otherwise, it will be triggered asynchronously.",
372
- "schema": {
373
- "type": "boolean"
374
- }
375
- },
376
- {
377
- "in": "path",
378
- "name": "configId",
379
- "schema": {
380
- "type": "string"
381
- },
382
- "required": true,
383
- "description": "Short uuid to identify the webhook configuration.",
384
- "example": "7hj28aasgag2gha2"
385
- }
386
- ],
387
- "requestBody": {
388
- "description": "Webhook payload",
389
- "required": true,
390
- "content": {
391
- "application/json": {
392
- "schema": {
393
- "$ref": "#/components/schemas/ExecutionPayload"
394
- }
395
- }
396
- }
397
- },
398
- "responses": {
399
- "200": {
400
- "description": "Success - if the webhook is triggered successfully",
401
- "content": {
402
- "application/json": {
403
- "schema": {
404
- "$ref": "#/components/schemas/TriggerWebhookResp"
405
- }
406
- }
407
- }
408
- },
409
- "400": {
410
- "description": "Validation Errors",
411
- "content": {
412
- "application/json": {
413
- "schema": {
414
- "$ref": "#/components/schemas/ErrorResp"
415
- }
416
- }
417
- }
418
- },
419
- "500": {
420
- "description": "Other errors",
421
- "content": {
422
- "application/json": {
423
- "schema": {
424
- "$ref": "#/components/schemas/ErrorResp"
425
- }
426
- }
427
- }
428
- }
429
- }
430
- }
431
- },
432
- "/v1/webhooks/configs/{configId}/events": {
433
- "get": {
434
- "deprecated": true,
435
- "operationId": "getWehookEvents",
436
- "summary": "getWehookEvents",
437
- "description": "This endpoint is deprecated and will be removed on 2025-12-31. Use /v2/webhooks/configs/{configId}/events instead.",
438
- "tags": [
439
- "webhooks",
440
- "events"
441
- ],
442
- "parameters": [
443
- {
444
- "in": "path",
445
- "name": "configId",
446
- "schema": {
447
- "type": "string"
448
- },
449
- "required": true,
450
- "description": "Short uuid to identify the webhook configuration.",
451
- "example": "7hj28aasgag2gha2"
452
- },
453
- {
454
- "in": "query",
455
- "name": "status",
456
- "schema": {
457
- "type": "string",
458
- "enum": [
459
- "succeeded",
460
- "failed",
461
- "in_progress"
462
- ]
463
- },
464
- "description": "Get all events for a given webhook config id",
465
- "example": "succeeded"
466
- },
467
- {
468
- "in": "query",
469
- "name": "cursor",
470
- "schema": {
471
- "type": "string"
472
- },
473
- "required": false,
474
- "description": "Base64 encoded cursor to be used for pagination"
475
- }
476
- ],
477
- "responses": {
478
- "200": {
479
- "description": "Success - list events",
480
- "content": {
481
- "application/json": {
482
- "schema": {
483
- "type": "object",
484
- "properties": {
485
- "data": {
486
- "type": "array",
487
- "items": {
488
- "$ref": "#/components/schemas/WebhookEvent"
489
- }
490
- },
491
- "cursor": {
492
- "type": "string",
493
- "description": "Cursor to be used for pagination"
494
- }
495
- }
496
- }
497
- }
498
- }
499
- },
500
- "404": {
501
- "description": "No events found",
502
- "content": {
503
- "application/json": {
504
- "schema": {
505
- "$ref": "#/components/schemas/ErrorResp"
506
- }
507
- }
508
- }
509
- },
510
- "500": {
511
- "description": "Other errors",
512
- "content": {
513
- "application/json": {
514
- "schema": {
515
- "$ref": "#/components/schemas/ErrorResp"
516
- }
517
- }
518
- }
519
- }
520
- }
521
- }
522
- },
523
- "/v1/webhooks/configs/{configId}/events/replay-batch": {
524
- "post": {
525
- "operationId": "batchReplayEvents",
526
- "summary": "batchReplayEvents",
527
- "description": "Replay a batch of webhook events",
528
- "tags": [
529
- "webhooks",
530
- "events"
531
- ],
532
- "parameters": [
533
- {
534
- "in": "path",
535
- "name": "configId",
536
- "schema": {
537
- "type": "string"
538
- },
539
- "required": true,
540
- "description": "Short uuid to identify the webhook configuration.",
541
- "example": "7hj28aasgag2gha2"
542
- }
543
- ],
544
- "requestBody": {
545
- "description": "Batch replay request payload",
546
- "required": true,
547
- "content": {
548
- "application/json": {
549
- "schema": {
550
- "$ref": "#/components/schemas/BatchReplayRequest"
551
- }
552
- }
553
- }
554
- },
555
- "responses": {
556
- "202": {
557
- "description": "Success - enqueued events for replay",
558
- "content": {
559
- "application/json": {
560
- "schema": {
561
- "type": "object",
562
- "properties": {
563
- "replayed_event_ids": {
564
- "type": "array",
565
- "items": {
566
- "type": "string"
567
- },
568
- "description": "List of event ids that were enqueued for replay"
569
- }
570
- }
571
- }
572
- }
573
- }
574
- },
575
- "400": {
576
- "description": "Validation Errors",
577
- "content": {
578
- "application/json": {
579
- "schema": {
580
- "$ref": "#/components/schemas/ErrorResp"
581
- }
582
- }
583
- }
584
- },
585
- "404": {
586
- "description": "No webhook config found",
587
- "content": {
588
- "application/json": {
589
- "schema": {
590
- "$ref": "#/components/schemas/ErrorResp"
591
- }
592
- }
593
- }
594
- },
595
- "500": {
596
- "description": "Other errors",
597
- "content": {
598
- "application/json": {
599
- "schema": {
600
- "$ref": "#/components/schemas/ErrorResp"
601
- }
602
- }
603
- }
604
- }
605
- }
606
- }
607
- },
608
- "/v1/webhooks/configs/{configId}/events/{eventId}": {
609
- "get": {
610
- "operationId": "getEventById",
611
- "summary": "getEventById",
612
- "description": "Get a webhook event by its id",
613
- "tags": [
614
- "webhooks",
615
- "event"
616
- ],
617
- "parameters": [
618
- {
619
- "in": "path",
620
- "name": "configId",
621
- "schema": {
622
- "type": "string"
623
- },
624
- "required": true,
625
- "description": "Short uuid to identify the webhook configuration.",
626
- "example": "7hj28aasgag2gha2"
627
- },
628
- {
629
- "in": "path",
630
- "name": "eventId",
631
- "schema": {
632
- "type": "string"
633
- },
634
- "required": true,
635
- "description": "Event id"
636
- }
637
- ],
638
- "responses": {
639
- "200": {
640
- "description": "Success - event",
641
- "content": {
642
- "application/json": {
643
- "schema": {
644
- "$ref": "#/components/schemas/WebhookEvent"
645
- }
646
- }
647
- }
648
- },
649
- "404": {
650
- "description": "No events found",
651
- "content": {
652
- "application/json": {
653
- "schema": {
654
- "$ref": "#/components/schemas/ErrorResp"
655
- }
656
- }
657
- }
658
- },
659
- "500": {
660
- "description": "Other errors",
661
- "content": {
662
- "application/json": {
663
- "schema": {
664
- "$ref": "#/components/schemas/ErrorResp"
665
- }
666
- }
667
- }
668
- }
669
- }
670
- }
671
- },
672
- "/v1/webhooks/configs/{configId}/events/{eventId}/replay": {
673
- "post": {
674
- "operationId": "replayEvent",
675
- "summary": "replayEvent",
676
- "description": "Replay a webhook event",
677
- "tags": [
678
- "webhooks",
679
- "event"
680
- ],
681
- "parameters": [
682
- {
683
- "in": "path",
684
- "name": "configId",
685
- "schema": {
686
- "type": "string"
687
- },
688
- "required": true,
689
- "description": "Short uuid to identify the webhook configuration.",
690
- "example": "7hj28aasgag2gha2"
691
- },
692
- {
693
- "in": "path",
694
- "name": "eventId",
695
- "schema": {
696
- "type": "string"
697
- },
698
- "required": true,
699
- "description": "Event id"
700
- }
701
- ],
702
- "responses": {
703
- "204": {
704
- "description": "Success - replay event"
705
- },
706
- "404": {
707
- "description": "No events found",
708
- "content": {
709
- "application/json": {
710
- "schema": {
711
- "$ref": "#/components/schemas/ErrorResp"
712
- }
713
- }
714
- }
715
- },
716
- "500": {
717
- "description": "Other errors",
718
- "content": {
719
- "application/json": {
720
- "schema": {
721
- "$ref": "#/components/schemas/ErrorResp"
722
- }
723
- }
724
- }
725
- }
726
- }
727
- }
728
- },
729
- "/v1/webhooks/configs/{configId}/example": {
730
- "post": {
731
- "operationId": "getWebhookExample",
732
- "summary": "getWebhookExample",
733
- "description": "Generate an example payload for a webhook configuration based on trigger type",
734
- "tags": [
735
- "webhooks",
736
- "example"
737
- ],
738
- "parameters": [
739
- {
740
- "in": "path",
741
- "name": "configId",
742
- "schema": {
743
- "type": "string"
744
- },
745
- "required": true,
746
- "description": "Short uuid to identify the webhook configuration.",
747
- "example": "7hj28aasgag2gha2"
748
- }
749
- ],
750
- "requestBody": {
751
- "description": "Example generation parameters",
752
- "required": true,
753
- "content": {
754
- "application/json": {
755
- "schema": {
756
- "$ref": "#/components/schemas/ExampleRequest"
757
- }
758
- }
759
- }
760
- },
761
- "responses": {
762
- "200": {
763
- "description": "Success - example payload generated",
764
- "content": {
765
- "application/json": {
766
- "schema": {
767
- "$ref": "#/components/schemas/ExampleResponse"
768
- }
769
- }
770
- }
771
- },
772
- "400": {
773
- "description": "Validation Errors",
774
- "content": {
775
- "application/json": {
776
- "schema": {
777
- "$ref": "#/components/schemas/ErrorResp"
778
- }
779
- }
780
- }
781
- },
782
- "404": {
783
- "description": "No configuration found for this configId",
784
- "content": {
785
- "application/json": {
786
- "schema": {
787
- "$ref": "#/components/schemas/ErrorResp"
788
- }
789
- }
790
- }
791
- },
792
- "500": {
793
- "description": "Other errors",
794
- "content": {
795
- "application/json": {
796
- "schema": {
797
- "$ref": "#/components/schemas/ErrorResp"
798
- }
799
- }
800
- }
801
- }
802
- }
803
- }
804
- },
805
- "/v2/webhooks/configs/{configId}/events": {
806
- "post": {
807
- "operationId": "getWebhookEventsV2",
808
- "summary": "getWebhookEventsV2",
809
- "description": "List webhook events and filter them by status, timestamp, etc.",
810
- "tags": [
811
- "Events"
812
- ],
813
- "parameters": [
814
- {
815
- "in": "path",
816
- "name": "configId",
817
- "schema": {
818
- "type": "string"
819
- },
820
- "required": true,
821
- "description": "Short uuid to identify the webhook configuration.",
822
- "example": "7hj28aasgag2gha2"
823
- }
824
- ],
825
- "requestBody": {
826
- "content": {
827
- "application/json": {
828
- "schema": {
829
- "$ref": "#/components/schemas/SearchOptions"
830
- }
831
- }
832
- }
833
- },
834
- "responses": {
835
- "200": {
836
- "description": "Success - events where loaded successfully. Empty array if org has no events.",
837
- "content": {
838
- "application/json": {
839
- "schema": {
840
- "$ref": "#/components/schemas/EventListResponse"
841
- }
842
- }
843
- }
844
- }
845
- }
846
- }
847
- }
848
- },
849
- "components": {
850
- "schemas": {
851
- "PublicKeyResponse": {
852
- "type": "object",
853
- "properties": {
854
- "public_key": {
855
- "type": "string",
856
- "description": "PEM-encoded Ed25519 public key for verifying webhook signatures",
857
- "example": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEA...\n-----END PUBLIC KEY-----\n"
858
- },
859
- "algorithm": {
860
- "type": "string",
861
- "description": "The signing algorithm used",
862
- "example": "ed25519"
863
- },
864
- "issuer": {
865
- "type": "string",
866
- "description": "The issuer of the signing key",
867
- "example": "epilot"
868
- }
869
- },
870
- "required": [
871
- "public_key",
872
- "algorithm"
873
- ]
874
- },
875
- "SearchOptions": {
876
- "type": "object",
877
- "properties": {
878
- "limit": {
879
- "type": "integer",
880
- "description": "Maximum number of results to return",
881
- "example": 25,
882
- "default": 25,
883
- "minimum": 1,
884
- "maximum": 25
885
- },
886
- "cursor": {
887
- "type": "object",
888
- "description": "Cursor for pagination. Use the next_cursor from the previous response to get the next page.",
889
- "properties": {
890
- "created_at": {
891
- "type": "string",
892
- "format": "date-time",
893
- "description": "Timestamp from the last event in the previous page",
894
- "example": "2025-10-31T12:34:56Z"
895
- },
896
- "event_id": {
897
- "type": "string",
898
- "description": "Event ID from the last event in the previous page",
899
- "example": "evt_1234567890abcdef"
900
- }
901
- }
902
- },
903
- "timestamp": {
904
- "type": "object",
905
- "description": "Filter events by timestamp range",
906
- "properties": {
907
- "from": {
908
- "type": "string",
909
- "format": "date-time",
910
- "description": "Start timestamp in ISO 8601 format",
911
- "example": "2025-10-01T00:00:00Z"
912
- },
913
- "to": {
914
- "type": "string",
915
- "format": "date-time",
916
- "description": "End timestamp in ISO 8601 format",
917
- "example": "2025-10-31T23:59:59Z"
918
- }
919
- }
920
- },
921
- "event_id": {
922
- "type": "string",
923
- "description": "Filter by specific event ID",
924
- "example": "evt_1234567890abcdef"
925
- },
926
- "status": {
927
- "type": "string",
928
- "description": "Filter by event outcome",
929
- "enum": [
930
- "succeeded",
931
- "failed",
932
- "skipped"
933
- ],
934
- "example": "succeeded"
935
- }
936
- }
937
- },
938
- "EventListResponse": {
939
- "type": "object",
940
- "properties": {
941
- "data": {
942
- "type": "array",
943
- "items": {
944
- "$ref": "#/components/schemas/WebhookEvent"
945
- },
946
- "description": "List of webhook events"
947
- },
948
- "next_cursor": {
949
- "type": "object",
950
- "nullable": true,
951
- "description": "Cursor to fetch the next page. Null if no more results.",
952
- "properties": {
953
- "created_at": {
954
- "type": "string",
955
- "format": "date-time",
956
- "example": "2025-10-31T12:34:56Z"
957
- },
958
- "event_id": {
959
- "type": "string",
960
- "example": "evt_1234567890abcdef"
961
- }
962
- }
963
- },
964
- "has_more": {
965
- "type": "boolean",
966
- "description": "Indicates if more results are available",
967
- "example": true
968
- }
969
- }
970
- },
971
- "HttpMethod": {
972
- "type": "string",
973
- "enum": [
974
- "GET",
975
- "POST",
976
- "PUT",
977
- "PATCH",
978
- "DELETE",
979
- "OPTIONS",
980
- "HEAD"
981
- ]
982
- },
983
- "AuthType": {
984
- "type": "string",
985
- "enum": [
986
- "BASIC",
987
- "OAUTH_CLIENT_CREDENTIALS",
988
- "API_KEY",
989
- "NONE"
990
- ]
991
- },
992
- "Filter": {
993
- "type": "object",
994
- "properties": {
995
- "keyToFilter": {
996
- "type": "string"
997
- },
998
- "supportedValues": {
999
- "type": "array",
1000
- "items": {
1001
- "type": "string"
1002
- }
1003
- }
1004
- },
1005
- "required": [
1006
- "keyToFilter",
1007
- "supportedValues"
1008
- ]
1009
- },
1010
- "WebhookCondition": {
1011
- "type": "object",
1012
- "description": "A condition that must be met for the webhook to fire.",
1013
- "properties": {
1014
- "field": {
1015
- "type": "string",
1016
- "description": "Dot-notation path to the field in the event payload (e.g. \"entity.status\", \"entity.line_items\")"
1017
- },
1018
- "operation": {
1019
- "type": "string",
1020
- "enum": [
1021
- "equals",
1022
- "not_equals",
1023
- "any_of",
1024
- "none_of",
1025
- "contains",
1026
- "not_contains",
1027
- "starts_with",
1028
- "ends_with",
1029
- "greater_than",
1030
- "less_than",
1031
- "greater_than_or_equals",
1032
- "less_than_or_equals",
1033
- "is_empty",
1034
- "is_not_empty"
1035
- ]
1036
- },
1037
- "values": {
1038
- "type": "array",
1039
- "description": "Values to compare against (not required for is_empty/is_not_empty)",
1040
- "items": {
1041
- "type": "string"
1042
- }
1043
- },
1044
- "field_type": {
1045
- "type": "string",
1046
- "description": "Type hint for the field (affects comparison logic)",
1047
- "enum": [
1048
- "string",
1049
- "number",
1050
- "boolean",
1051
- "date",
1052
- "datetime"
1053
- ],
1054
- "default": "string"
1055
- },
1056
- "is_array_field": {
1057
- "type": "boolean",
1058
- "description": "Whether the target field is an array (repeatable)",
1059
- "default": false
1060
- },
1061
- "repeatable_item_op": {
1062
- "type": "boolean",
1063
- "description": "When true, evaluates conditions per-item in repeatable array fields",
1064
- "default": false
1065
- }
1066
- },
1067
- "required": [
1068
- "field",
1069
- "operation"
1070
- ]
1071
- },
1072
- "WebhookConditionGroup": {
1073
- "type": "object",
1074
- "description": "A group of conditions with a logical operator. Multiple conditions are AND-ed by default.",
1075
- "properties": {
1076
- "conditions": {
1077
- "type": "array",
1078
- "items": {
1079
- "$ref": "#/components/schemas/WebhookCondition"
1080
- },
1081
- "maxItems": 10
1082
- },
1083
- "logical_operator": {
1084
- "type": "string",
1085
- "enum": [
1086
- "AND",
1087
- "OR"
1088
- ],
1089
- "default": "AND"
1090
- }
1091
- }
1092
- },
1093
- "Auth": {
1094
- "type": "object",
1095
- "properties": {
1096
- "authType": {
1097
- "$ref": "#/components/schemas/AuthType"
1098
- },
1099
- "basicAuthConfig": {
1100
- "$ref": "#/components/schemas/BasicAuthConfig"
1101
- },
1102
- "oauthConfig": {
1103
- "$ref": "#/components/schemas/OAuthConfig"
1104
- },
1105
- "apiKeyConfig": {
1106
- "$ref": "#/components/schemas/ApiKeyConfig"
1107
- }
1108
- },
1109
- "required": [
1110
- "authType"
1111
- ]
1112
- },
1113
- "BasicAuthConfig": {
1114
- "type": "object",
1115
- "description": "To be sent only if authType is BASIC",
1116
- "properties": {
1117
- "username": {
1118
- "type": "string"
1119
- },
1120
- "password": {
1121
- "type": "string"
1122
- },
1123
- "passwordIsEnvVar": {
1124
- "type": "boolean",
1125
- "description": "When true, indicates the password value is an environment variable reference (e.g. {{ env.my_secret }})"
1126
- }
1127
- },
1128
- "required": [
1129
- "username"
1130
- ]
1131
- },
1132
- "OAuthConfig": {
1133
- "type": "object",
1134
- "description": "To be sent only if authType is OAUTH_CLIENT_CREDENTIALS",
1135
- "properties": {
1136
- "clientId": {
1137
- "type": "string"
1138
- },
1139
- "clientSecret": {
1140
- "type": "string"
1141
- },
1142
- "clientSecretIsEnvVar": {
1143
- "type": "boolean",
1144
- "description": "When true, indicates the clientSecret value is an environment variable reference (e.g. {{ env.my_secret }})"
1145
- },
1146
- "endpoint": {
1147
- "type": "string",
1148
- "description": "Https Endpoint for authentication"
1149
- },
1150
- "httpMethod": {
1151
- "$ref": "#/components/schemas/HttpMethod"
1152
- },
1153
- "customParameterList": {
1154
- "type": "array",
1155
- "items": {
1156
- "$ref": "#/components/schemas/CustomOAuthParameter"
1157
- }
1158
- }
1159
- },
1160
- "required": [
1161
- "clientId",
1162
- "endpoint",
1163
- "httpMethod"
1164
- ]
1165
- },
1166
- "ApiKeyConfig": {
1167
- "type": "object",
1168
- "description": "To be sent only if authType is API_KEY",
1169
- "properties": {
1170
- "keyName": {
1171
- "type": "string"
1172
- },
1173
- "keyValue": {
1174
- "type": "string"
1175
- },
1176
- "keyValueIsEnvVar": {
1177
- "type": "boolean",
1178
- "description": "When true, indicates the keyValue is an environment variable reference (e.g. {{ env.my_secret }})"
1179
- }
1180
- },
1181
- "required": [
1182
- "keyName"
1183
- ]
1184
- },
1185
- "WebhookConfig": {
1186
- "type": "object",
1187
- "properties": {
1188
- "id": {
1189
- "type": "string",
1190
- "readOnly": true
1191
- },
1192
- "name": {
1193
- "type": "string"
1194
- },
1195
- "eventName": {
1196
- "type": "string"
1197
- },
1198
- "url": {
1199
- "type": "string"
1200
- },
1201
- "creationTime": {
1202
- "type": "string",
1203
- "description": "creation timestamp",
1204
- "example": "2021-04-27T12:01:13.000Z"
1205
- },
1206
- "httpMethod": {
1207
- "$ref": "#/components/schemas/HttpMethod"
1208
- },
1209
- "enabled": {
1210
- "type": "boolean"
1211
- },
1212
- "auth": {
1213
- "$ref": "#/components/schemas/Auth"
1214
- },
1215
- "filter": {
1216
- "$ref": "#/components/schemas/Filter"
1217
- },
1218
- "payloadConfiguration": {
1219
- "$ref": "#/components/schemas/PayloadConfiguration"
1220
- },
1221
- "enableStaticIP": {
1222
- "type": "boolean"
1223
- },
1224
- "protected": {
1225
- "type": "boolean",
1226
- "description": "When true, indicates this webhook configuration is protected and should not be modified without explicit intent."
1227
- },
1228
- "secureProxy": {
1229
- "type": "object",
1230
- "description": "Routes webhook requests through a secure VPC proxy (ERP integration service). When set, takes precedence over enableStaticIP.",
1231
- "properties": {
1232
- "integration_id": {
1233
- "type": "string",
1234
- "format": "uuid"
1235
- },
1236
- "use_case_slug": {
1237
- "type": "string"
1238
- }
1239
- },
1240
- "required": [
1241
- "integration_id",
1242
- "use_case_slug"
1243
- ]
1244
- },
1245
- "status": {
1246
- "type": "string",
1247
- "enum": [
1248
- "active",
1249
- "inactive",
1250
- "incomplete"
1251
- ]
1252
- },
1253
- "jsonataExpression": {
1254
- "type": "string",
1255
- "description": "JSONata expression to transform the payload"
1256
- },
1257
- "filterConditions": {
1258
- "$ref": "#/components/schemas/WebhookConditionGroup"
1259
- },
1260
- "_manifest": {
1261
- "type": "array",
1262
- "description": "Manifest ID used to create/update the webhook resource",
1263
- "items": {
1264
- "type": "string",
1265
- "format": "uuid",
1266
- "example": "123e4567-e89b-12d3-a456-426614174000"
1267
- }
1268
- },
1269
- "signingSecret": {
1270
- "type": "string",
1271
- "readOnly": true,
1272
- "description": "Per-webhook signing secret following the Standard Webhooks specification.\nOnly returned once during webhook creation. Use this secret to verify\nwebhook signatures using the `webhook-id`, `webhook-timestamp`, and\n`webhook-signature` headers.\n",
1273
- "example": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
1274
- }
1275
- },
1276
- "required": [
1277
- "name",
1278
- "eventName"
1279
- ],
1280
- "example": {
1281
- "eventName": "CustomerRequest_Created",
1282
- "url": "https://my-partner-service.api.com",
1283
- "httpMethod": "POST",
1284
- "enabled": true,
1285
- "auth": {
1286
- "authType": "BASIC",
1287
- "basicAuthConfig": {
1288
- "username": "secretUsername",
1289
- "password": "secret7825@!"
1290
- }
1291
- },
1292
- "filter": {
1293
- "keyToFilter": "customer_request.productId",
1294
- "supportedValues": [
1295
- "2324245",
1296
- "5253642"
1297
- ]
1298
- }
1299
- }
1300
- },
1301
- "EventConfigResp": {
1302
- "type": "array",
1303
- "items": {
1304
- "$ref": "#/components/schemas/EventConfigEntry"
1305
- },
1306
- "example": [
1307
- {
1308
- "eventName": "customer_request_created",
1309
- "eventLabel": "Customer Request Created"
1310
- }
1311
- ]
1312
- },
1313
- "EventConfigEntry": {
1314
- "type": "object",
1315
- "properties": {
1316
- "eventName": {
1317
- "type": "string",
1318
- "description": "Name for identifying the event. Unique."
1319
- },
1320
- "eventLabel": {
1321
- "type": "string",
1322
- "description": "Either a user friendly label, or the eventName itself."
1323
- }
1324
- }
1325
- },
1326
- "ErrorResp": {
1327
- "type": "object",
1328
- "properties": {
1329
- "message": {
1330
- "type": "string"
1331
- }
1332
- }
1333
- },
1334
- "TriggerWebhookResp": {
1335
- "type": "object",
1336
- "required": [
1337
- "event_id"
1338
- ],
1339
- "properties": {
1340
- "status_code": {
1341
- "type": "string"
1342
- },
1343
- "message": {
1344
- "type": "string"
1345
- },
1346
- "body": {
1347
- "type": "object"
1348
- },
1349
- "code": {
1350
- "type": "string"
1351
- },
1352
- "status": {
1353
- "type": "string",
1354
- "enum": [
1355
- "succeeded",
1356
- "failed"
1357
- ]
1358
- },
1359
- "start_date": {
1360
- "type": "string"
1361
- },
1362
- "end_date": {
1363
- "type": "string"
1364
- },
1365
- "event_id": {
1366
- "type": "string"
1367
- }
1368
- }
1369
- },
1370
- "PayloadConfiguration": {
1371
- "type": "object",
1372
- "description": "Configuration for the webhook payload",
1373
- "properties": {
1374
- "hydrate_entity": {
1375
- "type": "boolean"
1376
- },
1377
- "include_relations": {
1378
- "type": "boolean"
1379
- },
1380
- "include_activity": {
1381
- "type": "boolean"
1382
- },
1383
- "include_changed_attributes": {
1384
- "type": "boolean"
1385
- },
1386
- "custom_headers": {
1387
- "$ref": "#/components/schemas/CustomHeader"
1388
- }
1389
- }
1390
- },
1391
- "CustomHeader": {
1392
- "type": "object",
1393
- "description": "Object representing custom headers as key-value pairs.",
1394
- "additionalProperties": {
1395
- "type": "string",
1396
- "description": "Header value"
1397
- }
1398
- },
1399
- "CustomOAuthParameter": {
1400
- "type": "object",
1401
- "description": "Custom key/value pair of either type body, query or header",
1402
- "properties": {
1403
- "type": {
1404
- "type": "string",
1405
- "enum": [
1406
- "body",
1407
- "query",
1408
- "header"
1409
- ]
1410
- },
1411
- "key": {
1412
- "type": "string"
1413
- },
1414
- "value": {
1415
- "type": "string"
1416
- }
1417
- },
1418
- "required": [
1419
- "type",
1420
- "key",
1421
- "value"
1422
- ]
1423
- },
1424
- "Metadata": {
1425
- "type": "object",
1426
- "description": "Contains the metadata about the configured event",
1427
- "properties": {
1428
- "action": {
1429
- "type": "string",
1430
- "description": "Action that triggered the event",
1431
- "example": "Manual triggered by user with id 123456"
1432
- },
1433
- "origin": {
1434
- "type": "string",
1435
- "description": "Origin of the event"
1436
- },
1437
- "creation_timestamp": {
1438
- "type": "string",
1439
- "description": "Time of event creation"
1440
- },
1441
- "webhook_id": {
1442
- "type": "string",
1443
- "description": "The ID of the webhook configuration"
1444
- },
1445
- "webhook_name": {
1446
- "type": "string",
1447
- "description": "The name of the webhook configuration"
1448
- },
1449
- "automation_name": {
1450
- "type": "string",
1451
- "description": "The name of the automation that triggered the event"
1452
- },
1453
- "organization_id": {
1454
- "type": "string",
1455
- "description": "The ID of the given organization"
1456
- },
1457
- "user_id": {
1458
- "type": "string",
1459
- "description": "The ID of the user for manual triggered events"
1460
- },
1461
- "correlation_id": {
1462
- "type": "string",
1463
- "description": "ID used to track the event"
1464
- },
1465
- "execution_id": {
1466
- "type": "string",
1467
- "description": "When triggered by an automation this is its execution id"
1468
- },
1469
- "action_id": {
1470
- "type": "string",
1471
- "description": "When triggered by an automation this is the id of the action"
1472
- }
1473
- },
1474
- "required": [
1475
- "organization_id"
1476
- ]
1477
- },
1478
- "ExecutionPayload": {
1479
- "type": "object",
1480
- "description": "Payload for triggering a webhook",
1481
- "additionalProperties": true,
1482
- "properties": {
1483
- "metadata": {
1484
- "$ref": "#/components/schemas/Metadata"
1485
- }
1486
- },
1487
- "required": [
1488
- "metadata"
1489
- ]
1490
- },
1491
- "WebhookEvent": {
1492
- "type": "object",
1493
- "properties": {
1494
- "event_id": {
1495
- "type": "string"
1496
- },
1497
- "org_id": {
1498
- "type": "string"
1499
- },
1500
- "webhook_config_id": {
1501
- "type": "string"
1502
- },
1503
- "url": {
1504
- "type": "string"
1505
- },
1506
- "created_at": {
1507
- "type": "string",
1508
- "example": "2021-04-27T12:01:13.000Z"
1509
- },
1510
- "event_name": {
1511
- "type": "string"
1512
- },
1513
- "http_response": {
1514
- "type": "object",
1515
- "properties": {
1516
- "status_code": {
1517
- "type": "integer"
1518
- },
1519
- "message": {
1520
- "type": "string"
1521
- },
1522
- "body": {
1523
- "type": "object"
1524
- },
1525
- "code": {
1526
- "type": "string"
1527
- }
1528
- }
1529
- },
1530
- "metadata": {
1531
- "$ref": "#/components/schemas/Metadata"
1532
- },
1533
- "status": {
1534
- "type": "string",
1535
- "enum": [
1536
- "succeeded",
1537
- "failed",
1538
- "in_progress",
1539
- "skipped"
1540
- ]
1541
- },
1542
- "http_method": {
1543
- "type": "string",
1544
- "enum": [
1545
- "GET",
1546
- "POST",
1547
- "PUT"
1548
- ]
1549
- },
1550
- "payload": {
1551
- "type": "string",
1552
- "description": "stringified payload of the webhook request"
1553
- }
1554
- },
1555
- "required": [
1556
- "event_id",
1557
- "webhook_config_id",
1558
- "org_id"
1559
- ]
1560
- },
1561
- "ExampleRequest": {
1562
- "type": "object",
1563
- "properties": {
1564
- "automation_id": {
1565
- "type": "string",
1566
- "description": "ID of the automation, if applicable",
1567
- "example": "automation_123"
1568
- }
1569
- }
1570
- },
1571
- "ExampleResponse": {
1572
- "type": "object",
1573
- "properties": {
1574
- "metadata": {
1575
- "$ref": "#/components/schemas/Metadata"
1576
- },
1577
- "entity": {
1578
- "type": "object",
1579
- "description": "Example payload for the webhook event",
1580
- "additionalProperties": true
1581
- },
1582
- "relations": {
1583
- "type": "array",
1584
- "description": "Example relations for the webhook event",
1585
- "items": {
1586
- "type": "object",
1587
- "additionalProperties": true
1588
- }
1589
- }
1590
- },
1591
- "additionalProperties": true
1592
- },
1593
- "BatchReplayRequest": {
1594
- "type": "object",
1595
- "properties": {
1596
- "eventIds": {
1597
- "type": "array",
1598
- "items": {
1599
- "type": "string"
1600
- },
1601
- "description": "List of event IDs to replay",
1602
- "minItems": 1,
1603
- "maxItems": 100,
1604
- "example": [
1605
- "2f1b7cf8-ff55-4359-966f-e56f39a52c94",
1606
- "48c984bf-466b-470b-b743-d07cea168243"
1607
- ]
1608
- }
1609
- },
1610
- "required": [
1611
- "eventIds"
1612
- ]
1613
- }
1614
- },
1615
- "securitySchemes": {
1616
- "EpilotAuth": {
1617
- "type": "http",
1618
- "scheme": "bearer",
1619
- "description": "Authorization header with epilot OAuth2 bearer token",
1620
- "bearerFormat": "JWT"
1621
- }
1622
- }
1623
- },
1624
- "security": [
1625
- {
1626
- "EpilotAuth": []
1627
- }
1628
- ],
1629
- "servers": [
1630
- {
1631
- "url": "https://webhooks.sls.epilot.io"
1632
- }
1633
- ]
1634
- }