Definition

A webhook is an automatic HTTP request, sometimes called a "reverse API," that is activated by an event in one system and sends data to another system. Unlike standard APIs that need a request to start sending data, a webhook immediately transmits information when an event happens, enabling quick communication and data sharing between systems. This feature makes webhooks an efficient tool for real-time alerts and updates across connected web services.

Why Webhook?

Once you register or subscribe to the webhook, Appliance Data will automatically transmit real-time event data to your application's webhook endpoint as activities occur within your account.
Appliance Data will transmit webhook events to your application in the form of a JSON payload containing an Event object. Appliance Data is valuable for updating product statuses, pricing, LCP details, and information on newly released products.

How to Use Webhook

To begin accepting webhook events in your application, set up and register a webhook endpoint as follows:

1 - Develop a handler for your webhook endpoint to process incoming POST requests with event data.

When setting up webhook requests, use the POST method. For local development, it's acceptable to use HTTP for your webhook endpoint. However, once your endpoint is published, you should switch to HTTPS to ensure security.

Why should you set up your endpoint function?
POST requests can be handled with a JSON payload which consists of event objects.
Returning a successful 200 response.

2 - Add your endpoint by contacting Appliance Data support.

Register the webhook endpoint’s URL by asking for authorization from Appliance Data support. One client can register one webhook endpoint and there will be four types of webhooks. Use each type based on your company’s needs. You can register the endpoints using HTTPS URLs.

Webhook URL format
The URL format to register a webhook endpoint is:

'client-website.com'/the-webhook-endpoint

For instance,
Domain -> https://companywebsite.com
Route to your webhook endpoint -> @app.route('/appliancedata_webhooks', methods=['POST'])
Endpoint URL -> https://companywebsite.com/appliancedata_webhooks