cli/resources/webhooks/index.md +0 −963 deleted
File Deleted View Diff
1# Webhooks
2
3## Domain Types
4
5### Batch Cancelled Webhook Event
6
7- `batch_cancelled_webhook_event: object { id, created_at, data, 2 more }`
8
9 Sent when a batch API request has been cancelled.
10
11 - `id: string`
12
13 The unique ID of the event.
14
15 - `created_at: number`
16
17 The Unix timestamp (in seconds) of when the batch API request was cancelled.
18
19 - `data: object { id }`
20
21 Event data payload.
22
23 - `id: string`
24
25 The unique ID of the batch API request.
26
27 - `type: "batch.cancelled"`
28
29 The type of the event. Always `batch.cancelled`.
30
31 - `object: optional "event"`
32
33 The object of the event. Always `event`.
34
35 - `"event"`
36
37### Batch Completed Webhook Event
38
39- `batch_completed_webhook_event: object { id, created_at, data, 2 more }`
40
41 Sent when a batch API request has been completed.
42
43 - `id: string`
44
45 The unique ID of the event.
46
47 - `created_at: number`
48
49 The Unix timestamp (in seconds) of when the batch API request was completed.
50
51 - `data: object { id }`
52
53 Event data payload.
54
55 - `id: string`
56
57 The unique ID of the batch API request.
58
59 - `type: "batch.completed"`
60
61 The type of the event. Always `batch.completed`.
62
63 - `object: optional "event"`
64
65 The object of the event. Always `event`.
66
67 - `"event"`
68
69### Batch Expired Webhook Event
70
71- `batch_expired_webhook_event: object { id, created_at, data, 2 more }`
72
73 Sent when a batch API request has expired.
74
75 - `id: string`
76
77 The unique ID of the event.
78
79 - `created_at: number`
80
81 The Unix timestamp (in seconds) of when the batch API request expired.
82
83 - `data: object { id }`
84
85 Event data payload.
86
87 - `id: string`
88
89 The unique ID of the batch API request.
90
91 - `type: "batch.expired"`
92
93 The type of the event. Always `batch.expired`.
94
95 - `object: optional "event"`
96
97 The object of the event. Always `event`.
98
99 - `"event"`
100
101### Batch Failed Webhook Event
102
103- `batch_failed_webhook_event: object { id, created_at, data, 2 more }`
104
105 Sent when a batch API request has failed.
106
107 - `id: string`
108
109 The unique ID of the event.
110
111 - `created_at: number`
112
113 The Unix timestamp (in seconds) of when the batch API request failed.
114
115 - `data: object { id }`
116
117 Event data payload.
118
119 - `id: string`
120
121 The unique ID of the batch API request.
122
123 - `type: "batch.failed"`
124
125 The type of the event. Always `batch.failed`.
126
127 - `object: optional "event"`
128
129 The object of the event. Always `event`.
130
131 - `"event"`
132
133### Eval Run Canceled Webhook Event
134
135- `eval_run_canceled_webhook_event: object { id, created_at, data, 2 more }`
136
137 Sent when an eval run has been canceled.
138
139 - `id: string`
140
141 The unique ID of the event.
142
143 - `created_at: number`
144
145 The Unix timestamp (in seconds) of when the eval run was canceled.
146
147 - `data: object { id }`
148
149 Event data payload.
150
151 - `id: string`
152
153 The unique ID of the eval run.
154
155 - `type: "eval.run.canceled"`
156
157 The type of the event. Always `eval.run.canceled`.
158
159 - `object: optional "event"`
160
161 The object of the event. Always `event`.
162
163 - `"event"`
164
165### Eval Run Failed Webhook Event
166
167- `eval_run_failed_webhook_event: object { id, created_at, data, 2 more }`
168
169 Sent when an eval run has failed.
170
171 - `id: string`
172
173 The unique ID of the event.
174
175 - `created_at: number`
176
177 The Unix timestamp (in seconds) of when the eval run failed.
178
179 - `data: object { id }`
180
181 Event data payload.
182
183 - `id: string`
184
185 The unique ID of the eval run.
186
187 - `type: "eval.run.failed"`
188
189 The type of the event. Always `eval.run.failed`.
190
191 - `object: optional "event"`
192
193 The object of the event. Always `event`.
194
195 - `"event"`
196
197### Eval Run Succeeded Webhook Event
198
199- `eval_run_succeeded_webhook_event: object { id, created_at, data, 2 more }`
200
201 Sent when an eval run has succeeded.
202
203 - `id: string`
204
205 The unique ID of the event.
206
207 - `created_at: number`
208
209 The Unix timestamp (in seconds) of when the eval run succeeded.
210
211 - `data: object { id }`
212
213 Event data payload.
214
215 - `id: string`
216
217 The unique ID of the eval run.
218
219 - `type: "eval.run.succeeded"`
220
221 The type of the event. Always `eval.run.succeeded`.
222
223 - `object: optional "event"`
224
225 The object of the event. Always `event`.
226
227 - `"event"`
228
229### Fine Tuning Job Cancelled Webhook Event
230
231- `fine_tuning_job_cancelled_webhook_event: object { id, created_at, data, 2 more }`
232
233 Sent when a fine-tuning job has been cancelled.
234
235 - `id: string`
236
237 The unique ID of the event.
238
239 - `created_at: number`
240
241 The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
242
243 - `data: object { id }`
244
245 Event data payload.
246
247 - `id: string`
248
249 The unique ID of the fine-tuning job.
250
251 - `type: "fine_tuning.job.cancelled"`
252
253 The type of the event. Always `fine_tuning.job.cancelled`.
254
255 - `object: optional "event"`
256
257 The object of the event. Always `event`.
258
259 - `"event"`
260
261### Fine Tuning Job Failed Webhook Event
262
263- `fine_tuning_job_failed_webhook_event: object { id, created_at, data, 2 more }`
264
265 Sent when a fine-tuning job has failed.
266
267 - `id: string`
268
269 The unique ID of the event.
270
271 - `created_at: number`
272
273 The Unix timestamp (in seconds) of when the fine-tuning job failed.
274
275 - `data: object { id }`
276
277 Event data payload.
278
279 - `id: string`
280
281 The unique ID of the fine-tuning job.
282
283 - `type: "fine_tuning.job.failed"`
284
285 The type of the event. Always `fine_tuning.job.failed`.
286
287 - `object: optional "event"`
288
289 The object of the event. Always `event`.
290
291 - `"event"`
292
293### Fine Tuning Job Succeeded Webhook Event
294
295- `fine_tuning_job_succeeded_webhook_event: object { id, created_at, data, 2 more }`
296
297 Sent when a fine-tuning job has succeeded.
298
299 - `id: string`
300
301 The unique ID of the event.
302
303 - `created_at: number`
304
305 The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
306
307 - `data: object { id }`
308
309 Event data payload.
310
311 - `id: string`
312
313 The unique ID of the fine-tuning job.
314
315 - `type: "fine_tuning.job.succeeded"`
316
317 The type of the event. Always `fine_tuning.job.succeeded`.
318
319 - `object: optional "event"`
320
321 The object of the event. Always `event`.
322
323 - `"event"`
324
325### Realtime Call Incoming Webhook Event
326
327- `realtime_call_incoming_webhook_event: object { id, created_at, data, 2 more }`
328
329 Sent when Realtime API Receives a incoming SIP call.
330
331 - `id: string`
332
333 The unique ID of the event.
334
335 - `created_at: number`
336
337 The Unix timestamp (in seconds) of when the model response was completed.
338
339 - `data: object { call_id, sip_headers }`
340
341 Event data payload.
342
343 - `call_id: string`
344
345 The unique ID of this call.
346
347 - `sip_headers: array of object { name, value }`
348
349 Headers from the SIP Invite.
350
351 - `name: string`
352
353 Name of the SIP Header.
354
355 - `value: string`
356
357 Value of the SIP Header.
358
359 - `type: "realtime.call.incoming"`
360
361 The type of the event. Always `realtime.call.incoming`.
362
363 - `object: optional "event"`
364
365 The object of the event. Always `event`.
366
367 - `"event"`
368
369### Response Cancelled Webhook Event
370
371- `response_cancelled_webhook_event: object { id, created_at, data, 2 more }`
372
373 Sent when a background response has been cancelled.
374
375 - `id: string`
376
377 The unique ID of the event.
378
379 - `created_at: number`
380
381 The Unix timestamp (in seconds) of when the model response was cancelled.
382
383 - `data: object { id }`
384
385 Event data payload.
386
387 - `id: string`
388
389 The unique ID of the model response.
390
391 - `type: "response.cancelled"`
392
393 The type of the event. Always `response.cancelled`.
394
395 - `object: optional "event"`
396
397 The object of the event. Always `event`.
398
399 - `"event"`
400
401### Response Completed Webhook Event
402
403- `response_completed_webhook_event: object { id, created_at, data, 2 more }`
404
405 Sent when a background response has been completed.
406
407 - `id: string`
408
409 The unique ID of the event.
410
411 - `created_at: number`
412
413 The Unix timestamp (in seconds) of when the model response was completed.
414
415 - `data: object { id }`
416
417 Event data payload.
418
419 - `id: string`
420
421 The unique ID of the model response.
422
423 - `type: "response.completed"`
424
425 The type of the event. Always `response.completed`.
426
427 - `object: optional "event"`
428
429 The object of the event. Always `event`.
430
431 - `"event"`
432
433### Response Failed Webhook Event
434
435- `response_failed_webhook_event: object { id, created_at, data, 2 more }`
436
437 Sent when a background response has failed.
438
439 - `id: string`
440
441 The unique ID of the event.
442
443 - `created_at: number`
444
445 The Unix timestamp (in seconds) of when the model response failed.
446
447 - `data: object { id }`
448
449 Event data payload.
450
451 - `id: string`
452
453 The unique ID of the model response.
454
455 - `type: "response.failed"`
456
457 The type of the event. Always `response.failed`.
458
459 - `object: optional "event"`
460
461 The object of the event. Always `event`.
462
463 - `"event"`
464
465### Response Incomplete Webhook Event
466
467- `response_incomplete_webhook_event: object { id, created_at, data, 2 more }`
468
469 Sent when a background response has been interrupted.
470
471 - `id: string`
472
473 The unique ID of the event.
474
475 - `created_at: number`
476
477 The Unix timestamp (in seconds) of when the model response was interrupted.
478
479 - `data: object { id }`
480
481 Event data payload.
482
483 - `id: string`
484
485 The unique ID of the model response.
486
487 - `type: "response.incomplete"`
488
489 The type of the event. Always `response.incomplete`.
490
491 - `object: optional "event"`
492
493 The object of the event. Always `event`.
494
495 - `"event"`
496
497### Unwrap Webhook Event
498
499- `unwrap_webhook_event: BatchCancelledWebhookEvent or BatchCompletedWebhookEvent or BatchExpiredWebhookEvent or 12 more`
500
501 Sent when a batch API request has been cancelled.
502
503 - `batch_cancelled_webhook_event: object { id, created_at, data, 2 more }`
504
505 Sent when a batch API request has been cancelled.
506
507 - `id: string`
508
509 The unique ID of the event.
510
511 - `created_at: number`
512
513 The Unix timestamp (in seconds) of when the batch API request was cancelled.
514
515 - `data: object { id }`
516
517 Event data payload.
518
519 - `id: string`
520
521 The unique ID of the batch API request.
522
523 - `type: "batch.cancelled"`
524
525 The type of the event. Always `batch.cancelled`.
526
527 - `object: optional "event"`
528
529 The object of the event. Always `event`.
530
531 - `"event"`
532
533 - `batch_completed_webhook_event: object { id, created_at, data, 2 more }`
534
535 Sent when a batch API request has been completed.
536
537 - `id: string`
538
539 The unique ID of the event.
540
541 - `created_at: number`
542
543 The Unix timestamp (in seconds) of when the batch API request was completed.
544
545 - `data: object { id }`
546
547 Event data payload.
548
549 - `id: string`
550
551 The unique ID of the batch API request.
552
553 - `type: "batch.completed"`
554
555 The type of the event. Always `batch.completed`.
556
557 - `object: optional "event"`
558
559 The object of the event. Always `event`.
560
561 - `"event"`
562
563 - `batch_expired_webhook_event: object { id, created_at, data, 2 more }`
564
565 Sent when a batch API request has expired.
566
567 - `id: string`
568
569 The unique ID of the event.
570
571 - `created_at: number`
572
573 The Unix timestamp (in seconds) of when the batch API request expired.
574
575 - `data: object { id }`
576
577 Event data payload.
578
579 - `id: string`
580
581 The unique ID of the batch API request.
582
583 - `type: "batch.expired"`
584
585 The type of the event. Always `batch.expired`.
586
587 - `object: optional "event"`
588
589 The object of the event. Always `event`.
590
591 - `"event"`
592
593 - `batch_failed_webhook_event: object { id, created_at, data, 2 more }`
594
595 Sent when a batch API request has failed.
596
597 - `id: string`
598
599 The unique ID of the event.
600
601 - `created_at: number`
602
603 The Unix timestamp (in seconds) of when the batch API request failed.
604
605 - `data: object { id }`
606
607 Event data payload.
608
609 - `id: string`
610
611 The unique ID of the batch API request.
612
613 - `type: "batch.failed"`
614
615 The type of the event. Always `batch.failed`.
616
617 - `object: optional "event"`
618
619 The object of the event. Always `event`.
620
621 - `"event"`
622
623 - `eval_run_canceled_webhook_event: object { id, created_at, data, 2 more }`
624
625 Sent when an eval run has been canceled.
626
627 - `id: string`
628
629 The unique ID of the event.
630
631 - `created_at: number`
632
633 The Unix timestamp (in seconds) of when the eval run was canceled.
634
635 - `data: object { id }`
636
637 Event data payload.
638
639 - `id: string`
640
641 The unique ID of the eval run.
642
643 - `type: "eval.run.canceled"`
644
645 The type of the event. Always `eval.run.canceled`.
646
647 - `object: optional "event"`
648
649 The object of the event. Always `event`.
650
651 - `"event"`
652
653 - `eval_run_failed_webhook_event: object { id, created_at, data, 2 more }`
654
655 Sent when an eval run has failed.
656
657 - `id: string`
658
659 The unique ID of the event.
660
661 - `created_at: number`
662
663 The Unix timestamp (in seconds) of when the eval run failed.
664
665 - `data: object { id }`
666
667 Event data payload.
668
669 - `id: string`
670
671 The unique ID of the eval run.
672
673 - `type: "eval.run.failed"`
674
675 The type of the event. Always `eval.run.failed`.
676
677 - `object: optional "event"`
678
679 The object of the event. Always `event`.
680
681 - `"event"`
682
683 - `eval_run_succeeded_webhook_event: object { id, created_at, data, 2 more }`
684
685 Sent when an eval run has succeeded.
686
687 - `id: string`
688
689 The unique ID of the event.
690
691 - `created_at: number`
692
693 The Unix timestamp (in seconds) of when the eval run succeeded.
694
695 - `data: object { id }`
696
697 Event data payload.
698
699 - `id: string`
700
701 The unique ID of the eval run.
702
703 - `type: "eval.run.succeeded"`
704
705 The type of the event. Always `eval.run.succeeded`.
706
707 - `object: optional "event"`
708
709 The object of the event. Always `event`.
710
711 - `"event"`
712
713 - `fine_tuning_job_cancelled_webhook_event: object { id, created_at, data, 2 more }`
714
715 Sent when a fine-tuning job has been cancelled.
716
717 - `id: string`
718
719 The unique ID of the event.
720
721 - `created_at: number`
722
723 The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
724
725 - `data: object { id }`
726
727 Event data payload.
728
729 - `id: string`
730
731 The unique ID of the fine-tuning job.
732
733 - `type: "fine_tuning.job.cancelled"`
734
735 The type of the event. Always `fine_tuning.job.cancelled`.
736
737 - `object: optional "event"`
738
739 The object of the event. Always `event`.
740
741 - `"event"`
742
743 - `fine_tuning_job_failed_webhook_event: object { id, created_at, data, 2 more }`
744
745 Sent when a fine-tuning job has failed.
746
747 - `id: string`
748
749 The unique ID of the event.
750
751 - `created_at: number`
752
753 The Unix timestamp (in seconds) of when the fine-tuning job failed.
754
755 - `data: object { id }`
756
757 Event data payload.
758
759 - `id: string`
760
761 The unique ID of the fine-tuning job.
762
763 - `type: "fine_tuning.job.failed"`
764
765 The type of the event. Always `fine_tuning.job.failed`.
766
767 - `object: optional "event"`
768
769 The object of the event. Always `event`.
770
771 - `"event"`
772
773 - `fine_tuning_job_succeeded_webhook_event: object { id, created_at, data, 2 more }`
774
775 Sent when a fine-tuning job has succeeded.
776
777 - `id: string`
778
779 The unique ID of the event.
780
781 - `created_at: number`
782
783 The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
784
785 - `data: object { id }`
786
787 Event data payload.
788
789 - `id: string`
790
791 The unique ID of the fine-tuning job.
792
793 - `type: "fine_tuning.job.succeeded"`
794
795 The type of the event. Always `fine_tuning.job.succeeded`.
796
797 - `object: optional "event"`
798
799 The object of the event. Always `event`.
800
801 - `"event"`
802
803 - `realtime_call_incoming_webhook_event: object { id, created_at, data, 2 more }`
804
805 Sent when Realtime API Receives a incoming SIP call.
806
807 - `id: string`
808
809 The unique ID of the event.
810
811 - `created_at: number`
812
813 The Unix timestamp (in seconds) of when the model response was completed.
814
815 - `data: object { call_id, sip_headers }`
816
817 Event data payload.
818
819 - `call_id: string`
820
821 The unique ID of this call.
822
823 - `sip_headers: array of object { name, value }`
824
825 Headers from the SIP Invite.
826
827 - `name: string`
828
829 Name of the SIP Header.
830
831 - `value: string`
832
833 Value of the SIP Header.
834
835 - `type: "realtime.call.incoming"`
836
837 The type of the event. Always `realtime.call.incoming`.
838
839 - `object: optional "event"`
840
841 The object of the event. Always `event`.
842
843 - `"event"`
844
845 - `response_cancelled_webhook_event: object { id, created_at, data, 2 more }`
846
847 Sent when a background response has been cancelled.
848
849 - `id: string`
850
851 The unique ID of the event.
852
853 - `created_at: number`
854
855 The Unix timestamp (in seconds) of when the model response was cancelled.
856
857 - `data: object { id }`
858
859 Event data payload.
860
861 - `id: string`
862
863 The unique ID of the model response.
864
865 - `type: "response.cancelled"`
866
867 The type of the event. Always `response.cancelled`.
868
869 - `object: optional "event"`
870
871 The object of the event. Always `event`.
872
873 - `"event"`
874
875 - `response_completed_webhook_event: object { id, created_at, data, 2 more }`
876
877 Sent when a background response has been completed.
878
879 - `id: string`
880
881 The unique ID of the event.
882
883 - `created_at: number`
884
885 The Unix timestamp (in seconds) of when the model response was completed.
886
887 - `data: object { id }`
888
889 Event data payload.
890
891 - `id: string`
892
893 The unique ID of the model response.
894
895 - `type: "response.completed"`
896
897 The type of the event. Always `response.completed`.
898
899 - `object: optional "event"`
900
901 The object of the event. Always `event`.
902
903 - `"event"`
904
905 - `response_failed_webhook_event: object { id, created_at, data, 2 more }`
906
907 Sent when a background response has failed.
908
909 - `id: string`
910
911 The unique ID of the event.
912
913 - `created_at: number`
914
915 The Unix timestamp (in seconds) of when the model response failed.
916
917 - `data: object { id }`
918
919 Event data payload.
920
921 - `id: string`
922
923 The unique ID of the model response.
924
925 - `type: "response.failed"`
926
927 The type of the event. Always `response.failed`.
928
929 - `object: optional "event"`
930
931 The object of the event. Always `event`.
932
933 - `"event"`
934
935 - `response_incomplete_webhook_event: object { id, created_at, data, 2 more }`
936
937 Sent when a background response has been interrupted.
938
939 - `id: string`
940
941 The unique ID of the event.
942
943 - `created_at: number`
944
945 The Unix timestamp (in seconds) of when the model response was interrupted.
946
947 - `data: object { id }`
948
949 Event data payload.
950
951 - `id: string`
952
953 The unique ID of the model response.
954
955 - `type: "response.incomplete"`
956
957 The type of the event. Always `response.incomplete`.
958
959 - `object: optional "event"`
960
961 The object of the event. Always `event`.
962
963 - `"event"`