如何在SendGrid邮件请求中传递自定义ID并在Webhook中接收?
解决SendGrid 6.10.0 SDK传递自定义ID到Webhook的问题
你的代码核心问题是直接覆盖了mail.headers,导致unique_args对应的SMTPAPI头被覆盖丢失。在SendGrid Python SDK v6中,需要通过官方提供的SMTPAPIHeader类来正确配置自定义参数,而非手动修改headers。
正确实现方式
- 导入
SMTPAPIHeader类,用于构建规范的SMTPAPI头信息 - 创建
SMTPAPIHeader实例,通过set_unique_args方法添加自定义键值对 - 将该实例绑定到
Mail对象的smtpapi属性,SDK会自动生成正确的X-SMTPAPI请求头 - 禁止手动覆盖
mail.headers,避免破坏SDK自动处理的头信息逻辑
修正后的代码
from sendgrid.helpers.mail import Mail, Email, To, Content, SMTPAPIHeader from_email = Email("contact@codingnap.com") to_email = To(email) subject = "Codingnap login" content = Content("text/plain", "OTP for login in codingnap is 548568") # 初始化SMTPAPI头并添加自定义参数 smtpapi_header = SMTPAPIHeader() smtpapi_header.set_unique_args({ 'custom_key': 'unique_value', 'user_id': '12345' # 可根据业务需求添加更多自定义字段 }) mail = Mail(from_email, to_email, subject, content) # 将SMTPAPI头绑定到邮件对象 mail.smtpapi = smtpapi_header response = self.sg.send(mail)
效果验证
发送邮件后,SendGrid事件Webhook返回的所有事件(如送达、打开、点击、退信等)payload中,都会包含unique_args字段,里面就是你设置的自定义键值对。Webhook无需额外配置,默认会自动携带这些参数。
内容的提问来源于stack exchange,提问作者Pankaj Singh Rana
相关产品推荐
相关产品推荐

