Prompt Buddy logoPrompt Buddy

openai · OpenAI Platform Docs

Webhooks and server-side controls | OpenAI API

Explains how to implement webhooks and server-side controls to manage Realtime API sessions and handle asynchronous events.

Import to Prompt Buddy

Derived skill

Files assembled from official documentation

Viewing SKILL.md

Webhooks and server-side controls | OpenAI API

Explains how to implement webhooks and server-side controls to manage Realtime API sessions and handle asynchronous events.

When To Use

Use when implementing event-driven architectures or server-side session management for Realtime API integrations.

Reference Files

FileContainsUse For
SKILL.mdEntry point: scope, routing table, and workflow.Start here.
docs/webhooks-and-server-side-controls-openai-api-workflow-guide.mdA guide explaining how to implement webhooks and server-side logic for the OpenAI Realtime API using WebRTC or SIP.Questions about a guide explaining how to implement webhooks and server-side logic for the OpenAI Realtime API using WebRTC or SIP.
examples/webhooks-and-server-side-controls-openai-api-openai-realtime-api-sdp-pos.textA JavaScript code snippet demonstrating how to send an SDP offer to the OpenAI Realtime API endpoint using a fetch request.Exact payloads, commands, or snippets shown in A JavaScript code snippet demonstrating how to send an SDP offer to the OpenAI Realtime API endpoint using a fetch re...
examples/webhooks-and-server-side-controls-openai-api-openai-realtime-server-cont.textA JavaScript code snippet demonstrating how to extract a call ID from the Location header in an SDP response for OpenAI Realtime API server-side controls.Exact payloads, commands, or snippets shown in A JavaScript code snippet demonstrating how to extract a call ID from the Location header in an SDP response for Open...
examples/webhooks-and-server-side-controls-openai-api-openai-realtime-websocket-s.textA JavaScript code snippet demonstrating how to connect to an OpenAI Realtime API WebSocket to manage server-side controls.Exact payloads, commands, or snippets shown in A JavaScript code snippet demonstrating how to connect to an OpenAI Realtime API WebSocket to manage server-side cont...
examples/webhooks-and-server-side-controls-openai-api-openai-webhooks-server-side.textAn example HTTP POST request demonstrating the headers and structure used by OpenAI to send webhook notifications for server-side controls.Exact payloads, commands, or snippets shown in An example HTTP POST request demonstrating the headers and structure used by OpenAI to send webhook notifications for...

What This Skill Covers

  • The Realtime API allows clients to connect directly to the API server via WebRTC or SIP. However, you’ll most likely want tool use and other business logic t...
  • Main sections: With WebRTC, With SIP.

Workflow

  1. Open the most relevant file under docs/ for the exact documented workflow and wording.
  2. Open schemas/ files for exact structured contracts.
  3. Open examples/ files for concrete requests, commands, snippets, and manifests.
  4. Do not add behavior or configuration that is not present in the attached source files.

Canonical source: https://developers.openai.com/api/docs/guides/realtime-server-controls