如何为DocuSign信封添加自定义引用并关联自有数据库记录？

让ExternalEnvelopeId出现在Webhook通知中 #

DocuSign Connect（webhook）默认不会返回ExternalEnvelopeId，你需要在webhook配置中主动开启该字段的返回：

• 登录DocuSign管理后台，进入Connect模块，找到你的webhook订阅并编辑
• 在「包含的数据」区域，勾选自定义字段选项；若使用自定义输出格式（XML/JSON），需明确将externalEnvelopeId加入返回字段列表
• 若通过API配置webhook，创建ConnectConfig对象时，设置includeCustomFields为true，或在eventData中指定包含externalEnvelopeId

确认创建信封时正确赋值该属性，以C# SDK为例：

var envelopeDefinition = new EnvelopeDefinition
{
    ExternalEnvelopeId = "你的数据库记录ID",
    // 其他信封配置项
};

替代方案：使用自定义信封字段 #

如果上述方法无法生效，可通过自定义信封字段存储你的数据库ID，webhook通知会自动包含这些字段：

• 创建信封时添加一个文本类型的自定义字段，命名如internal_record_id，值设为你的数据库记录ID，并设置为不显示给签署人
• webhook返回的内容中，该字段会出现在customFields节点下

示例（C# SDK）：

var customFields = new CustomFields
{
    TextCustomFields = new List<TextCustomField>
    {
        new TextCustomField
        {
            Name = "internal_record_id",
            Value = "你的数据库记录ID",
            Show = false,
            Required = false
        }
    }
};
envelopeDefinition.CustomFields = customFields;

额外提示 #

• 确保webhook订阅了所有需要的信封状态事件（如completed、declined）
• 可使用DocuSign Connect调试工具验证通知内容，确认字段是否正确返回

内容的提问来源于stack exchange，提问作者Hilton Giesenow