search

bigcommerce / docs

The open source docs home for BigCommerce, including API specifications in OAS YAML and narrative docs in MDX
https://developer.bigcommerce.com
10 stars 19 forks source link

Feedback for “Webhook Events”, Get Events #300

Closed cjbarth closed 1 month ago

cjbarth commented 1 month ago

https://developer.bigcommerce.com/docs/webhooks/webhooks/webhook-events#get-events is listed as deprecated, but there is no note about what the replacement or alternative is.

bc-traciporter commented 1 month ago

Hello @cjbarth I don't think there is a replacement. But, I will reach out to the development team and try to find out more information.

bc-traciporter commented 1 month ago

Hi @cjbarth I learned this endpoint should have never been posted to our public docs. Also, this endpoint never worked as expected, and the feature to utilize it was never fully implemented, so there is no need to replace it.

cjbarth commented 1 month ago

In that case, you can't just mark it deprecated. That API looks very useful for something I want to do, but if it is broken, never worked, and shouldn't be used, it should have a little stronger warning on it. It should probably have its return adjusted to always return a 5xx error.

bc-traciporter commented 1 month ago

Thank you @cjbarth for reminding us, we have plans to mark it as deprecated. I will take care of this shortly.

bc-traciporter commented 1 month ago

@cjbarth sorry, I didn't read your message closely. I will work with the development team to determine the best way to address this issue.

bc-traciporter commented 1 month ago

Hello @cjbarth I created a PR to add in the replacement for this endpoint. See PR 309.