Skip to content
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.

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

Webhooks: Show Endpoint URL in event log table #4466

Open
birkjernstrom opened this issue Nov 13, 2024 · 6 comments
Open

Webhooks: Show Endpoint URL in event log table #4466

birkjernstrom opened this issue Nov 13, 2024 · 6 comments
Labels
contributor friendly Good entry point for potential new contributors enhancement Enhancement of existing features and services ui Changes to our UI alone, i.e no backend changes needed

Comments

@birkjernstrom
Copy link
Member

Description

Show the endpoint url we send webhooks to in the log. Helpful confirmation & for debugging of which endpoint received a given webhook.

@birkjernstrom
Copy link
Member Author

@MustaphaHamida Shared this on Discord (let's continue the discussion there), but the URL provided above on your end responds with a HTTP 307 /signup redirect. Probably some authentication middleware that protects the route that you need to configure/change to allow the endpoint to be publicly available, but using our webhook secrets & validating the signature for security.

$ curl -vvv -X POST https://app.ranklly.com/api/webhook/polar

... redacted... 
< HTTP/2 307
< date: Wed, 13 Nov 2024 20:46:22 GMT
< location: /signup
< server: railway-edge
< x-railway-request-id: xTi5qLIBSj6Q9QY9ragzbQ_3500563535
<
* Connection #0 to host app.ranklly.com left intact
/signup%```

@birkjernstrom birkjernstrom added enhancement Enhancement of existing features and services ui Changes to our UI alone, i.e no backend changes needed contributor friendly Good entry point for potential new contributors labels Nov 13, 2024
@smokyabdulrahman
Copy link

@birkjernstrom I can take this up

@smokyabdulrahman
Copy link

server part should be ready for review: #4802 🙏

@smokyabdulrahman
Copy link

smokyabdulrahman commented Jan 7, 2025

I am starting to feel that I am heading towards the wrong direction.
I would love some clarification of what is needed?

My understanding is that we need to show for each webhook delivery the endpoint that that webhook attempted to call.
However, in the WebhookDelivery model, we only have a foreign key to WebhookEndpoint.
This means if someone updates a WebhookEndpoint, we wouldn't know old WebhookDeliveries called which endpoint.

Thus, we need to add a column to WebhookDelivery to store the endpoint that was called at that point of time.

Second part, showing that in the UI, how do you want to show that? (Example photo attached)

  1. show it as a new column in the deliveries table in the UI
  2. show it in the details section of the delivery (after clicking on a row in the table - it expands to show extra info including the webhook endpoint that we are going to add)
Screenshot 2025-01-07 at 17 17 48

@smokyabdulrahman
Copy link

I would appreciate an update regarding the wanted direction for this issue 🙏

@smokyabdulrahman
Copy link

Any update on this issue is much appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor friendly Good entry point for potential new contributors enhancement Enhancement of existing features and services ui Changes to our UI alone, i.e no backend changes needed
Projects
Status: No status
Development

No branches or pull requests

2 participants