feat(webhooks): Adding event search option in the webhooks page by VenuMadhav2541 · Pull Request #9907 · juspay/hyperswitch

VenuMadhav2541 · 2025-10-17T08:38:08Z

Type of Change

Description

Added search functionality in the WebHooks page to allow filtering events using event_id.
Users can now quickly locate specific webhook events without manually scrolling through the list.
Search supports filtering alongside existing primary object ID filters.

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

Previously, users could not search webhooks directly by event_id, making it difficult to debug or verify individual events.
This feature improves usability and helps developers trace and identify webhook activities more efficiently.

How did you test it?

Total list:

curl 'http://localhost:9000/api/events/profile/list' \
  -H 'Accept: */*' \
  -H 'Accept-Language: en-US,en;q=0.9' \
  -H 'Connection: keep-alive' \
  -H 'Content-Type: application/json' \
  -b 'login_token=****' \
  -H 'Origin: http://localhost:9000' \
  -H 'Referer: http://localhost:9000/dashboard/webhooks' \
  -H 'Sec-Fetch-Dest: empty' \
  -H 'Sec-Fetch-Mode: cors' \
  -H 'Sec-Fetch-Site: same-origin' \
  -H 'User-Agent: ****' \
  -H 'X-Merchant-Id: ****' \
  -H 'X-Profile-Id: ****' \
  -H 'api-key: ****' \
  -H 'authorization: Bearer ****' \
  -H 'sec-ch-ua: ****' \
  -H 'sec-ch-ua-mobile: ****' \
  -H 'sec-ch-ua-platform: ****' \
  --data-raw '{"start_time":"****","limit":50,"offset":0,"created_after":"****","created_before":"****"}'

Response:

{
    "events": [
        {
            "event_id": "evt_300000000000000000000000000000002",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000002",
            "event_type": "payment_failed",
            "event_class": "payments",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000002",
            "created": "2025-10-16T11:05:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000016",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000005",
            "event_type": "dispute_challenged",
            "event_class": "disputes",
            "is_delivery_successful": false,
            "initial_attempt_id": "evt_300000000000000000000000000000016",
            "created": "2025-10-15T13:15:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000001",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000005",
            "event_type": "payment_succeeded",
            "event_class": "payments",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000001",
            "created": "2025-10-15T10:00:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000015",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "dp_30000015",
            "event_type": "dispute_cancelled",
            "event_class": "disputes",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000015",
            "created": "2025-09-29T12:10:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000013",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "dp_30000013",
            "event_type": "dispute_expired",
            "event_class": "disputes",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000013",
            "created": "2025-09-27T10:00:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000012",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "dp_30000012",
            "event_type": "dispute_opened",
            "event_class": "disputes",
            "is_delivery_successful": false,
            "initial_attempt_id": "evt_300000000000000000000000000000012",
            "created": "2025-09-26T21:55:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000027",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "dp_30000027",
            "event_type": "dispute_opened",
            "event_class": "disputes",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000027",
            "created": "2025-09-26T12:10:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000011",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "rfnd_30000011",
            "event_type": "refund_failed",
            "event_class": "refunds",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000011",
            "created": "2025-09-25T20:50:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000026",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_30000026",
            "event_type": "payment_captured",
            "event_class": "payments",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000026",
            "created": "2025-09-25T11:05:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000010",
            "merchant_id": "merchant_dummy",
            "profile_id": "pro_dummy",
            "object_id": "rfnd_30000010",
            "event_type": "refund_succeeded",
            "event_class": "refunds",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000010",
            "created": "2025-09-24T19:45:00.000Z"
        }
    ],
    "total_count": 24
}

Search by event_id

