Skip to content

Commit

Permalink
docs: improve signed webhook events docs (#705)
Browse files Browse the repository at this point in the history
  • Loading branch information
shwetha-manvinkurke authored Oct 8, 2021
1 parent 470872d commit 49e6895
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ If you can't find a solution below, please open an [issue](https://github.com/se
- [Using the Package Manager](#using-the-package-manager)
- [Android Compatibility](#android-compatibility)
- [Viewing the Request Body](#viewing-the-request-body)
- [Verifying Event Webhooks](#signed-webhooks)

<a name="migrating"></a>
## Migrating from v2 to v3
Expand Down Expand Up @@ -114,3 +115,15 @@ You can do this right before you call `request.setBody(mail.build())` like so:
```java
System.out.println(mail.build());
```

<a name="signed-webhooks"></a>
## Signed Webhook Verification

Twilio SendGrid's Event Webhook will notify a URL via HTTP POST with information about events that occur as your mail is processed. [This](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features) article covers all you need to know to secure the Event Webhook, allowing you to verify that incoming requests originate from Twilio SendGrid. The sendgrid-java library can help you verify these Signed Event Webhooks.

You can find the end-to-end usage example [here](examples/helpers/eventwebhook/Example.java) and the tests [here](/src/test/java/com/sendgrid/helpers/eventwebhook/EventWebhookTest.java).

If you are still having trouble getting the validation to work, follow the following instructions:
- Be sure to use the *raw* payload for validation
- Be sure to include a trailing carriage return and newline in your payload
- In case of multi-event webhooks, make sure you include the trailing newline and carriage return after *each* event

0 comments on commit 49e6895

Please sign in to comment.