openai · OpenAI Platform Docs
Webhooks | OpenAI API
Explains how to configure, receive, and verify webhook events from the OpenAI API to handle asynchronous notifications.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Webhooks | OpenAI API
Explains how to configure, receive, and verify webhook events from the OpenAI API to handle asynchronous notifications.
When To Use
Use when implementing automated responses to asynchronous API events or setting up real-time event monitoring for OpenAI services.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/webhooks-openai-api-workflow-guide.md | A guide explaining how to create webhook endpoints, handle requests, test locally, and verify webhook signatures for OpenAI API events. | Questions about a guide explaining how to create webhook endpoints, handle requests, test locally, and verify webhook signatures for... |
examples/webhooks-openai-api-openai-api-webhooks-python-flask-signature-verificat.text | A Python Flask application demonstrating how to receive and verify OpenAI webhook signatures using the OpenAI client library. | Exact payloads, commands, or snippets shown in A Python Flask application demonstrating how to receive and verify OpenAI webhook signatures using the OpenAI client... |
examples/webhooks-openai-api-openai-api-webhooks-nodejs-express-signature-verific.text | A Node.js Express implementation demonstrating how to receive and verify OpenAI webhook signatures using raw text bodies. | Exact payloads, commands, or snippets shown in A Node.js Express implementation demonstrating how to receive and verify OpenAI webhook signatures using raw text bod... |
examples/webhooks-openai-api-openai-api-webhooks-curl-request.text | A curl command demonstrating how to initiate a background request to the OpenAI API to trigger a webhook response. | Exact payloads, commands, or snippets shown in A curl command demonstrating how to initiate a background request to the OpenAI API to trigger a webhook response. |
examples/webhooks-openai-api-openai-api-nodejs-background-response-creation.text | A Node.js code snippet demonstrating how to create a background response using the OpenAI client to trigger a webhook. | Exact payloads, commands, or snippets shown in A Node.js code snippet demonstrating how to create a background response using the OpenAI client to trigger a webhook. |
examples/webhooks-openai-api-openai-api-python-background-response-creation.text | A Python 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 Python code example demonstrating how to create a background response using the OpenAI client to trigger webhook ev... |
examples/webhooks-openai-api-openai-api-webhook-event-payload.text | A sample HTTP POST request body and headers representing an OpenAI API webhook event payload. | Exact payloads, commands, or snippets shown in A sample HTTP POST request body and headers representing an OpenAI API webhook event payload. |
examples/webhooks-openai-api-openai-api-webhooks-secret-environment-variable.text | An example of setting the OPENAI_WEBHOOK_SECRET environment variable for verifying webhook signatures. | Exact payloads, commands, or snippets shown in An example of setting the OPENAIWEBHOOKSECRET environment variable for verifying webhook signatures. |
examples/webhooks-openai-api-openai-api-webhooks-python-signature-verification.text | A Python code snippet 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 Python code snippet demonstrating how to use the OpenAI client to unwrap and verify webhook event signatures using... |
examples/webhooks-openai-api-openai-api-webhooks-nodejs-signature-verification.text | A Node.js 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 Node.js code example demonstrating how to use the OpenAI client to unwrap and verify webhook event signatures using... |
examples/webhooks-openai-api-openai-api-webhooks-rust-verification.text | A Rust code snippet demonstrating how to verify OpenAI webhook signatures using the standard webhooks crate. | Exact payloads, commands, or snippets shown in A Rust code snippet demonstrating how to verify OpenAI webhook signatures using the standard webhooks crate. |
examples/webhooks-openai-api-openai-webhooks-php-signature-verification.text | A PHP code snippet demonstrating how to verify the signature of an incoming OpenAI webhook payload using a webhook secret. | Exact payloads, commands, or snippets shown in A PHP code snippet demonstrating how to verify the signature of an incoming OpenAI webhook payload using a webhook se... |
What This Skill Covers
- OpenAI webhooks allow you to receive real-time notifications about events in the API, such as when a batch completes, a background response is generated, or...
- 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://platform.openai.com/docs/webhooks