curl 'http://localhost:9000/api/events/profile/list' \
  -H 'Accept: */*' \
  -H 'Accept-Language: en-US,en;q=0.9' \
  -H 'Connection: keep-alive' \
  -H 'Content-Type: application/json' \
  -b 'login_token=****' \
  -H 'Origin: http://localhost:9000' \
  -H 'Referer: http://localhost:9000/dashboard/webhooks' \
  -H 'Sec-Fetch-Dest: empty' \
  -H 'Sec-Fetch-Mode: cors' \
  -H 'Sec-Fetch-Site: same-origin' \
  -H 'User-Agent: ****' \
  -H 'X-Merchant-Id: ****' \
  -H 'X-Profile-Id: ****' \
  -H 'api-key: ****' \
  -H 'authorization: Bearer ****' \
  -H 'sec-ch-ua: ****' \
  -H 'sec-ch-ua-mobile: ****' \
  -H 'sec-ch-ua-platform: ****' \
  --data-raw '{"object_id":"evt_300000000000000000000000000000002","event_id":"evt_300000000000000000000000000000002"}'

Response

{
    "events": [
        {
            "event_id": "evt_300000000000000000000000000000002",
            "merchant_id": "mer_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000002",
            "event_type": "payment_failed",
            "event_class": "payments",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000002",
            "created": "2025-10-16T11:05:00.000Z"
        }
    ],
    "total_count": 1
}

Search by Profile ID:

curl 'http://localhost:9000/api/events/profile/list' \
  -H 'Accept: */*' \
  -H 'Accept-Language: en-US,en;q=0.9' \
  -H 'Connection: keep-alive' \
  -H 'Content-Type: application/json' \
  -b 'login_token=****' \
  -H 'Origin: http://localhost:9000' \
  -H 'Referer: http://localhost:9000/dashboard/webhooks' \
  -H 'Sec-Fetch-Dest: empty' \
  -H 'Sec-Fetch-Mode: cors' \
  -H 'Sec-Fetch-Site: same-origin' \
  -H 'User-Agent: ****' \
  -H 'X-Merchant-Id: ****' \
  -H 'X-Profile-Id: ****' \
  -H 'api-key: ****' \
  -H 'authorization: Bearer ****' \
  -H 'sec-ch-ua: ****' \
  -H 'sec-ch-ua-mobile: ****' \
  -H 'sec-ch-ua-platform: ****' \
  --data-raw '{"object_id":"pay_3000005","event_id":"pay_3000005"}'

Response

{
    "events": [
        {
            "event_id": "evt_300000000000000000000000000000016",
            "merchant_id": "mer_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000005",
            "event_type": "dispute_challenged",
            "event_class": "disputes",
            "is_delivery_successful": false,
            "initial_attempt_id": "evt_300000000000000000000000000000016",
            "created": "2025-10-15T13:15:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000001",
            "merchant_id": "mer_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000005",
            "event_type": "payment_succeeded",
            "event_class": "payments",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000001",
            "created": "2025-10-15T10:00:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000005",
            "merchant_id": "mer_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000005",
            "event_type": "payment_partially_authorized",
            "event_class": "payments",
            "is_delivery_successful": true,
            "initial_attempt_id": "evt_300000000000000000000000000000005",
            "created": "2025-09-19T14:20:00.000Z"
        },
        {
            "event_id": "evt_300000000000000000000000000000004",
            "merchant_id": "mer_dummy",
            "profile_id": "pro_dummy",
            "object_id": "pay_3000005",
            "event_type": "payment_cancelled",
            "event_class": "payments",
            "is_delivery_successful": false,
            "initial_attempt_id": "evt_300000000000000000000000000000004",
            "created": "2025-09-18T13:15:00.000Z"
        }
    ],
    "total_count": 4
}

Verified the WebHooks page manually by searching with multiple event_ids.
Verified combination searches with primary_object_id and event_id.
Ensured pagination, filters, and UI remain consistent.
Confirmed proper handling for invalid or non-existent event_id.

Where to test it?

INTEG
SANDBOX
PROD

Checklist

I formatted the code
I reviewed the submitted code
I verified the UI and API integration for event_id search
I added/updated relevant tests where possible

semanticdiff-com · 2025-10-17T08:38:12Z

Review changes with

Changed Files

File	Status
crates/router/src/core/webhooks/webhook_events.rs	90% smaller
crates/diesel_models/src/query/events.rs	70% smaller
crates/router/src/types/transformers.rs	41% smaller
api-reference/v1/openapi_spec_v1.json	0% smaller
crates/api_models/src/webhook_events.rs	0% smaller
crates/router/src/db/events.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller

