Skip to content

Commit e384e58

Browse files
dtmeadowsstainless-app[bot]
authored andcommitted
chore(docs): update README to include links to docs on Webhooks
1 parent d47298c commit e384e58

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
@@ -116,6 +116,8 @@ Note that you can also pass a raw `IO` descriptor, but this disables retries, as
116116

117117
Verifying webhook signatures is _optional but encouraged_.
118118

119+
For more information about webhooks, see [the API docs](https://platform.openai.com/docs/guides/webhooks).
120+
119121
### Parsing webhook payloads
120122

121123
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)