Fix: Webhook responses, event info on context, internal fix for labels matches (#3625)

* feat: add boolean flag for whether or not to return the event as the response payload

* feat: add field to indicate whether or not to return the event

* fix: wire up receive api

* feat: more columns for event trigger idea

* feat: start wiring up queries

* feat: internal wiring

* fix: matches, more wiring

* fix: simplify query

* fix: more wiring

* fix: clean up dag impl for worker labels too

* fix: wiring, unwind dag changes

* fix: if

* feat: add webhook response switch on fe

* fix: casing

* fix: populator

* feat: add fields to assigned action for trigger

* feat: send trigger data back over the api to the context

* chore: gen py

* feat: wire up context in py

* feat: update webhooks feature client

* feat: ts, go

* chore: lint

* fix: more wiring for replay

* fix: nil handling

* chore: gen

* chore: attempt to fix flaky test

* feat: wire up olap writes

* fix: rm changes on the olap side for now

* fix: improve the `was_triggered_by_event` prop

* chore: gen, fix migration version

* chore: versions, changelogs

Author: mrkaye97

api-contracts/dispatcher/dispatcher.proto

@@ -189,6 +189,12 @@ message AssignedAction {
 
     // (optional) the invocation count for durable task events (required for durable events, otherwise null)
     optional int32 durable_task_invocation_count = 21;
+
+    // (optional) the external id of the event that triggered this workflow run (if any)
+    optional string triggering_event_external_id = 22;
+
+    // (optional) the key of the event that triggered this workflow run (if any)
+    optional string triggering_event_key = 23;
 }
 
 message WorkerListenRequest {

api-contracts/openapi/components/schemas/v1/webhook.yaml

@@ -23,6 +23,9 @@ V1Webhook:
     authType:
       $ref: "#/V1WebhookAuthType"
       description: The type of authentication to use for the webhook
+    returnEventAsResponsePayload:
+      type: boolean
+      description: Whether to return the triggered event as the response payload when this webhook is triggered
   required:
     - metadata
     - tenantId
@@ -141,6 +144,9 @@ V1CreateWebhookRequestBase:
     staticPayload:
       type: object
       description: The static payload to use for the webhook. This is used to send a static payload with the webhook.
+    returnEventAsResponsePayload:
+      type: boolean
+      description: Whether to return the triggered event as the response payload when this webhook is triggered
   required:
     - name
     - sourceName
@@ -212,6 +218,9 @@ V1UpdateWebhookRequest:
     staticPayload:
       type: object
       description: The static payload to use for the webhook. This is used to send a static payload with the webhook.
+    returnEventAsResponsePayload:
+      type: boolean
+      description: Whether to return the triggered event as the response payload when this webhook is triggered
 
 V1WebhookResponse:
   type: object

api/v1/server/handlers/v1/webhooks/create.go

@@ -130,6 +130,7 @@ func (w *V1WebhooksService) constructCreateOpts(tenantId uuid.UUID, request gen.
 		params.Name = basicAuth.Name
 		params.Eventkeyexpression = basicAuth.EventKeyExpression
 		params.ScopeExpression = basicAuth.ScopeExpression
+		params.ReturnEventAsResponsePayload = returnEventResponsePayloadOrDefault(basicAuth.ReturnEventAsResponsePayload)
 		if basicAuth.StaticPayload != nil {
 			payloadBytes, err := json.Marshal(basicAuth.StaticPayload)
 			if err != nil {
@@ -165,6 +166,7 @@ func (w *V1WebhooksService) constructCreateOpts(tenantId uuid.UUID, request gen.
 		params.Name = apiKeyAuth.Name
 		params.Eventkeyexpression = apiKeyAuth.EventKeyExpression
 		params.ScopeExpression = apiKeyAuth.ScopeExpression
+		params.ReturnEventAsResponsePayload = returnEventResponsePayloadOrDefault(apiKeyAuth.ReturnEventAsResponsePayload)
 		if apiKeyAuth.StaticPayload != nil {
 			payloadBytes, err := json.Marshal(apiKeyAuth.StaticPayload)
 			if err != nil {
@@ -200,6 +202,7 @@ func (w *V1WebhooksService) constructCreateOpts(tenantId uuid.UUID, request gen.
 		params.Name = hmacAuth.Name
 		params.Eventkeyexpression = hmacAuth.EventKeyExpression
 		params.ScopeExpression = hmacAuth.ScopeExpression
+		params.ReturnEventAsResponsePayload = returnEventResponsePayloadOrDefault(hmacAuth.ReturnEventAsResponsePayload)
 		if hmacAuth.StaticPayload != nil {
 			payloadBytes, err := json.Marshal(hmacAuth.StaticPayload)
 			if err != nil {
@@ -214,3 +217,11 @@ func (w *V1WebhooksService) constructCreateOpts(tenantId uuid.UUID, request gen.
 
 	return params, nil
 }
+
+func returnEventResponsePayloadOrDefault(requestReturnEventAsResponsePayload *bool) bool {
+	if requestReturnEventAsResponsePayload == nil {
+		return true
+	}
+
+	return *requestReturnEventAsResponsePayload
+}

api/v1/server/handlers/v1/webhooks/receive.go

@@ -327,6 +327,10 @@ func (w *V1WebhooksService) V1WebhookReceive(ctx echo.Context, request gen.V1Web
 		return nil, fmt.Errorf("failed to ingest event")
 	}
 
+	if !webhook.ReturnEventAsResponsePayload {
+		ev = nil
+	}
+
 	res, err := transformers.ToV1WebhookResponse(repository.StringPtr("ok"), nil, ev)
 	if err != nil {
 		return nil, fmt.Errorf("failed to transform response: %w", err)

api/v1/server/handlers/v1/webhooks/update.go

@@ -16,8 +16,9 @@ func (w *V1WebhooksService) V1WebhookUpdate(ctx echo.Context, request gen.V1Webh
 	webhook := ctx.Get("v1-webhook").(*sqlcv1.V1IncomingWebhook)
 
 	opts := repository.UpdateWebhookOpts{
-		EventKeyExpression: request.Body.EventKeyExpression,
-		ScopeExpression:    request.Body.ScopeExpression,
+		EventKeyExpression:           request.Body.EventKeyExpression,
+		ScopeExpression:              request.Body.ScopeExpression,
+		ReturnEventAsResponsePayload: request.Body.ReturnEventAsResponsePayload,
 	}
 
 	if request.Body.StaticPayload != nil {

api/v1/server/oas/gen/openapi.gen.go

@@ -22,10 +22,11 @@ func ToV1Webhook(webhook *sqlcv1.V1IncomingWebhook) gen.V1Webhook {
 			UpdatedAt: webhook.UpdatedAt.Time,
 			Id:        id.String(),
 		},
-		TenantId:           webhook.TenantID.String(),
-		EventKeyExpression: webhook.EventKeyExpression,
-		Name:               webhook.Name,
-		SourceName:         gen.V1WebhookSourceName(webhook.SourceName),
+		TenantId:                     webhook.TenantID.String(),
+		EventKeyExpression:           webhook.EventKeyExpression,
+		Name:                         webhook.Name,
+		SourceName:                   gen.V1WebhookSourceName(webhook.SourceName),
+		ReturnEventAsResponsePayload: &webhook.ReturnEventAsResponsePayload,
 	}
 
 	if webhook.ScopeExpression.Valid {

api/v1/server/oas/transformers/v1/webhooks.go

@@ -0,0 +1,29 @@
+-- +goose Up
+-- +goose StatementBegin
+ALTER TABLE v1_incoming_webhook ADD COLUMN return_event_as_response_payload BOOLEAN NOT NULL DEFAULT TRUE;
+ALTER TABLE v1_task
+    ADD COLUMN triggering_event_external_id UUID,
+    ADD COLUMN triggering_event_key TEXT
+;
+
+ALTER TABLE v1_match
+    ADD COLUMN trigger_event_external_id UUID,
+    ADD COLUMN trigger_event_key TEXT,
+    ADD COLUMN trigger_desired_worker_labels JSONB
+;
+-- +goose StatementEnd
+
+-- +goose Down
+-- +goose StatementBegin
+ALTER TABLE v1_incoming_webhook DROP COLUMN return_event_as_response_payload;
+ALTER TABLE v1_task
+    DROP COLUMN triggering_event_external_id,
+    DROP COLUMN triggering_event_key
+;
+
+ALTER TABLE v1_match
+    DROP COLUMN trigger_event_external_id,
+    DROP COLUMN trigger_event_key,
+    DROP COLUMN trigger_desired_worker_labels
+;
+-- +goose StatementEnd

cmd/hatchet-migrate/migrate/migrations/20260421184231_v1_0_98.sql

@@ -1122,6 +1122,8 @@ export interface V1Webhook {
   staticPayload?: object;
   /** The type of authentication to use for the webhook */
   authType: V1WebhookAuthType;
+  /** Whether to return the triggered event as the response payload when this webhook is triggered */
+  returnEventAsResponsePayload?: boolean;
 }
 
 export interface V1WebhookList {
@@ -1140,6 +1142,8 @@ export interface V1CreateWebhookRequestBase {
   scopeExpression?: string;
   /** The static payload to use for the webhook. This is used to send a static payload with the webhook. */
   staticPayload?: object;
+  /** Whether to return the triggered event as the response payload when this webhook is triggered */
+  returnEventAsResponsePayload?: boolean;
 }
 
 export interface V1WebhookBasicAuth {
@@ -1204,6 +1208,8 @@ export interface V1UpdateWebhookRequest {
   scopeExpression?: string;
   /** The static payload to use for the webhook. This is used to send a static payload with the webhook. */
   staticPayload?: object;
+  /** Whether to return the triggered event as the response payload when this webhook is triggered */
+  returnEventAsResponsePayload?: boolean;
 }
 
 export interface V1CELDebugRequest {

frontend/app/src/lib/api/generated/data-contracts.ts

@@ -105,6 +105,7 @@ export const webhookFormSchema = z.object({
   eventKeyExpression: z.string().min(1, 'Event key expression is required'),
   scopeExpression: z.string().optional(),
   staticPayload: optionalJsonString,
+  returnEventAsResponsePayload: z.boolean().optional(),
   authType: z.nativeEnum(V1WebhookAuthType),
   username: z.string().optional(),
   password: z.string().optional(),
@@ -122,6 +123,7 @@ export const webhookUpdateFormSchema = z.object({
   eventKeyExpression: z.string().min(1, 'Event key expression is required'),
   scopeExpression: z.string().optional(),
   staticPayload: optionalJsonString,
+  returnEventAsResponsePayload: z.boolean().optional(),
 });
 
 export type WebhookUpdateFormData = z.infer<typeof webhookUpdateFormSchema>;