apoorvdixit88

LGTM

apoorvdixit88 · 2025-10-17T10:43:24Z

                message:
-                    "Either only `object_id` must be specified, or one or more of \
-                          `created_after`, `created_before`, `limit`, `offset`, `event_classes` and `event_types` must be specified"
+                     "Either only `object_id` / `event_id` must be specified, or one or more of \


"Either only 'object_id' or 'event_id; must be specified

apoorvdixit88 · 2025-10-17T10:45:13Z

    /// Refund ID, etc.)
    pub object_id: Option<String>,

+    // Filter all events associated with the specified Event_id


please use documentation comment, that will update the description in openapi_spec.json, thats why its null right now , use triple ///

SanchithHegde · 2025-10-24T18:25:16Z

+            (Some(object_id), None) => Ok(Self::ObjectIdFilter {
+                event_id: object_id.clone(),
+                object_id,
+            }),
+
+            (None, Some(event_id)) => Ok(Self::ObjectIdFilter {
+                object_id: event_id.clone(),
+                event_id,
+            }),


Why are we passing object ID as event ID and vice-versa? Won't this slow down the database queries significantly?

…ay#9907) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

feat(webhooks): Adding event search option in the webhooks page

fef8ddc

VenuMadhav2541 requested review from a team as code owners October 17, 2025 08:38

VenuMadhav2541 self-assigned this Oct 17, 2025

chore: run formatter

720938c

VenuMadhav2541 added the C-feature Category: Feature request or enhancement label Oct 17, 2025

VenuMadhav2541 linked an issue Oct 17, 2025 that may be closed by this pull request

[FEATURE] : Add filtering by event_id in WebHooks page #9904

Closed

2 tasks

docs(openapi): re-generate OpenAPI specification

d91dfbf

hyperswitch-bot Bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Oct 17, 2025

apoorvdixit88 reviewed Oct 17, 2025

View reviewed changes

VenuMadhav2541 and others added 2 commits October 18, 2025 10:54

Comment formating as per the Document

f2eb948

docs(openapi): re-generate OpenAPI specification

87c98bf

sai-harsha-vardhan reviewed Oct 23, 2025

View reviewed changes

Comment thread crates/api_models/src/webhook_events.rs

Comment thread crates/diesel_models/src/query/events.rs

sai-harsha-vardhan approved these changes Oct 23, 2025

View reviewed changes

apoorvdixit88 approved these changes Oct 23, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Oct 24, 2025

Merged via the queue into main with commit b0d5a1b Oct 24, 2025
27 of 30 checks passed

likhinbopanna deleted the webhook_filters branch October 24, 2025 08:52

SanchithHegde reviewed Oct 24, 2025

View reviewed changes

drdholu pushed a commit to drdholu/hyperswitch that referenced this pull request Oct 30, 2025

feat(webhooks): Adding event search option in the webhooks page (jusp…

3d981b9

…ay#9907) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

aadityaguptaa pushed a commit that referenced this pull request Nov 10, 2025

feat(webhooks): Adding event search option in the webhooks page (#9907)

dbfa086

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(webhooks): Adding event search option in the webhooks page#9907

feat(webhooks): Adding event search option in the webhooks page#9907
likhinbopanna merged 5 commits into
mainfrom
webhook_filters

VenuMadhav2541 commented Oct 17, 2025

Uh oh!

semanticdiff-com Bot commented Oct 17, 2025 •

edited

Loading

Uh oh!

apoorvdixit88 left a comment

Uh oh!

apoorvdixit88 Oct 17, 2025

Uh oh!

apoorvdixit88 Oct 17, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SanchithHegde Oct 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

VenuMadhav2541 commented Oct 17, 2025

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Where to test it?

Checklist

Uh oh!

semanticdiff-com Bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apoorvdixit88 left a comment

Choose a reason for hiding this comment

Uh oh!

apoorvdixit88 Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

apoorvdixit88 Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SanchithHegde Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

semanticdiff-com Bot commented Oct 17, 2025 •

edited

Loading