2
1 Comment

API documentation question

Let's say there's an API with multiple endpoints.
Some are simple CRUD, other like Publish or DoFoo.

In addition there are webhooks that you can register to, that will tell you about state change of the entities in the system.

When you register to a webhook, you get notification regardless of who made the call to some endpoint, or what exactly triggered the entity state change.

As a developer, is it important/useful for you to know which one of the endpoints will eventually trigger which webhook?

For example, is it useful to know that when someone calls Update endpoint it will eventually trigger Updated webhook, and when someone calls Publish, it will eventually trigger Updated and Published webhooks?

on May 24, 2022
  1. 1

    We are building an API unification framework. That requires us to listen to a wide variety of webhooks. This sounds like something useful for analytics and monitoring purposes.