Developer Experience

What is developer experience? #

Developer experience (DX) is the sum of interactions and feelings the developer has when trying to achieve their goal on your product.

When relating DX to webhookie, it’s how quickly and easily a developer can set up and manage a subscription to your webhooks.

With webhookie you have the option to use our REST API to develop your own DX or we have built a simple developer portal that has some limited options to white label.

Develop your own DX #

All the interactions that are available in the webhookie developer portal are implemented using the webhookie REST API.

In addition, there are a number of endpoints and options in the APIs that you can take advantage of which are not available in the developer portal.

The webhookie REST API documentation is available as swagger documentation.

Your DX could be as simple as including the webhookie REST API documentation alongside your existing REST API documentation, letting your API consumers subscribe via the API or it could also provide a simple UI to enable them to set up a subscription directly in your portal similar to the webhookie developer portal.

Developer portal #

The developer portal provides an experience that allows developers to set up and manage their subscriptions via a user interface. This means the developers don’t have to write their own code or use an API client to set up a subscription (which is often a one-time activity).

The developer portal has limited options to white label. These include the logo, brand colour, tag line, and hero image among a few others. To learn more about white labeling read here.

Ideas on how to incorporate the developer portal into your products UX include:

  • Having a landing page that introduces your developers to your REST APIs and your webhook APIs. With each you have a call to action to go to the respective developer portals.

OR

  • In your REST API documentation include the webhookie REST API documentation with additional text and a link to the webhookie developer portal to give your developers the ability to setup a subscription using a UI instead of the API.
Example of a DX using the REST API documentation with a link to your instance of the webhookie developer portal.

Note REST APIs and webhook APIs are often used in completely different use cases. REST APIs are often used when building a digital product with a UX. While webhook APIs are often used for backend integration to synchronize and automate processes between systems. Therefore providing two experiences for your REST APIs and webhook APIs can make a lot of sense.

Learn More #

Read about:

Powered by BetterDocs