Skip to content

Conversation

@franrob-projects
Copy link
Contributor

@franrob-projects franrob-projects commented Dec 22, 2025

Description

  • Docs incorrectly states webhook signing applies to single requests -- it only applies to batched requests
    • Remove references to "single" webhook requests from the signing documentation.

Checklist

@coderabbitai
Copy link

coderabbitai bot commented Dec 22, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch EDU-2133-remove-single-batching-link

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@franrob-projects franrob-projects added the review-app Create a Heroku review app label Dec 22, 2025
Ably advises you to use a secure HTTPS URL when you configure webhooks. This way, you ensure that all communication with your servers is encrypted with TLS and cannot be intercepted.

In addition, Ably optionally supports signing webhook requests so you can verify their authenticity. This applies to both [single](#single) and [batched](#batched) webhook requests, as well as any streaming integrations that also rely on HTTP-based callbacks. Ably sends the signature in the `X-Ably-Signature` header for batched requests and references the connected key in the `X-Ably-Key` header.
In addition, Ably optionally supports signing webhook requests so you can verify their authenticity. This applies to [batched](#batched) webhook requests, as well as any streaming integrations that also rely on HTTP-based callbacks. Ably sends the signature in the `X-Ably-Signature` header for batched requests and references the connected key in the `X-Ably-Key` header.
Copy link
Contributor

@GregHolmes GregHolmes Dec 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something that would be easily missed? It feels like an important bit of information now it's only for batched webhook requests.

@ably-ci ably-ci temporarily deployed to ably-docs-edu-2133-remo-lcrp5i December 22, 2025 10:14 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-2133-remo-lcrp5i December 22, 2025 10:44 Inactive
@GregHolmes GregHolmes force-pushed the EDU-2133-remove-single-batching-link branch from fa2bf69 to 98b20b5 Compare December 22, 2025 13:32
@GregHolmes GregHolmes temporarily deployed to ably-docs-edu-2133-remo-lcrp5i December 22, 2025 13:32 Inactive
@GregHolmes GregHolmes merged commit 2498163 into main Dec 22, 2025
7 checks passed
@GregHolmes GregHolmes deleted the EDU-2133-remove-single-batching-link branch December 22, 2025 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

4 participants