Skip to content

docs: Update webhook auth docstring - #990

Open
jpclark6 wants to merge 1 commit into
sendgrid:mainfrom
jpclark6:webhook-auth-encoding
Open

docs: Update webhook auth docstring#990
jpclark6 wants to merge 1 commit into
sendgrid:mainfrom
jpclark6:webhook-auth-encoding

Conversation

@jpclark6

@jpclark6jpclark6 commented May 11, 2021•
edited
Loading

Copy link
Copy Markdown

Fixes

The verify_signature method returns False if the event payload is decoded using utf-8 and special characters exist, such as "é". The payload must be decoded using latin-1 to successfully pass authorization in these situations.

Checklist

  • I acknowledge that all my contributions will be made under the project's license
  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the Contribution Guidelines and my PR follows them
  • I have titled the PR appropriately
  • I have updated my branch with the main branch
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation about the functionality in the appropriate .md file
  • I have added inline documentation to the code I modified

If you have questions, please file a support ticket, or create a GitHub Issue in this repository.

@jpclark6
Update webhook auth docstring
0bb6434
The verify_signature method returns False if the event payload is decoded
using utf-8 if special characters exist. The payload must be decoded
using latin-1 to have it not fail on what should be successful
authorizations. It is not clear from the current docstring what encoding
to use when decoding the bytes payload
@thinkingseriousthinkingserious added status: code review request requesting a community code review or review from Twilio status: ready for deploy code ready to be released in next deploy type: community enhancement feature request not on Twilio's roadmap type: docs update documentation change not affecting the code and removed status: code review request requesting a community code review or review from Twilio labels May 11, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thinkingseriousthinkingseriousthinkingserious approved these changes

Assignees

No one assigned

Labels

status: ready for deploycode ready to be released in next deploytype: community enhancementfeature request not on Twilio's roadmaptype: docs updatedocumentation change not affecting the code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jpclark6@thinkingserious