Skip to content

feat: destination metadata & delivery_metadata #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: v0.8.0
merged 10 commits into from
Oct 21, 2025
Merged

feat: destination metadata & delivery_metadata #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6d3adfb
feat: add delivery_metadata and metadata fields to Destination model
alexluong Oct 17, 2025
8e2c41a
feat: add delivery_metadata and metadata fields to Destination model
alexluong Oct 17, 2025
a7d01ac
feat: encrypt delivery_metadata field
alexluong Oct 17, 2025
288db16
feat: add delivery_metadata and metadata fields to destination API
alexluong Oct 17, 2025
4c8c81f
feat: implement delivery_metadata merging in BasePublisher
alexluong Oct 18, 2025
8acafad
feat: add delivery_metadata support to all destination providers
alexluong Oct 18, 2025
f748248
test: verify delivery_metadata
alexluong Oct 18, 2025
e9b77b4
chore: update openapi.yaml
alexluong Oct 19, 2025
8c8f6bc
docs: document metadata & delivery_metadata
alexluong Oct 21, 2025
6e75ea4
Merge branch 'v0.7.1' of github.com:hookdeck/outpost into destination…
alexluong Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 174 additions & 2 deletions cmd/e2e/api_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,7 @@ func (suite *basicSuite) TestTenantsAPI() {
func (suite *basicSuite) TestDestinationsAPI() {
tenantID := idgen.String()
sampleDestinationID := idgen.Destination()
destinationWithMetadataID := idgen.Destination()
tests := []APITest{
{
Name: "PUT /:tenantID",
Expand Down Expand Up @@ -438,6 +439,177 @@ func (suite *basicSuite) TestDestinationsAPI() {
},
},
},
{
Name: "POST /:tenantID/destinations with delivery_metadata and metadata",
Request: suite.AuthRequest(httpclient.Request{
Method: httpclient.MethodPOST,
Path: "/" + tenantID + "/destinations",
Body: map[string]interface{}{
"id": destinationWithMetadataID,
"type": "webhook",
"topics": []string{"user.created"},
"config": map[string]interface{}{
"url": "http://host.docker.internal:4444",
},
"delivery_metadata": map[string]interface{}{
"X-App-ID": "test-app",
"X-Version": "1.0",
},
"metadata": map[string]interface{}{
"environment": "test",
"team": "platform",
},
},
}),
Expected: APITestExpectation{
Match: &httpclient.Response{
StatusCode: http.StatusCreated,
},
},
},
{
Name: "GET /:tenantID/destinations/:destinationID with delivery_metadata and metadata",
Request: suite.AuthRequest(httpclient.Request{
Method: httpclient.MethodGET,
Path: "/" + tenantID + "/destinations/" + destinationWithMetadataID,
}),
Expected: APITestExpectation{
Match: &httpclient.Response{
StatusCode: http.StatusOK,
Body: map[string]interface{}{
"id": destinationWithMetadataID,
"type": "webhook",
"topics": []string{"user.created"},
"config": map[string]interface{}{
"url": "http://host.docker.internal:4444",
},
"credentials": map[string]interface{}{},
"delivery_metadata": map[string]interface{}{
"X-App-ID": "test-app",
"X-Version": "1.0",
},
"metadata": map[string]interface{}{
"environment": "test",
"team": "platform",
},
},
},
},
},
{
Name: "PATCH /:tenantID/destinations/:destinationID update delivery_metadata",
Request: suite.AuthRequest(httpclient.Request{
Method: httpclient.MethodPATCH,
Path: "/" + tenantID + "/destinations/" + destinationWithMetadataID,
Body: map[string]interface{}{
"delivery_metadata": map[string]interface{}{
"X-Version": "2.0", // Overwrite existing value (was "1.0")
"X-Region": "us-east-1", // Add new key
},
// Note: X-App-ID not included, should be preserved from original
},
}),
Expected: APITestExpectation{
Match: &httpclient.Response{
StatusCode: http.StatusOK,
Body: map[string]interface{}{
"id": destinationWithMetadataID,
"type": "webhook",
"topics": []string{"user.created"},
"config": map[string]interface{}{
"url": "http://host.docker.internal:4444",
},
"credentials": map[string]interface{}{},
"delivery_metadata": map[string]interface{}{
"X-App-ID": "test-app", // PRESERVED: Not in PATCH request
"X-Version": "2.0", // OVERWRITTEN: Updated from "1.0"
"X-Region": "us-east-1", // NEW: Added by PATCH request
},
"metadata": map[string]interface{}{
"environment": "test",
"team": "platform",
},
},
},
},
},
{
Name: "PATCH /:tenantID/destinations/:destinationID update metadata",
Request: suite.AuthRequest(httpclient.Request{
Method: httpclient.MethodPATCH,
Path: "/" + tenantID + "/destinations/" + destinationWithMetadataID,
Body: map[string]interface{}{
"metadata": map[string]interface{}{
"team": "engineering", // Overwrite existing value (was "platform")
"region": "us", // Add new key
},
// Note: environment not included, should be preserved from original
},
}),
Expected: APITestExpectation{
Match: &httpclient.Response{
StatusCode: http.StatusOK,
Body: map[string]interface{}{
"id": destinationWithMetadataID,
"type": "webhook",
"topics": []string{"user.created"},
"config": map[string]interface{}{
"url": "http://host.docker.internal:4444",
},
"credentials": map[string]interface{}{},
"delivery_metadata": map[string]interface{}{
"X-App-ID": "test-app",
"X-Version": "2.0",
"X-Region": "us-east-1",
},
"metadata": map[string]interface{}{
"environment": "test", // PRESERVED: Not in PATCH request
"team": "engineering", // OVERWRITTEN: Updated from "platform"
"region": "us", // NEW: Added by PATCH request
},
},
},
},
},
{
Name: "GET /:tenantID/destinations/:destinationID verify merged fields",
Request: suite.AuthRequest(httpclient.Request{
Method: httpclient.MethodGET,
Path: "/" + tenantID + "/destinations/" + destinationWithMetadataID,
}),
Expected: APITestExpectation{
Match: &httpclient.Response{
StatusCode: http.StatusOK,
Body: map[string]interface{}{
"id": destinationWithMetadataID,
"type": "webhook",
"topics": []string{"user.created"},
"config": map[string]interface{}{
"url": "http://host.docker.internal:4444",
},
"credentials": map[string]interface{}{},
// Verify delivery_metadata merge behavior persists:
// - Original: {"X-App-ID": "test-app", "X-Version": "1.0"}
// - After PATCH 1: {"X-Version": "2.0", "X-Region": "us-east-1"}
// - Result: Preserved X-App-ID, overwrote X-Version, added X-Region
"delivery_metadata": map[string]interface{}{
"X-App-ID": "test-app",
"X-Version": "2.0",
"X-Region": "us-east-1",
},
// Verify metadata merge behavior persists:
// - Original: {"environment": "test", "team": "platform"}
// - After PATCH 2: {"team": "engineering", "region": "us"}
// - Result: Preserved environment, overwrote team, added region
"metadata": map[string]interface{}{
"environment": "test",
"team": "engineering",
"region": "us",
},
},
},
},
},
{
Name: "POST /:tenantID/destinations with duplicate ID",
Request: suite.AuthRequest(httpclient.Request{
Expand Down Expand Up @@ -468,7 +640,7 @@ func (suite *basicSuite) TestDestinationsAPI() {
Path: "/" + tenantID + "/destinations",
}),
Expected: APITestExpectation{
Validate: makeDestinationListValidator(2),
Validate: makeDestinationListValidator(3),
},
},
{
Expand Down Expand Up @@ -621,7 +793,7 @@ func (suite *basicSuite) TestDestinationsAPI() {
Path: "/" + tenantID + "/destinations",
}),
Expected: APITestExpectation{
Validate: makeDestinationListValidator(1),
Validate: makeDestinationListValidator(2),
},
},
}
Expand Down
Loading
Loading