Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#982 13 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@ambroziepaval đang làm issue này rồi.

Từ ngày 6/7/2026.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
65/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
go
Lĩnh vực
backend-api-design

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Go
Star
1.1k
Fork
70
Merge trung bình
1 ngày 18 giờ
Pull request đã merge (30 ngày)
56

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của hookdeck/outpost

Tất cả issue của hookdeck/outpost

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.