Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Support fully customizable webhook signature header name (not just prefix)

未关闭
  • 哪里不对？
#982 13 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@ambroziepaval 已经在做这个了。

开始于 2026年7月6日。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
65/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
go
领域
backend-api-design

调研方向

Start with contributing/config.md and trace the signature-header construction in the default and standard webhook providers. Check the existing configuration-field workflow, including defaults, validation, configuration summary, and generated docs. Done means a configured full header name is used in both modes, while an unset value preserves current behavior.

由索引模型根据 Issue 内容生成。

描述

enhancement

Is your feature request related to a problem? Please describe.
We're planning to migrate our webhook infrastructure to Outpost. We already have thousands of integrated clients receiving webhooks from us today, and our existing contract with them specifies a fixed signature header name that does not use the -signature suffix. For example, something like x-acme-digest.

Today, DESTINATIONS_WEBHOOK_HEADER_PREFIX lets us customize the header prefix (e.g. x-acme-), but the suffix signature is hardcoded, so we can only ever produce x-acme-signature.

Because we already have an established contract with our clients, we can't ask them all to change the header they read. To make the migration to Outpost as seamless as possible (ideally zero client-side changes), we need to emit the signature under our existing header name.

Describe the solution you'd like
Make the signature header name fully customizable, not just the prefix. Something like:

A new field on DestinationWebhookConfig, e.g. DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_NAME.
When set, this value is used as the complete signature header name, bypassing the <prefix>signature construction entirely. When unset, behavior is unchanged (defaults to signature), so this is fully backwards compatible.
Example: with DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_NAME=x-acme-digest, the delivered header would be exactly x-acme-digest regardless of the configured prefix.
The key point is control over the entire header name. The prefix option only covers part of the naming; consumers with an existing, fixed header contract need to pin the full name.

This mirrors the existing precedent where the signature value is already customizable via DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE: we'd simply be extending that same "make signatures interoperable with existing consumers" philosophy to the header name.

I'm happy to implement this and open a PR. I've traced the two call sites above and reviewed the config-field workflow in contributing/config.md (struct field + tags, defaults, LogConfigurationSummary(), validation, go generate for docs). I just wanted to align on the approach and naming before writing the code.

Describe alternatives you've considered

  • Custom headers: We can add arbitrary static headers per destination, but those carry static values. They can't carry the computed per-request signature, so this doesn't solve our case.
  • Header prefix only (DESTINATIONS_WEBHOOK_HEADER_PREFIX): Adjusting the prefix still leaves the mandatory signature suffix, producing x-acme-signature rather than x-acme-digest.
  • Post-processing/proxy layer to rename the header in flight: Adds operational complexity and an extra hop purely to rename one header; this is not viable at our scale.
  • Asking clients to update the header they validate: Not really feasible with thousands of existing integrations under contract.

Additional context

  • We'd want this to work in both default and standard webhook modes, since the suffix is hardcoded in both providers.
  • Backwards compatibility: unset config can preserve today's exact behavior.
主要语言
Go
星标
1.1k
派生
70
平均合并
1 天 18 小时
30 天内合并 PR
56

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

hookdeck/outpost 的其他 Issue

查看 hookdeck/outpost 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。