Skip to content

Commit ceb1927

Browse files
committed
docs: add webhook verification section to README
1 parent db0b711 commit ceb1927

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ If you're using Ruby on Rails, the [ImageKit Rails gem](https://github.com/image
2525
- [Helper Methods](#helper-methods)
2626
- [Authentication parameters for client-side uploads](#authentication-parameters-for-client-side-uploads)
2727
- [Responsive image attributes](#responsive-image-attributes)
28+
- [Webhook verification](#webhook-verification)
29+
- [Verifying webhook signatures](#verifying-webhook-signatures)
2830
- [Handling errors](#handling-errors)
2931
- [Retries](#retries)
3032
- [Timeouts](#timeouts)
@@ -525,6 +527,12 @@ attrs = image_kit.helper.get_responsive_image_attributes({
525527
})
526528
```
527529

530+
## Webhook verification
531+
532+
The ImageKit SDK provides utilities to verify webhook signatures for secure event handling. This ensures that webhook requests are actually coming from ImageKit and haven't been tampered with.
533+
534+
For detailed information about webhook setup, signature verification, and handling different webhook events, refer to the [ImageKit webhook documentation](https://imagekit.io/docs/webhooks#verify-webhook-signature).
535+
528536
### Handling errors
529537

530538
When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Imagekitio::Errors::APIError` will be thrown:

0 commit comments

Comments
 (0)