Webhooks

Domain Types

Batch Cancelled Webhook Event

class BatchCancelledWebhookEvent:

Sent when a batch API request has been cancelled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request was cancelled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.cancelled"constant
  
  The type of the event. Always batch.cancelled.
  - BATCH_CANCELLED("batch.cancelled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Batch Completed Webhook Event

class BatchCompletedWebhookEvent:

Sent when a batch API request has been completed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request was completed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.completed"constant
  
  The type of the event. Always batch.completed.
  - BATCH_COMPLETED("batch.completed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Batch Expired Webhook Event

class BatchExpiredWebhookEvent:

Sent when a batch API request has expired.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request expired.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.expired"constant
  
  The type of the event. Always batch.expired.
  - BATCH_EXPIRED("batch.expired")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Batch Failed Webhook Event

class BatchFailedWebhookEvent:

Sent when a batch API request has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the batch API request failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the batch API request.
- JsonValue; type "batch.failed"constant
  
  The type of the event. Always batch.failed.
  - BATCH_FAILED("batch.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Eval Run Canceled Webhook Event

class EvalRunCanceledWebhookEvent:

Sent when an eval run has been canceled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the eval run was canceled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the eval run.
- JsonValue; type "eval.run.canceled"constant
  
  The type of the event. Always eval.run.canceled.
  - EVAL_RUN_CANCELED("eval.run.canceled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Eval Run Failed Webhook Event

class EvalRunFailedWebhookEvent:

Sent when an eval run has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the eval run failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the eval run.
- JsonValue; type "eval.run.failed"constant
  
  The type of the event. Always eval.run.failed.
  - EVAL_RUN_FAILED("eval.run.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Eval Run Succeeded Webhook Event

class EvalRunSucceededWebhookEvent:

Sent when an eval run has succeeded.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the eval run succeeded.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the eval run.
- JsonValue; type "eval.run.succeeded"constant
  
  The type of the event. Always eval.run.succeeded.
  - EVAL_RUN_SUCCEEDED("eval.run.succeeded")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Fine Tuning Job Cancelled Webhook Event

class FineTuningJobCancelledWebhookEvent:

Sent when a fine-tuning job has been cancelled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the fine-tuning job.
- JsonValue; type "fine_tuning.job.cancelled"constant
  
  The type of the event. Always fine_tuning.job.cancelled.
  - FINE_TUNING_JOB_CANCELLED("fine_tuning.job.cancelled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Fine Tuning Job Failed Webhook Event

class FineTuningJobFailedWebhookEvent:

Sent when a fine-tuning job has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the fine-tuning job failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the fine-tuning job.
- JsonValue; type "fine_tuning.job.failed"constant
  
  The type of the event. Always fine_tuning.job.failed.
  - FINE_TUNING_JOB_FAILED("fine_tuning.job.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Fine Tuning Job Succeeded Webhook Event

class FineTuningJobSucceededWebhookEvent:

Sent when a fine-tuning job has succeeded.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the fine-tuning job.
- JsonValue; type "fine_tuning.job.succeeded"constant
  
  The type of the event. Always fine_tuning.job.succeeded.
  - FINE_TUNING_JOB_SUCCEEDED("fine_tuning.job.succeeded")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Realtime Call Incoming Webhook Event

class RealtimeCallIncomingWebhookEvent:

Sent when Realtime API Receives a incoming SIP call.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was completed.
- Data data
  
  Event data payload.
  - String callId
    
    The unique ID of this call.
  - List<SipHeader> sipHeaders
    
    Headers from the SIP Invite.
    - String name
      
      Name of the SIP Header.
    - String value
      
      Value of the SIP Header.
- JsonValue; type "realtime.call.incoming"constant
  
  The type of the event. Always realtime.call.incoming.
  - REALTIME_CALL_INCOMING("realtime.call.incoming")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Cancelled Webhook Event

class ResponseCancelledWebhookEvent:

Sent when a background response has been cancelled.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was cancelled.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.cancelled"constant
  
  The type of the event. Always response.cancelled.
  - RESPONSE_CANCELLED("response.cancelled")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Completed Webhook Event

class ResponseCompletedWebhookEvent:

Sent when a background response has been completed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was completed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.completed"constant
  
  The type of the event. Always response.completed.
  - RESPONSE_COMPLETED("response.completed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Failed Webhook Event

class ResponseFailedWebhookEvent:

Sent when a background response has failed.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response failed.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.failed"constant
  
  The type of the event. Always response.failed.
  - RESPONSE_FAILED("response.failed")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Response Incomplete Webhook Event

class ResponseIncompleteWebhookEvent:

Sent when a background response has been interrupted.
- String id
  
  The unique ID of the event.
- long createdAt
  
  The Unix timestamp (in seconds) of when the model response was interrupted.
- Data data
  
  Event data payload.
  - String id
    
    The unique ID of the model response.
- JsonValue; type "response.incomplete"constant
  
  The type of the event. Always response.incomplete.
  - RESPONSE_INCOMPLETE("response.incomplete")
- Optional<Object> object_
  
  The object of the event. Always event.
  - EVENT("event")

Unwrap Webhook Event

class UnwrapWebhookEvent: A class that can be one of several variants.union

Sent when a batch API request has been cancelled.
- class BatchCancelledWebhookEvent:
  
  Sent when a batch API request has been cancelled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request was cancelled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.cancelled"constant
    
    The type of the event. Always batch.cancelled.
    - BATCH_CANCELLED("batch.cancelled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class BatchCompletedWebhookEvent:
  
  Sent when a batch API request has been completed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request was completed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.completed"constant
    
    The type of the event. Always batch.completed.
    - BATCH_COMPLETED("batch.completed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class BatchExpiredWebhookEvent:
  
  Sent when a batch API request has expired.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request expired.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.expired"constant
    
    The type of the event. Always batch.expired.
    - BATCH_EXPIRED("batch.expired")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class BatchFailedWebhookEvent:
  
  Sent when a batch API request has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the batch API request failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the batch API request.
  - JsonValue; type "batch.failed"constant
    
    The type of the event. Always batch.failed.
    - BATCH_FAILED("batch.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class EvalRunCanceledWebhookEvent:
  
  Sent when an eval run has been canceled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the eval run was canceled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the eval run.
  - JsonValue; type "eval.run.canceled"constant
    
    The type of the event. Always eval.run.canceled.
    - EVAL_RUN_CANCELED("eval.run.canceled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class EvalRunFailedWebhookEvent:
  
  Sent when an eval run has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the eval run failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the eval run.
  - JsonValue; type "eval.run.failed"constant
    
    The type of the event. Always eval.run.failed.
    - EVAL_RUN_FAILED("eval.run.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class EvalRunSucceededWebhookEvent:
  
  Sent when an eval run has succeeded.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the eval run succeeded.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the eval run.
  - JsonValue; type "eval.run.succeeded"constant
    
    The type of the event. Always eval.run.succeeded.
    - EVAL_RUN_SUCCEEDED("eval.run.succeeded")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class FineTuningJobCancelledWebhookEvent:
  
  Sent when a fine-tuning job has been cancelled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the fine-tuning job.
  - JsonValue; type "fine_tuning.job.cancelled"constant
    
    The type of the event. Always fine_tuning.job.cancelled.
    - FINE_TUNING_JOB_CANCELLED("fine_tuning.job.cancelled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class FineTuningJobFailedWebhookEvent:
  
  Sent when a fine-tuning job has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the fine-tuning job failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the fine-tuning job.
  - JsonValue; type "fine_tuning.job.failed"constant
    
    The type of the event. Always fine_tuning.job.failed.
    - FINE_TUNING_JOB_FAILED("fine_tuning.job.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class FineTuningJobSucceededWebhookEvent:
  
  Sent when a fine-tuning job has succeeded.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the fine-tuning job succeeded.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the fine-tuning job.
  - JsonValue; type "fine_tuning.job.succeeded"constant
    
    The type of the event. Always fine_tuning.job.succeeded.
    - FINE_TUNING_JOB_SUCCEEDED("fine_tuning.job.succeeded")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class RealtimeCallIncomingWebhookEvent:
  
  Sent when Realtime API Receives a incoming SIP call.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was completed.
  - Data data
    
    Event data payload.
    - String callId
      
      The unique ID of this call.
    - List<SipHeader> sipHeaders
      
      Headers from the SIP Invite.
      - String name
        
        Name of the SIP Header.
      - String value
        
        Value of the SIP Header.
  - JsonValue; type "realtime.call.incoming"constant
    
    The type of the event. Always realtime.call.incoming.
    - REALTIME_CALL_INCOMING("realtime.call.incoming")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseCancelledWebhookEvent:
  
  Sent when a background response has been cancelled.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was cancelled.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.cancelled"constant
    
    The type of the event. Always response.cancelled.
    - RESPONSE_CANCELLED("response.cancelled")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseCompletedWebhookEvent:
  
  Sent when a background response has been completed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was completed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.completed"constant
    
    The type of the event. Always response.completed.
    - RESPONSE_COMPLETED("response.completed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseFailedWebhookEvent:
  
  Sent when a background response has failed.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response failed.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.failed"constant
    
    The type of the event. Always response.failed.
    - RESPONSE_FAILED("response.failed")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")
- class ResponseIncompleteWebhookEvent:
  
  Sent when a background response has been interrupted.
  - String id
    
    The unique ID of the event.
  - long createdAt
    
    The Unix timestamp (in seconds) of when the model response was interrupted.
  - Data data
    
    Event data payload.
    - String id
      
      The unique ID of the model response.
  - JsonValue; type "response.incomplete"constant
    
    The type of the event. Always response.incomplete.
    - RESPONSE_INCOMPLETE("response.incomplete")
  - Optional<Object> object_
    
    The object of the event. Always event.
    - EVENT("event")

java/resources/webhooks/index.md +1023 −0 created

1# Webhooks

3## Domain Types

5### Batch Cancelled Webhook Event

7- `class BatchCancelledWebhookEvent:`

9 Sent when a batch API request has been cancelled.

11 - `String id`

13 The unique ID of the event.

15 - `long createdAt`

17 The Unix timestamp (in seconds) of when the batch API request was cancelled.

19 - `Data data`

21 Event data payload.

23 - `String id`

25 The unique ID of the batch API request.

27 - `JsonValue; type "batch.cancelled"constant`

29 The type of the event. Always `batch.cancelled`.

31 - `BATCH_CANCELLED("batch.cancelled")`

33 - `Optional<Object> object_`

35 The object of the event. Always `event`.

37 - `EVENT("event")`

39### Batch Completed Webhook Event

41- `class BatchCompletedWebhookEvent:`

43 Sent when a batch API request has been completed.

45 - `String id`

47 The unique ID of the event.

49 - `long createdAt`

51 The Unix timestamp (in seconds) of when the batch API request was completed.

53 - `Data data`

55 Event data payload.

57 - `String id`

59 The unique ID of the batch API request.

61 - `JsonValue; type "batch.completed"constant`

63 The type of the event. Always `batch.completed`.

65 - `BATCH_COMPLETED("batch.completed")`

67 - `Optional<Object> object_`

69 The object of the event. Always `event`.

71 - `EVENT("event")`

73### Batch Expired Webhook Event

75- `class BatchExpiredWebhookEvent:`

77 Sent when a batch API request has expired.

79 - `String id`

81 The unique ID of the event.

83 - `long createdAt`

85 The Unix timestamp (in seconds) of when the batch API request expired.

87 - `Data data`

89 Event data payload.

91 - `String id`

93 The unique ID of the batch API request.

95 - `JsonValue; type "batch.expired"constant`

97 The type of the event. Always `batch.expired`.

99 - `BATCH_EXPIRED("batch.expired")`

100

101 - `Optional<Object> object_`

102

103 The object of the event. Always `event`.

104

105 - `EVENT("event")`

106

107### Batch Failed Webhook Event

108

109- `class BatchFailedWebhookEvent:`

110

111 Sent when a batch API request has failed.

112

113 - `String id`

114

115 The unique ID of the event.

116

117 - `long createdAt`

118

119 The Unix timestamp (in seconds) of when the batch API request failed.

120

121 - `Data data`

122

123 Event data payload.

124

125 - `String id`

126

127 The unique ID of the batch API request.

128

129 - `JsonValue; type "batch.failed"constant`

130

131 The type of the event. Always `batch.failed`.

132

133 - `BATCH_FAILED("batch.failed")`

134

135 - `Optional<Object> object_`

136

137 The object of the event. Always `event`.

138

139 - `EVENT("event")`

140

141### Eval Run Canceled Webhook Event

142

143- `class EvalRunCanceledWebhookEvent:`

144

145 Sent when an eval run has been canceled.

146

147 - `String id`

148

149 The unique ID of the event.

150

151 - `long createdAt`

152

153 The Unix timestamp (in seconds) of when the eval run was canceled.

154

155 - `Data data`

156

157 Event data payload.

158

159 - `String id`

160

161 The unique ID of the eval run.

162

163 - `JsonValue; type "eval.run.canceled"constant`

164

165 The type of the event. Always `eval.run.canceled`.

166

167 - `EVAL_RUN_CANCELED("eval.run.canceled")`

168

169 - `Optional<Object> object_`

170

171 The object of the event. Always `event`.

172

173 - `EVENT("event")`

174

175### Eval Run Failed Webhook Event

176

177- `class EvalRunFailedWebhookEvent:`

178

179 Sent when an eval run has failed.

180

181 - `String id`

182

183 The unique ID of the event.

184

185 - `long createdAt`

186

187 The Unix timestamp (in seconds) of when the eval run failed.

188

189 - `Data data`

190

191 Event data payload.

192

193 - `String id`

194

195 The unique ID of the eval run.

196

197 - `JsonValue; type "eval.run.failed"constant`

198

199 The type of the event. Always `eval.run.failed`.

200

201 - `EVAL_RUN_FAILED("eval.run.failed")`

202

203 - `Optional<Object> object_`

204

205 The object of the event. Always `event`.

206

207 - `EVENT("event")`

208

209### Eval Run Succeeded Webhook Event

210

211- `class EvalRunSucceededWebhookEvent:`

212

213 Sent when an eval run has succeeded.

214

215 - `String id`

216

217 The unique ID of the event.

218

219 - `long createdAt`

220

221 The Unix timestamp (in seconds) of when the eval run succeeded.

222

223 - `Data data`

224

225 Event data payload.

226

227 - `String id`

228

229 The unique ID of the eval run.

230

231 - `JsonValue; type "eval.run.succeeded"constant`

232

233 The type of the event. Always `eval.run.succeeded`.

234

235 - `EVAL_RUN_SUCCEEDED("eval.run.succeeded")`

236

237 - `Optional<Object> object_`

238

239 The object of the event. Always `event`.

240

241 - `EVENT("event")`

242

243### Fine Tuning Job Cancelled Webhook Event

244

245- `class FineTuningJobCancelledWebhookEvent:`

246

247 Sent when a fine-tuning job has been cancelled.

248

249 - `String id`

250

251 The unique ID of the event.

252

253 - `long createdAt`

254

255 The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.

256

257 - `Data data`

258

259 Event data payload.

260

261 - `String id`

262

263 The unique ID of the fine-tuning job.

264

265 - `JsonValue; type "fine_tuning.job.cancelled"constant`

266

267 The type of the event. Always `fine_tuning.job.cancelled`.

268

269 - `FINE_TUNING_JOB_CANCELLED("fine_tuning.job.cancelled")`

270

271 - `Optional<Object> object_`

272

273 The object of the event. Always `event`.

274

275 - `EVENT("event")`

276

277### Fine Tuning Job Failed Webhook Event

278

279- `class FineTuningJobFailedWebhookEvent:`

280

281 Sent when a fine-tuning job has failed.

282

283 - `String id`

284

285 The unique ID of the event.

286

287 - `long createdAt`

288

289 The Unix timestamp (in seconds) of when the fine-tuning job failed.

290

291 - `Data data`

292

293 Event data payload.

294

295 - `String id`

296

297 The unique ID of the fine-tuning job.

298

299 - `JsonValue; type "fine_tuning.job.failed"constant`

300

301 The type of the event. Always `fine_tuning.job.failed`.

302

303 - `FINE_TUNING_JOB_FAILED("fine_tuning.job.failed")`

304

305 - `Optional<Object> object_`

306

307 The object of the event. Always `event`.

308

309 - `EVENT("event")`

310

311### Fine Tuning Job Succeeded Webhook Event

312

313- `class FineTuningJobSucceededWebhookEvent:`

314

315 Sent when a fine-tuning job has succeeded.

316

317 - `String id`

318

319 The unique ID of the event.

320

321 - `long createdAt`

322

323 The Unix timestamp (in seconds) of when the fine-tuning job succeeded.

324

325 - `Data data`

326

327 Event data payload.

328

329 - `String id`

330

331 The unique ID of the fine-tuning job.

332

333 - `JsonValue; type "fine_tuning.job.succeeded"constant`

334

335 The type of the event. Always `fine_tuning.job.succeeded`.

336

337 - `FINE_TUNING_JOB_SUCCEEDED("fine_tuning.job.succeeded")`

338

339 - `Optional<Object> object_`

340

341 The object of the event. Always `event`.

342

343 - `EVENT("event")`

344

345### Realtime Call Incoming Webhook Event

346

347- `class RealtimeCallIncomingWebhookEvent:`

348

349 Sent when Realtime API Receives a incoming SIP call.

350

351 - `String id`

352

353 The unique ID of the event.

354

355 - `long createdAt`

356

357 The Unix timestamp (in seconds) of when the model response was completed.

358

359 - `Data data`

360

361 Event data payload.

362

363 - `String callId`

364

365 The unique ID of this call.

366

367 - `List<SipHeader> sipHeaders`

368

369 Headers from the SIP Invite.

370

371 - `String name`

372

373 Name of the SIP Header.

374

375 - `String value`

376

377 Value of the SIP Header.

378

379 - `JsonValue; type "realtime.call.incoming"constant`

380

381 The type of the event. Always `realtime.call.incoming`.

382

383 - `REALTIME_CALL_INCOMING("realtime.call.incoming")`

384

385 - `Optional<Object> object_`

386

387 The object of the event. Always `event`.

388

389 - `EVENT("event")`

390

391### Response Cancelled Webhook Event

392

393- `class ResponseCancelledWebhookEvent:`

394

395 Sent when a background response has been cancelled.

396

397 - `String id`

398

399 The unique ID of the event.

400

401 - `long createdAt`

402

403 The Unix timestamp (in seconds) of when the model response was cancelled.

404

405 - `Data data`

406

407 Event data payload.

408

409 - `String id`

410

411 The unique ID of the model response.

412

413 - `JsonValue; type "response.cancelled"constant`

414

415 The type of the event. Always `response.cancelled`.

416

417 - `RESPONSE_CANCELLED("response.cancelled")`

418

419 - `Optional<Object> object_`

420

421 The object of the event. Always `event`.

422

423 - `EVENT("event")`

424

425### Response Completed Webhook Event

426

427- `class ResponseCompletedWebhookEvent:`

428

429 Sent when a background response has been completed.

430

431 - `String id`

432

433 The unique ID of the event.

434

435 - `long createdAt`

436

437 The Unix timestamp (in seconds) of when the model response was completed.

438

439 - `Data data`

440

441 Event data payload.

442

443 - `String id`

444

445 The unique ID of the model response.

446

447 - `JsonValue; type "response.completed"constant`

448

449 The type of the event. Always `response.completed`.

450

451 - `RESPONSE_COMPLETED("response.completed")`

452

453 - `Optional<Object> object_`

454

455 The object of the event. Always `event`.

456

457 - `EVENT("event")`

458

459### Response Failed Webhook Event

460

461- `class ResponseFailedWebhookEvent:`

462

463 Sent when a background response has failed.

464

465 - `String id`

466

467 The unique ID of the event.

468

469 - `long createdAt`

470

471 The Unix timestamp (in seconds) of when the model response failed.

472

473 - `Data data`

474

475 Event data payload.

476

477 - `String id`

478

479 The unique ID of the model response.

480

481 - `JsonValue; type "response.failed"constant`

482

483 The type of the event. Always `response.failed`.

484

485 - `RESPONSE_FAILED("response.failed")`

486

487 - `Optional<Object> object_`

488

489 The object of the event. Always `event`.

490

491 - `EVENT("event")`

492

493### Response Incomplete Webhook Event

494

495- `class ResponseIncompleteWebhookEvent:`

496

497 Sent when a background response has been interrupted.

498

499 - `String id`

500

501 The unique ID of the event.

502

503 - `long createdAt`

504

505 The Unix timestamp (in seconds) of when the model response was interrupted.

506

507 - `Data data`

508

509 Event data payload.

510

511 - `String id`

512

513 The unique ID of the model response.

514

515 - `JsonValue; type "response.incomplete"constant`

516

517 The type of the event. Always `response.incomplete`.

518

519 - `RESPONSE_INCOMPLETE("response.incomplete")`

520

521 - `Optional<Object> object_`

522

523 The object of the event. Always `event`.

524

525 - `EVENT("event")`

526

527### Unwrap Webhook Event

528

529- `class UnwrapWebhookEvent: A class that can be one of several variants.union`

530

531 Sent when a batch API request has been cancelled.

532

533 - `class BatchCancelledWebhookEvent:`

534

535 Sent when a batch API request has been cancelled.

536

537 - `String id`

538

539 The unique ID of the event.

540

541 - `long createdAt`

542

543 The Unix timestamp (in seconds) of when the batch API request was cancelled.

544

545 - `Data data`

546

547 Event data payload.

548

549 - `String id`

550

551 The unique ID of the batch API request.

552

553 - `JsonValue; type "batch.cancelled"constant`

554

555 The type of the event. Always `batch.cancelled`.

556

557 - `BATCH_CANCELLED("batch.cancelled")`

558

559 - `Optional<Object> object_`

560

561 The object of the event. Always `event`.

562

563 - `EVENT("event")`

564

565 - `class BatchCompletedWebhookEvent:`

566

567 Sent when a batch API request has been completed.

568

569 - `String id`

570

571 The unique ID of the event.

572

573 - `long createdAt`

574

575 The Unix timestamp (in seconds) of when the batch API request was completed.

576

577 - `Data data`

578

579 Event data payload.

580

581 - `String id`

582

583 The unique ID of the batch API request.

584

585 - `JsonValue; type "batch.completed"constant`

586

587 The type of the event. Always `batch.completed`.

588

589 - `BATCH_COMPLETED("batch.completed")`

590

591 - `Optional<Object> object_`

592

593 The object of the event. Always `event`.

594

595 - `EVENT("event")`

596

597 - `class BatchExpiredWebhookEvent:`

598

599 Sent when a batch API request has expired.

600

601 - `String id`

602

603 The unique ID of the event.

604

605 - `long createdAt`

606

607 The Unix timestamp (in seconds) of when the batch API request expired.

608

609 - `Data data`

610

611 Event data payload.

612

613 - `String id`

614

615 The unique ID of the batch API request.

616

617 - `JsonValue; type "batch.expired"constant`

618

619 The type of the event. Always `batch.expired`.

620

621 - `BATCH_EXPIRED("batch.expired")`

622

623 - `Optional<Object> object_`

624

625 The object of the event. Always `event`.

626

627 - `EVENT("event")`

628

629 - `class BatchFailedWebhookEvent:`

630

631 Sent when a batch API request has failed.

632

633 - `String id`

634

635 The unique ID of the event.

636

637 - `long createdAt`

638

639 The Unix timestamp (in seconds) of when the batch API request failed.

640

641 - `Data data`

642

643 Event data payload.

644

645 - `String id`

646

647 The unique ID of the batch API request.

648

649 - `JsonValue; type "batch.failed"constant`

650

651 The type of the event. Always `batch.failed`.

652

653 - `BATCH_FAILED("batch.failed")`

654

655 - `Optional<Object> object_`

656

657 The object of the event. Always `event`.

658

659 - `EVENT("event")`

660

661 - `class EvalRunCanceledWebhookEvent:`

662

663 Sent when an eval run has been canceled.

664

665 - `String id`

666

667 The unique ID of the event.

668

669 - `long createdAt`

670

671 The Unix timestamp (in seconds) of when the eval run was canceled.

672

673 - `Data data`

674

675 Event data payload.

676

677 - `String id`

678

679 The unique ID of the eval run.

680

681 - `JsonValue; type "eval.run.canceled"constant`

682

683 The type of the event. Always `eval.run.canceled`.

684

685 - `EVAL_RUN_CANCELED("eval.run.canceled")`

686

687 - `Optional<Object> object_`

688

689 The object of the event. Always `event`.

690

691 - `EVENT("event")`

692

693 - `class EvalRunFailedWebhookEvent:`

694

695 Sent when an eval run has failed.

696

697 - `String id`

698

699 The unique ID of the event.

700

701 - `long createdAt`

702

703 The Unix timestamp (in seconds) of when the eval run failed.

704

705 - `Data data`

706

707 Event data payload.

708

709 - `String id`

710

711 The unique ID of the eval run.

712

713 - `JsonValue; type "eval.run.failed"constant`

714

715 The type of the event. Always `eval.run.failed`.

716

717 - `EVAL_RUN_FAILED("eval.run.failed")`

718

719 - `Optional<Object> object_`

720

721 The object of the event. Always `event`.

722

723 - `EVENT("event")`

724

725 - `class EvalRunSucceededWebhookEvent:`

726

727 Sent when an eval run has succeeded.

728

729 - `String id`

730

731 The unique ID of the event.

732

733 - `long createdAt`

734

735 The Unix timestamp (in seconds) of when the eval run succeeded.

736

737 - `Data data`

738

739 Event data payload.

740

741 - `String id`

742

743 The unique ID of the eval run.

744

745 - `JsonValue; type "eval.run.succeeded"constant`

746

747 The type of the event. Always `eval.run.succeeded`.

748

749 - `EVAL_RUN_SUCCEEDED("eval.run.succeeded")`

750

751 - `Optional<Object> object_`

752

753 The object of the event. Always `event`.

754

755 - `EVENT("event")`

756

757 - `class FineTuningJobCancelledWebhookEvent:`

758

759 Sent when a fine-tuning job has been cancelled.

760

761 - `String id`

762

763 The unique ID of the event.

764

765 - `long createdAt`

766

767 The Unix timestamp (in seconds) of when the fine-tuning job was cancelled.

768

769 - `Data data`

770

771 Event data payload.

772

773 - `String id`

774

775 The unique ID of the fine-tuning job.

776

777 - `JsonValue; type "fine_tuning.job.cancelled"constant`

778

779 The type of the event. Always `fine_tuning.job.cancelled`.

780

781 - `FINE_TUNING_JOB_CANCELLED("fine_tuning.job.cancelled")`

782

783 - `Optional<Object> object_`

784

785 The object of the event. Always `event`.

786

787 - `EVENT("event")`

788

789 - `class FineTuningJobFailedWebhookEvent:`

790

791 Sent when a fine-tuning job has failed.

792

793 - `String id`

794

795 The unique ID of the event.

796

797 - `long createdAt`

798

799 The Unix timestamp (in seconds) of when the fine-tuning job failed.

800

801 - `Data data`

802

803 Event data payload.

804

805 - `String id`

806

807 The unique ID of the fine-tuning job.

808

809 - `JsonValue; type "fine_tuning.job.failed"constant`

810

811 The type of the event. Always `fine_tuning.job.failed`.

812

813 - `FINE_TUNING_JOB_FAILED("fine_tuning.job.failed")`

814

815 - `Optional<Object> object_`

816

817 The object of the event. Always `event`.

818

819 - `EVENT("event")`

820

821 - `class FineTuningJobSucceededWebhookEvent:`

822

823 Sent when a fine-tuning job has succeeded.

824

825 - `String id`

826

827 The unique ID of the event.

828

829 - `long createdAt`

830

831 The Unix timestamp (in seconds) of when the fine-tuning job succeeded.

832

833 - `Data data`

834

835 Event data payload.

836

837 - `String id`

838

839 The unique ID of the fine-tuning job.

840

841 - `JsonValue; type "fine_tuning.job.succeeded"constant`

842

843 The type of the event. Always `fine_tuning.job.succeeded`.

844

845 - `FINE_TUNING_JOB_SUCCEEDED("fine_tuning.job.succeeded")`

846

847 - `Optional<Object> object_`

848

849 The object of the event. Always `event`.

850

851 - `EVENT("event")`

852

853 - `class RealtimeCallIncomingWebhookEvent:`

854

855 Sent when Realtime API Receives a incoming SIP call.

856

857 - `String id`

858

859 The unique ID of the event.

860

861 - `long createdAt`

862

863 The Unix timestamp (in seconds) of when the model response was completed.

864

865 - `Data data`

866

867 Event data payload.

868

869 - `String callId`

870

871 The unique ID of this call.

872

873 - `List<SipHeader> sipHeaders`

874

875 Headers from the SIP Invite.

876

877 - `String name`

878

879 Name of the SIP Header.

880

881 - `String value`

882

883 Value of the SIP Header.

884

885 - `JsonValue; type "realtime.call.incoming"constant`

886

887 The type of the event. Always `realtime.call.incoming`.

888

889 - `REALTIME_CALL_INCOMING("realtime.call.incoming")`

890

891 - `Optional<Object> object_`

892

893 The object of the event. Always `event`.

894

895 - `EVENT("event")`

896

897 - `class ResponseCancelledWebhookEvent:`

898

899 Sent when a background response has been cancelled.

900

901 - `String id`

902

903 The unique ID of the event.

904

905 - `long createdAt`

906

907 The Unix timestamp (in seconds) of when the model response was cancelled.

908

909 - `Data data`

910

911 Event data payload.

912

913 - `String id`

914

915 The unique ID of the model response.

916

917 - `JsonValue; type "response.cancelled"constant`

918

919 The type of the event. Always `response.cancelled`.

920

921 - `RESPONSE_CANCELLED("response.cancelled")`

922

923 - `Optional<Object> object_`

924

925 The object of the event. Always `event`.

926

927 - `EVENT("event")`

928

929 - `class ResponseCompletedWebhookEvent:`

930

931 Sent when a background response has been completed.

932

933 - `String id`

934

935 The unique ID of the event.

936

937 - `long createdAt`

938

939 The Unix timestamp (in seconds) of when the model response was completed.

940

941 - `Data data`

942

943 Event data payload.

944

945 - `String id`

946

947 The unique ID of the model response.

948

949 - `JsonValue; type "response.completed"constant`

950

951 The type of the event. Always `response.completed`.

952

953 - `RESPONSE_COMPLETED("response.completed")`

954

955 - `Optional<Object> object_`

956

957 The object of the event. Always `event`.

958

959 - `EVENT("event")`

960

961 - `class ResponseFailedWebhookEvent:`

962

963 Sent when a background response has failed.

964

965 - `String id`

966

967 The unique ID of the event.

968

969 - `long createdAt`

970

971 The Unix timestamp (in seconds) of when the model response failed.

972

973 - `Data data`

974

975 Event data payload.

976

977 - `String id`

978

979 The unique ID of the model response.

980

981 - `JsonValue; type "response.failed"constant`

982

983 The type of the event. Always `response.failed`.

984

985 - `RESPONSE_FAILED("response.failed")`

986

987 - `Optional<Object> object_`

988

989 The object of the event. Always `event`.

990

991 - `EVENT("event")`

992

993 - `class ResponseIncompleteWebhookEvent:`

994

995 Sent when a background response has been interrupted.

996

997 - `String id`

998

999 The unique ID of the event.

1000

1001 - `long createdAt`

1002

1003 The Unix timestamp (in seconds) of when the model response was interrupted.

1004

1005 - `Data data`

1006

1007 Event data payload.

1008

1009 - `String id`

1010

1011 The unique ID of the model response.

1012

1013 - `JsonValue; type "response.incomplete"constant`

1014

1015 The type of the event. Always `response.incomplete`.

1016

1017 - `RESPONSE_INCOMPLETE("response.incomplete")`

1018

1019 - `Optional<Object> object_`

1020

1021 The object of the event. Always `event`.

1022

1023 - `EVENT("event")`