Skip to content

Commit 586d5da

Browse files
committed
chore(docs): update README to include links to docs on Webhooks
1 parent e3a0a9c commit 586d5da

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
@@ -128,6 +128,8 @@ await client.files.create({
128128

129129
Verifying webhook signatures is _optional but encouraged_.
130130

131+
For more information about webhooks, see [the API docs](https://platform.openai.com/docs/guides/webhooks).
132+
131133
### Parsing webhook payloads
132134

133135
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 throw an error if the signature is invalid.

0 commit comments

Comments
 (0)