Info
Webhook added
openapi:* *::operation.webhook-added- Product
- OpenAI API
- Source
- OpenAPI URL
- Change kind
- Webhook Added
- Detected
- Last updated
Deterministic evidence
Before / after
Extracted from OpenAI's published contract. Shows the shared components — a narrower excerpt was not available for this change. Open the source ↗
],
],
"type": "object"
"type": "object"
},
},
"AgentSessionActionRequiredPayloadResource": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"required_action": {
"$ref": "#/components/schemas/AgentSessionRequiredActionPayloadResource"
}
},
"required": [
"id",
"required_action"
],
"type": "object"
},
"AgentSessionConnectPayloadResource": {
"additionalProperties": false,
"properties": {
"remote_url": {
"type": "string"
}
},
"required": [
"remote_url"
],
"type": "object"
},
"AgentSessionCreatedPayloadResource": {
"additionalProperties": false,
"properties": {
"connect": {
"$ref": "#/components/schemas/AgentSessionConnectPayloadResource"
},
"environment_id": {
"type": "string"
},
"environment_type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"environment_type"
],
"type": "object"
},
"AgentSessionEnvironmentPayloadResource": {
"additionalProperties": false,
"properties": {
"environment_id": {
"type": "string"
},
"environment_type": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id",
"environment_type"
],
"type": "object"
},
"AgentSessionRequiredActionPayloadResource": {
"additionalProperties": false,
"properties": {
"type": {
"$ref": "#/components/schemas/AgentSessionRequiredActionTypeResource"
}
},
"required": [
"type"
],
"type": "object"
},
"AgentSessionRequiredActionTypeResource": {
"enum": [
"computer_use_approval_request",
"function_call",
"environment_connection"
],
"type": "string"
},
"AgentToolConfigParam": {
"AgentToolConfigParam": {
"discriminator": {
"discriminator": {
"mapping": {
"mapping": {
"type": "array"
"type": "array"
},
},
"first_id": {
"first_id": {
"type": "string"
"type": [
"string",
"null"
]
},
},
"has_more": {
"has_more": {
"type": "boolean"
"type": "boolean"
},
},
"last_id": {
"last_id": {
"type": "string"
"type": [
"string",
"null"
]
},
},
"object": {
"object": {
"default": "list",
"default": "list",
"name",
"name",
"arguments"
"arguments"
],
],
"type": "object"
"type": [
"object",
"null"
]
},
},
"refusal": {
"refusal": {
"anyOf": [
"anyOf": [
"x-stainless-const": true
"x-stainless-const": true
},
},
"tool_calls": {
"tool_calls": {
"$ref": "#/components/schemas/ChatCompletionMessageToolCalls"
"anyOf": [
{
"$ref": "#/components/schemas/ChatCompletionMessageToolCalls"
},
{
"type": "null"
}
]
}
}
},
},
"required": [
"required": [
"role",
"role",
"content",
"content"
"refusal"
],
],
"type": "object"
"type": "object"
},
},
"anyOf": [
"anyOf": [
{
{
"additionalProperties": {
"additionalProperties": {
"oneOf": [
"anyOf": [
{
{
"type": "string"
"type": "string"
},
},
},
},
{
{
"type": "number"
"type": "number"
},
{
"type": "null"
}
}
]
]
},
},
"type": "string"
"type": "string"
},
},
"type": {
"type": {
"default": "consent",
"default": "audio_sample",
"enum": [
"enum": [
"consent"
"audio_sample"
],
],
"type": "string"
"type": "string"
}
}
"CreateVoiceRequest": {
"CreateVoiceRequest": {
"discriminator": {
"discriminator": {
"mapping": {
"mapping": {
"consent": "#/components/schemas/CreateVoiceFromConsentRequest",
"audio_sample": "#/components/schemas/CreateVoiceFromConsentRequest",
"prompt": "#/components/schemas/CreateVoicePromptRequest"
"prompt": "#/components/schemas/CreateVoicePromptRequest"
},
},
"propertyName": "type"
"propertyName": "type"
"$ref": "#/components/schemas/CreateVoicePromptRequest"
"$ref": "#/components/schemas/CreateVoicePromptRequest"
}
}
],
],
"x-oai-default-discriminator-value": "consent"
"x-oai-default-discriminator-value": "audio_sample"
},
},
"CustomGrammarFormatParam": {
"CustomGrammarFormatParam": {
"properties": {
"properties": {
"realtime.call.incoming",
"realtime.call.incoming",
"video.completed",
"video.completed",
"video.failed",
"video.failed",
"agent.session.created",
"agent.session.action_required",
"agent.session.in_progress",
"agent.session.idle",
"agent.session.failed",
"safety.alert.created"
"safety.alert.created"
],
],
"type": "string"
"type": "string"
],
],
"type": "string",
"type": "string",
"x-stainless-const": true
"x-stainless-const": true
},
"type": {
"enum": [
"audio_sample",
"prompt"
],
"type": "string"
}
}
},
},
"required": [
"required": [
"object",
"object",
"id",
"id",
"name",
"name",
"type",
"created_at"
"created_at"
],
],
"title": "Voice",
"title": "Voice",
],
],
"title": "Web search tool call",
"title": "Web search tool call",
"type": "object"
"type": "object"
},
"WebhookAgentSessionActionRequired": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentSessionActionRequiredPayloadResource"
},
"type": {
"enum": [
"agent.session.action_required"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.session.action_required",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.session.action_required"
}
},
"WebhookAgentSessionCreated": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentSessionCreatedPayloadResource"
},
"type": {
"enum": [
"agent.session.created"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.session.created",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.session.created"
}
},
"WebhookAgentSessionEnvelope": {
"properties": {
"created_at": {
"format": "unixtime",
"type": "integer"
},
"id": {
"type": "string"
},
"object": {
"enum": [
"event"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"id",
"object",
"created_at"
],
"type": "object"
},
"WebhookAgentSessionFailed": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentSessionEnvironmentPayloadResource"
},
"type": {
"enum": [
"agent.session.failed"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.session.failed",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.session.failed"
}
},
"WebhookAgentSessionIdle": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentSessionEnvironmentPayloadResource"
},
"type": {
"enum": [
"agent.session.idle"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.session.idle",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.session.idle"
}
},
"WebhookAgentSessionInProgress": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookAgentSessionEnvelope"
},
{
"properties": {
"data": {
"$ref": "#/components/schemas/AgentSessionEnvironmentPayloadResource"
},
"type": {
"enum": [
"agent.session.in_progress"
],
"type": "string",
"x-stainless-const": true
}
},
"required": [
"type",
"data"
],
"type": "object"
}
],
"title": "agent.session.in_progress",
"type": "object",
"x-oaiMeta": {
"group": "webhook-events",
"name": "agent.session.in_progress"
}
},
},
"WebhookBatchCancelled": {
"WebhookBatchCancelled": {
"properties": {
"properties": {
Monitored for you
Does this change affect your integration?
Choose the operations and fields your services use. detektu matches OpenAI findings to that declared usage so your team can review the relevant evidence. No agent or repository access required.