-
Notifications
You must be signed in to change notification settings - Fork 126
/
openapi3.yaml
4962 lines (4962 loc) · 144 KB
/
openapi3.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
schemas:
datastore.AlertConfiguration:
properties:
count:
type: integer
threshold:
type: string
type: object
datastore.AmqpCredentials:
properties:
password:
type: string
user:
type: string
type: object
datastore.AmqpPubSubConfig:
properties:
auth:
$ref: '#/components/schemas/datastore.AmqpCredentials'
bindedExchange:
type: string
deadLetterExchange:
type: string
host:
type: string
port:
type: string
queue:
type: string
routingKey:
type: string
schema:
type: string
vhost:
type: string
type: object
datastore.ApiKey:
properties:
header_name:
type: string
header_value:
type: string
type: object
datastore.BasicAuth:
properties:
password:
type: string
username:
type: string
type: object
datastore.CLIMetadata:
properties:
event_type:
type: string
source_id:
type: string
type: object
datastore.CustomResponse:
properties:
body:
type: string
content_type:
type: string
type: object
datastore.DeliveryAttempt:
properties:
api_version:
type: string
created_at:
type: string
deleted_at:
type: string
endpoint_id:
type: string
error:
type: string
http_status:
type: string
ip_address:
type: string
method:
type: string
msg_id:
type: string
request_http_header:
$ref: '#/components/schemas/datastore.HttpHeader'
response_data:
type: string
response_http_header:
$ref: '#/components/schemas/datastore.HttpHeader'
status:
type: boolean
uid:
type: string
updated_at:
type: string
url:
type: string
type: object
datastore.Device:
properties:
created_at:
type: string
deleted_at:
type: string
endpoint_id:
type: string
host_name:
type: string
last_seen_at:
type: string
project_id:
type: string
status:
$ref: '#/components/schemas/datastore.DeviceStatus'
uid:
type: string
updated_at:
type: string
type: object
datastore.DeviceStatus:
enum:
- offline
- online
- disabled
type: string
x-enum-varnames:
- DeviceStatusOffline
- DeviceStatusOnline
- DeviceStatusDisabled
datastore.EncodingType:
enum:
- base64
- hex
type: string
x-enum-varnames:
- Base64Encoding
- HexEncoding
datastore.Endpoint:
properties:
advanced_signatures:
type: boolean
authentication:
$ref: '#/components/schemas/datastore.EndpointAuthentication'
created_at:
type: string
deleted_at:
type: string
description:
type: string
events:
type: integer
http_timeout:
type: integer
name:
type: string
owner_id:
type: string
project_id:
type: string
rate_limit:
type: integer
rate_limit_duration:
type: integer
secrets:
items:
$ref: '#/components/schemas/datastore.Secret'
type: array
slack_webhook_url:
type: string
status:
$ref: '#/components/schemas/datastore.EndpointStatus'
support_email:
type: string
uid:
type: string
updated_at:
type: string
url:
type: string
type: object
datastore.EndpointAuthentication:
properties:
api_key:
$ref: '#/components/schemas/datastore.ApiKey'
type:
$ref: '#/components/schemas/datastore.EndpointAuthenticationType'
type: object
datastore.EndpointAuthenticationType:
enum:
- api_key
type: string
x-enum-varnames:
- APIKeyAuthentication
datastore.EndpointStatus:
enum:
- active
- inactive
- pending
- paused
type: string
x-enum-varnames:
- ActiveEndpointStatus
- InactiveEndpointStatus
- PendingEndpointStatus
- PausedEndpointStatus
datastore.Event:
properties:
acknowledged_at:
type: string
app_id:
description: Deprecated
type: string
created_at:
type: string
data:
description: |-
Data is an arbitrary JSON value that gets sent as the body of the
webhook to the endpoints
items:
type: integer
type: array
deleted_at:
type: string
endpoint_metadata:
items:
$ref: '#/components/schemas/datastore.Endpoint'
type: array
endpoints:
items:
type: string
type: array
event_type:
type: string
headers:
$ref: '#/components/schemas/httpheader.HTTPHeader'
idempotency_key:
type: string
is_duplicate_event:
type: boolean
project_id:
type: string
raw:
type: string
source_id:
type: string
source_metadata:
$ref: '#/components/schemas/datastore.Source'
uid:
type: string
updated_at:
type: string
url_query_params:
type: string
type: object
datastore.EventDeliveryStatus:
enum:
- Scheduled
- Processing
- Discarded
- Failure
- Success
- Retry
type: string
x-enum-varnames:
- ScheduledEventStatus
- ProcessingEventStatus
- DiscardedEventStatus
- FailureEventStatus
- SuccessEventStatus
- RetryEventStatus
datastore.FilterConfiguration:
properties:
event_types:
items:
type: string
type: array
filter:
$ref: '#/components/schemas/datastore.FilterSchema'
type: object
datastore.FilterSchema:
properties:
body:
$ref: '#/components/schemas/datastore.M'
headers:
$ref: '#/components/schemas/datastore.M'
is_flattened:
type: boolean
type: object
datastore.GooglePubSubConfig:
properties:
project_id:
type: string
service_account:
items:
type: integer
type: array
subscription_id:
type: string
type: object
datastore.HMac:
properties:
encoding:
$ref: '#/components/schemas/datastore.EncodingType'
hash:
type: string
header:
type: string
secret:
type: string
type: object
datastore.HttpHeader:
additionalProperties:
type: string
type: object
datastore.KafkaAuth:
properties:
hash:
type: string
password:
type: string
tls:
type: boolean
type:
type: string
username:
type: string
type: object
datastore.KafkaPubSubConfig:
properties:
auth:
$ref: '#/components/schemas/datastore.KafkaAuth'
brokers:
items:
type: string
type: array
consumer_group_id:
type: string
topic_name:
type: string
type: object
datastore.M:
additionalProperties: true
type: object
datastore.MetaEventAttempt:
properties:
request_http_header:
$ref: '#/components/schemas/datastore.HttpHeader'
response_data:
type: string
response_http_header:
$ref: '#/components/schemas/datastore.HttpHeader'
type: object
datastore.Metadata:
properties:
data:
description: Data to be sent to endpoint.
items:
type: integer
type: array
interval_seconds:
type: integer
max_retry_seconds:
type: integer
next_send_time:
type: string
num_trials:
description: |-
NumTrials: number of times we have tried to deliver this Event to
an application
type: integer
raw:
type: string
retry_limit:
type: integer
strategy:
$ref: '#/components/schemas/datastore.StrategyProvider'
type: object
datastore.PageDirection:
enum:
- next
- prev
type: string
x-enum-varnames:
- Next
- Prev
datastore.PaginationData:
properties:
has_next_page:
type: boolean
has_prev_page:
type: boolean
next_page_cursor:
type: string
per_page:
type: integer
prev_page_cursor:
type: string
type: object
datastore.ProviderConfig:
properties:
twitter:
$ref: '#/components/schemas/datastore.TwitterProviderConfig'
type: object
datastore.PubSubConfig:
properties:
amqp:
$ref: '#/components/schemas/datastore.AmqpPubSubConfig'
google:
$ref: '#/components/schemas/datastore.GooglePubSubConfig'
kafka:
$ref: '#/components/schemas/datastore.KafkaPubSubConfig'
sqs:
$ref: '#/components/schemas/datastore.SQSPubSubConfig'
type:
$ref: '#/components/schemas/datastore.PubSubType'
workers:
type: integer
type: object
datastore.PubSubType:
enum:
- sqs
- google
- kafka
- amqp
type: string
x-enum-varnames:
- SqsPubSub
- GooglePubSub
- KafkaPubSub
- AmqpPubSub
datastore.RateLimitConfiguration:
properties:
count:
type: integer
duration:
type: integer
type: object
datastore.RetryConfiguration:
properties:
duration:
type: integer
retry_count:
type: integer
type:
$ref: '#/components/schemas/datastore.StrategyProvider'
type: object
datastore.SQSPubSubConfig:
properties:
access_key_id:
type: string
default_region:
type: string
queue_name:
type: string
secret_key:
type: string
type: object
datastore.Secret:
properties:
created_at:
type: string
deleted_at:
type: string
expires_at:
type: string
uid:
type: string
updated_at:
type: string
value:
type: string
type: object
datastore.Source:
properties:
body_function:
type: string
created_at:
type: string
custom_response:
$ref: '#/components/schemas/datastore.CustomResponse'
deleted_at:
type: string
forward_headers:
items:
type: string
type: array
header_function:
type: string
idempotency_keys:
items:
type: string
type: array
is_disabled:
type: boolean
mask_id:
type: string
name:
type: string
project_id:
type: string
provider:
$ref: '#/components/schemas/datastore.SourceProvider'
provider_config:
$ref: '#/components/schemas/datastore.ProviderConfig'
pub_sub:
$ref: '#/components/schemas/datastore.PubSubConfig'
type:
$ref: '#/components/schemas/datastore.SourceType'
uid:
type: string
updated_at:
type: string
url:
type: string
verifier:
$ref: '#/components/schemas/datastore.VerifierConfig'
type: object
datastore.SourceProvider:
enum:
- github
- twitter
- shopify
type: string
x-enum-varnames:
- GithubSourceProvider
- TwitterSourceProvider
- ShopifySourceProvider
datastore.SourceType:
enum:
- http
- rest_api
- pub_sub
- db_change_stream
type: string
x-enum-varnames:
- HTTPSource
- RestApiSource
- PubSubSource
- DBChangeStream
datastore.StrategyProvider:
enum:
- linear
- exponential
type: string
x-enum-varnames:
- LinearStrategyProvider
- ExponentialStrategyProvider
datastore.SubscriptionType:
enum:
- cli
- api
type: string
x-enum-varnames:
- SubscriptionTypeCLI
- SubscriptionTypeAPI
datastore.TwitterProviderConfig:
properties:
crc_verified_at:
type: string
type: object
datastore.VerifierConfig:
properties:
api_key:
$ref: '#/components/schemas/datastore.ApiKey'
basic_auth:
$ref: '#/components/schemas/datastore.BasicAuth'
hmac:
$ref: '#/components/schemas/datastore.HMac'
type:
$ref: '#/components/schemas/datastore.VerifierType'
type: object
datastore.VerifierType:
enum:
- noop
- hmac
- basic_auth
- api_key
type: string
x-enum-varnames:
- NoopVerifier
- HMacVerifier
- BasicAuthVerifier
- APIKeyVerifier
handlers.Stub:
type: object
httpheader.HTTPHeader:
additionalProperties:
items:
type: string
type: array
type: object
models.AlertConfiguration:
properties:
count:
description: Count
type: integer
threshold:
description: Threshold
type: string
type: object
models.AmqpAuth:
properties:
password:
type: string
user:
type: string
type: object
models.AmqpExchange:
properties:
exchange:
type: string
routingKey:
type: string
type: object
models.AmqpPubSubconfig:
properties:
auth:
$ref: '#/components/schemas/models.AmqpAuth'
bindExchange:
$ref: '#/components/schemas/models.AmqpExchange'
deadLetterExchange:
type: string
host:
type: string
port:
type: string
queue:
type: string
schema:
type: string
vhost:
type: string
type: object
models.ApiKey:
properties:
header_name:
type: string
header_value:
type: string
type: object
models.BasicAuth:
properties:
password:
type: string
username:
type: string
type: object
models.BroadcastEvent:
properties:
acknowledged_at:
type: string
custom_headers:
additionalProperties:
type: string
description: Specifies custom headers you want convoy to add when the event
is dispatched to your endpoint
type: object
data:
description: |-
Data is an arbitrary JSON value that gets sent as the body of the
webhook to the endpoints
type: object
event_type:
description: Event Type is used for filtering and debugging e.g invoice.paid
type: string
idempotency_key:
description: Specify a key for event deduplication
type: string
type: object
models.CreateEndpoint:
properties:
advanced_signatures:
description: |-
Convoy supports two [signature formats](https://getconvoy.io/docs/manual/signatures)
-- simple or advanced. If left unspecified, we default to false.
type: boolean
appID:
description: Deprecated but necessary for backward compatibility
type: string
authentication:
allOf:
- $ref: '#/components/schemas/models.EndpointAuthentication'
description: |-
This is used to define any custom authentication required by the endpoint. This
shouldn't be needed often because webhook endpoints usually should be exposed to
the internet.
description:
description: |-
Human-readable description of the endpoint. Think of this as metadata describing
the endpoint
type: string
http_timeout:
description: Define endpoint http timeout in seconds.
type: integer
is_disabled:
description: This is used to manually enable/disable the endpoint.
type: boolean
name:
description: Endpoint name.
type: string
owner_id:
description: |-
The OwnerID is used to group more than one endpoint together to achieve
[fanout](https://getconvoy.io/docs/manual/endpoints#Endpoint%20Owner%20ID)
type: string
rate_limit:
description: |-
Rate limit is the total number of requests to be sent to an endpoint in
the time duration specified in RateLimitDuration
type: integer
rate_limit_duration:
description: Rate limit duration specifies the time range for the rate limit.
type: integer
secret:
description: Endpoint's webhook secret. If not provided, Convoy autogenerates
one for the endpoint.
type: string
slack_webhook_url:
description: |-
Slack webhook URL is an alternative method to support email where endpoint developers
can receive failure notifications on a slack channel.
type: string
support_email:
description: |-
Endpoint developers support email. This is used for communicating endpoint state
changes. You should always turn this on when disabling endpoints are enabled.
type: string
url:
description: |-
URL is the endpoint's URL prefixed with https. non-https urls are currently
not supported.
type: string
type: object
models.CreateEvent:
properties:
app_id:
description: Deprecated but necessary for backward compatibility.
type: string
custom_headers:
additionalProperties:
type: string
description: Specifies custom headers you want convoy to add when the event
is dispatched to your endpoint
type: object
data:
description: |-
Data is an arbitrary JSON value that gets sent as the body of the
webhook to the endpoints
type: object
endpoint_id:
description: Specifies the endpoint to send this event to.
type: string
event_type:
description: Event Type is used for filtering and debugging e.g invoice.paid
type: string
idempotency_key:
description: Specify a key for event deduplication
type: string
type: object
models.CreateSource:
properties:
body_function:
description: |-
Function is a javascript function used to mutate the payload
immediately after ingesting an event
type: string
custom_response:
allOf:
- $ref: '#/components/schemas/models.CustomResponse'
description: |-
Custom response is used to define a custom response for incoming
webhooks project sources only.
header_function:
description: |-
Function is a javascript function used to mutate the headers
immediately after ingesting an event
type: string
idempotency_keys:
description: |-
IdempotencyKeys are used to specify parts of a webhook request to uniquely
identify the event in an incoming webhooks project.
items:
type: string
type: array
name:
description: Source name.
type: string
provider:
allOf:
- $ref: '#/components/schemas/datastore.SourceProvider'
description: Use this to specify one of our predefined source types.
pub_sub:
allOf:
- $ref: '#/components/schemas/models.PubSubConfig'
description: |-
PubSub are used to specify message broker sources for outgoing
webhooks projects.
type:
allOf:
- $ref: '#/components/schemas/datastore.SourceType'
description: Source Type.
verifier:
allOf:
- $ref: '#/components/schemas/models.VerifierConfig'
description: |-
Verifiers are used to verify webhook events ingested in incoming
webhooks projects.
type: object
models.CreateSubscription:
properties:
alert_config:
allOf:
- $ref: '#/components/schemas/models.AlertConfiguration'
description: Alert configuration
app_id:
description: Deprecated but necessary for backward compatibility
type: string
endpoint_id:
description: Destination endpoint ID
type: string
filter_config:
allOf:
- $ref: '#/components/schemas/models.FilterConfiguration'
description: Filter configuration
function:
description: |-
Convoy supports mutating your request payload using a js function. Use this field
to specify a `transform` function for this purpose. See this[https://docs.getconvoy.io/product-manual/subscriptions#functions] for more
type: string
name:
description: Subscription Nme
type: string
rate_limit_config:
allOf:
- $ref: '#/components/schemas/models.RateLimitConfiguration'
description: Rate limit configuration
retry_config:
allOf:
- $ref: '#/components/schemas/models.RetryConfiguration'
description: Retry configuration
source_id:
description: Source Id
type: string
type: object
models.CustomResponse:
properties:
body:
type: string
content_type:
type: string
type: object
models.DynamicEvent:
properties:
acknowledged_at:
type: string
custom_headers:
additionalProperties:
type: string
description: Specifies custom headers you want convoy to add when the event
is dispatched to your endpoint
type: object
data:
description: |-
Data is an arbitrary JSON value that gets sent as the body of the
webhook to the endpoints
type: object
event_type:
description: Event Type is used for filtering and debugging e.g invoice.paid
type: string
event_types:
description: A list of event types for the subscription filter config
items:
type: string
type: array
idempotency_key:
description: Specify a key for event deduplication
type: string
secret:
description: Endpoint's webhook secret. If not provided, Convoy autogenerates
one for the endpoint.
type: string
url:
description: |-
URL is the endpoint's URL prefixed with https. non-https urls are currently
not supported.
type: string
type: object
models.EndpointAuthentication:
properties:
api_key:
$ref: '#/components/schemas/models.ApiKey'
type:
$ref: '#/components/schemas/datastore.EndpointAuthenticationType'
type: object
models.EndpointResponse:
properties:
advanced_signatures:
type: boolean
authentication:
$ref: '#/components/schemas/datastore.EndpointAuthentication'
created_at:
type: string
deleted_at:
type: string
description:
type: string
events:
type: integer
http_timeout:
type: integer
name:
type: string
owner_id:
type: string
project_id:
type: string
rate_limit:
type: integer
rate_limit_duration:
type: integer
secrets:
items:
$ref: '#/components/schemas/datastore.Secret'
type: array
slack_webhook_url:
type: string
status:
$ref: '#/components/schemas/datastore.EndpointStatus'
support_email:
type: string
uid:
type: string
updated_at:
type: string
url:
type: string
type: object
models.EventDeliveryResponse:
properties:
acknowledged_at:
type: string
cli_metadata:
$ref: '#/components/schemas/datastore.CLIMetadata'
created_at:
type: string
deleted_at:
type: string
description:
type: string
device_id:
type: string
device_metadata:
$ref: '#/components/schemas/datastore.Device'
endpoint_id:
type: string
endpoint_metadata:
$ref: '#/components/schemas/datastore.Endpoint'
event_id:
type: string
event_metadata:
$ref: '#/components/schemas/datastore.Event'
event_type:
type: string
headers:
$ref: '#/components/schemas/httpheader.HTTPHeader'
idempotency_key:
type: string
latency:
description: 'Deprecated: Latency is deprecated.'
type: string
latency_seconds:
type: number
metadata:
$ref: '#/components/schemas/datastore.Metadata'
project_id:
type: string
source_metadata:
$ref: '#/components/schemas/datastore.Source'
status:
$ref: '#/components/schemas/datastore.EventDeliveryStatus'
subscription_id:
type: string
uid:
type: string
updated_at:
type: string
url_query_params:
type: string
type: object
models.EventResponse:
properties:
acknowledged_at:
type: string
app_id:
description: Deprecated
type: string
created_at:
type: string