Skip to content

Commit ddbf9f1

Browse files
committed
chore(docs): update README to include links to docs on Webhooks
1 parent 18e0b36 commit ddbf9f1

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,8 @@ The async client uses the exact same interface. If you pass a [`PathLike`](https
410410

411411
Verifying webhook signatures is _optional but encouraged_.
412412

413+
For more information about webhooks, see [the API docs](https://platform.openai.com/docs/guides/webhooks).
414+
413415
### Parsing webhook payloads
414416

415417
For most use cases, you will likely want to verify the webhook and parse the payload at the same time. To achieve this, we provide the method `client.webhooks.unwrap()`, which parses a webhook request and verifies that it was sent by OpenAI. This method will raise an error if the signature is invalid.

0 commit comments

Comments
 (0)