openai · OpenAI Platform Docs
Webhooks
Teaches how to configure webhook endpoints in the OpenAI dashboard, implement server-side request handling, test endpoints locally, and verify webhook signatures for security.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Webhooks
Teaches how to configure webhook endpoints in the OpenAI dashboard, implement server-side request handling, test endpoints locally, and verify webhook signatures for security.
When To Use
Use when you need to implement real-time event notifications for batch completions, fine-tuning jobs, or background responses in your application.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/webhooks-workflow-guide.md | A guide covering how to create webhook endpoints, handle incoming requests, test locally, and verify webhook signatures. | Questions about a guide covering how to create webhook endpoints, handle incoming requests, test locally, and verify webhook signatures. |
examples/webhooks-openai-webhooks-flask-python-receiver.python | A Python Flask application demonstrating how to receive and verify OpenAI webhook events using a webhook secret. | Exact payloads, commands, or snippets shown in A Python Flask application demonstrating how to receive and verify OpenAI webhook events using a webhook secret. |
examples/webhooks-openai-webhooks-express-signature-verification.javascript | A JavaScript example using Express to receive and verify OpenAI webhook signatures using the OpenAI client library. | Exact payloads, commands, or snippets shown in A JavaScript example using Express to receive and verify OpenAI webhook signatures using the OpenAI client library. |
examples/webhooks-openai-webhooks-curl-request.bash | A bash curl command demonstrating how to send a request to the OpenAI API to trigger a webhook response. | Exact payloads, commands, or snippets shown in A bash curl command demonstrating how to send a request to the OpenAI API to trigger a webhook response. |
examples/webhooks-openai-webhooks-javascript-response-creation.javascript | A JavaScript code example demonstrating how to create a background response using the OpenAI client to trigger webhook events. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to create a background response using the OpenAI client to trigger webhoo... |
examples/webhooks-openai-webhooks-python-response-creation.python | A Python script demonstrating how to create a background response using the OpenAI client to trigger webhook events. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to create a background response using the OpenAI client to trigger webhook events. |
examples/webhooks-openai-webhooks-http-post-request-payload.text | An example of an HTTP POST request payload sent by OpenAI webhooks including headers and event object structure. | Exact payloads, commands, or snippets shown in An example of an HTTP POST request payload sent by OpenAI webhooks including headers and event object structure. |
examples/webhooks-openai-webhooks-secret-environment-variable-setup.text | A text snippet demonstrating how to export the OPENAI_WEBHOOK_SECRET environment variable for webhook authentication. | Exact payloads, commands, or snippets shown in A text snippet demonstrating how to export the OPENAIWEBHOOKSECRET environment variable for webhook authentication. |
examples/webhooks-openai-webhooks-python-signature-verification.python | A Python code example demonstrating how to use the OpenAI client to unwrap and verify webhook event signatures. | Exact payloads, commands, or snippets shown in A Python code example demonstrating how to use the OpenAI client to unwrap and verify webhook event signatures. |
examples/webhooks-openai-webhooks-javascript-signature-verification.javascript | A JavaScript code example demonstrating how to use the OpenAI client to unwrap and verify webhook event signatures using a secret. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to use the OpenAI client to unwrap and verify webhook event signatures us... |
examples/webhooks-openai-webhooks-rust-verification.rust | A Rust code example demonstrating how to verify OpenAI webhook signatures using the standardwebhooks crate. | Exact payloads, commands, or snippets shown in A Rust code example demonstrating how to verify OpenAI webhook signatures using the standardwebhooks crate. |
examples/webhooks-openai-webhooks-php-signature-verification.php | A PHP code example demonstrating how to verify webhook signatures using a secret key and payload headers. | Exact payloads, commands, or snippets shown in A PHP code example demonstrating how to verify webhook signatures using a secret key and payload headers. |
What This Skill Covers
- To start receiving webhook requests on your server, log in to the dashboard and open the webhook settings page. Webhooks are configured per-project.
- Main sections:
Creating webhook endpoints,Handling webhook requests on a server,Testing webhooks locally,Verifying webhook signatures.
Workflow
- Open the most relevant file under
docs/for the exact documented workflow and wording. - Open
schemas/files for exact structured contracts. - Open
examples/files for concrete requests, commands, snippets, and manifests. - Do not add behavior or configuration that is not present in the attached source files.
Canonical source: https://developers.openai.com/api/docs/guides/webhooks.md