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