API Reference

You can use webhook subscriptions to receive notifications about specific events in software. After subscribing to a webhook using topic and software, your application can run code immediately when certain events occur in CRM systems, e-commerce, ERP, or others that have your application installed, eliminating the need to periodically make API calls to check their status.

How does it work?

The following example uses the orders/create webhook topic for Shopify software, in this case we send a notification when an order is create in the ecoomerce of your customer.

In this case, your app subscribe to the orders/create topic and select the software in our webhook service trough the clientId of your customer.
The app specifies an endpoint to receive webhooks for the orders/create topic and the software. For example, this may be an HTTPS endpoint hosted by the app server. This endpoint is where the app listens for webhooks.
Suppose now that an order is created from that shop of your customer, this triggers a webhook to be published to the orders/create topic. Konvex sends that webhook, which includes headers and an order payload, to the specified subscription endpoint.