Getting Started

Get started fast #

The easiest way to evaluate webhookie is using docker.

Make sure you have docker installed on your system.

Download our docker-compose file and supporting keycloak files in this zip file.

Unpack the zip file to a new folder dedicated to webhookie.

Note Apple M1 users: the standard keycloak image in the docker compose file does not yet support the Apple M1 ARM based architecture. Therefore you need to replace the keycloak image inside the docker-compose (docker-compose.yml) file with wizzn/keycloak:14 (instead of: quay.io/keycloak/keycloak:14.0.0)

From the new folder issue the following command in your terminal.

 docker compose up

This will start the necessary containers to evaluate the product.

Using webhookie #

In your browser go to the webhookie developer portal http://localhost:4300.

An admin user has been set up for you with the following details:

  • username: webhookie_admin
  • password: passwd1

Login to webhookie when the server health indicator is green. The health indicator is the dot next to login. This will become green when the server and its dependencies are up.

Create a webhook API #

In the Webhooks section, you can create a new Webhook API.

When you create a new Webhook API you will see a preloaded ASYNC API specification called the Pet Store Events API. You can replace this or edit it to reflect your own Webhook API details. Alternatively, you can just publish the Pet Store Events API to get a feel for the product.

When you click Publish, the API will be available, to discover and subscribe, to any users within the consumer groups you selected.

For more information:

Setup a subscription #

Subscriptions are set up by your webhook consumers. They are self-managed subscriptions meaning that as an application provider you don’t have to lift a finger to help your subscribers integrate.

A subscription is created with the following steps

  1. Click Subscribe on the webhook you want to subscribe to
  2. Create Application – this application is a logical container for the callbacks associated with it. It should reflect the name of the application that hosts the callback.
  3. Create Callback – this is the actual callback URL details. In CE you can choose to secure your callback with a HMAC signature (if you need a few more security options check out our Enterprise edition).
  4. Save the Subscription
  5. Test the Subscription – Webhookie will send the example request body to your callback. If you get a 2XX response from your callback then you are good to proceed.
  6. Activate the Subscription – your callback will now start receiving traffic when the events occur.

For more information:

Publish an event #

There are two options to integrate your product or system with webhookie. These are:

  • AMQP – If you have RabbitMQ or any other message bus within your architecture you can use it to send events to webhookie. See AMQP Setup.
  • API – If you don’t have a message bus within your architecture then we have a simple REST API to post events to webhookie. See API integration.

If you want to quickly evaluate the product, without integrating, you can use an API client like Postman to publish events to webhookie.

To publish an event to webhookie requires two steps. The first to get an access token and the second to post the event.

  1. Get a token to publish events to webhookie
POST /auth/realms/webhookie/protocol/openid-connect/token 
HTTP/1.1
Host: localhost:8800
Authorization: Basic d2ViaG9va2llX2NsaWVudDo=
Content-Type: application/x-www-form-urlencoded

username=webhookie_admin&password=passwd1&grant_type=password

2. Publish an event (Note: we are publishing a createdPet event – see the wh-topic header).

POST /ingress/event 
HTTP/1.1
Host: localhost:8000
wh-topic: createdPet
wh-trace-id: 7b338cb9-bb17-4aee-9cc9-705af28a1cf9
Content-Type: text/plain
Authorization: Bearer

Your test message

You can download a Postman script with the above two API requests below (note: you must extract the json file from the zip file before you import it into Postman).

View Traffic #

If you navigate to Traffic in the webhookie developer portal you can see the traffic being sent to your subscription.

What’s next? #

Now that you have evaluated webhookie you can take the next steps which include:

Powered by BetterDocs