There's a very convenient table in the Event Webhook Reference that lists the properties you can expect for each type of webhook event. However, there seem to be some errors in the table that I would like to clear up. For instance:
ip attribute is valid only for the opened and clicked events but the description of this attribute says: the IP address used to send the email. For open and click events, it is the IP address of the recipient who engaged with the email. This leads me to believe the IP attribute is valid for all event types. Am I right?tls field is not indicated as valid for any of the event types. Surely that's not correct.cc @ksigler7
@thinkingserious is there any updates on this?
@SendGridDX
Why is this still an issue ?
The SMTP-ID in the table still says not available for open/click etc, but the example above it and the webhook test post both provide the smtp-id for all events. Do I seriously have to add SMTP-ID as a unique argument to outgoing mail just to be sure ill get access to it on all webhook events ?
The issue is 18months old it should not take that long to figure out which part needs correcting.
I just tested on a real email with https://webhook.site/ as the post destination, and clicks do not send the smtp-id ... so ill have to include it in the unique args for my purposes unfortunately so you need to fix both the documentation of the test data thats submitted when testing the webhook endpoint, or better yet, just include the message id on open/click just like everything else.
Closing in favor of https://github.com/sendgrid/docs/issues/4865
I'll attempt to bump that ticket internally.
Most helpful comment
In addition to above, there is some inconsistency between the event parser documents. There is an another chart where I can see
smtp-idis not applicable toopenandcloseevents whereas table referred by @Jericho shows thatsmtp-idis available to all events.