Purpose
This page explains how Skulytics webhooks work, which API v3 webhook events are available, and how clients can begin receiving real-time product data updates.
What Is a Webhook?
A webhook is an automated HTTP callback that sends data to another system when a supported event occurs.
Unlike a standard API request, which requires the client to request data, a webhook automatically sends an update to the client’s registered endpoint.
This allows clients to keep their product catalogs, pricing, inventory, and other connected systems synchronized without repeatedly polling the Skulytics API.
API v3 Webhooks
Skulytics API v3 provides dedicated webhook events for individual Public API data categories.
For example:
- General product changes use product_updated.
- Product status changes use product_status_updated.
- Product specifications changes use product_spec_updated.
- Inventory quantity changes use product_inventory_quantity_updated.
Dedicated events allow clients to identify the affected data category from the event type and process only the relevant payload.
Clients can activate their webhook integration and select the event types they want to receive through the Skulytics Customer Portal at https://portal.skulytics.io.
All selected events are delivered to the same registered webhook endpoint. Clients do not need to create a separate URL for each event type.
How Webhooks Work
When a supported event occurs:
- Skulytics generates the appropriate webhook event.
- Skulytics sends an HTTP POST request to the client’s registered endpoint.
- The client receives and validates the JSON payload.
- The client returns an HTTP 200 OK response.
- The client processes the event in its system.
The acknowledgment must be returned within 10 seconds.
Long-running processing should be completed after the acknowledgment has been returned.
Webhook Event Structure
All webhook events use a standard envelope:
{
"type": "product_updated",
"action_date": "07/13/2026 10:30:00",
"payload": [
{
"product_id": 947,
"sku": "JVW5301SJSS"
}
]
}
type
Identifies the webhook event.
action_date
The date and time when the event occurred, formatted as MM/DD/YYYY HH:MM:SS.
payload
An array containing the data associated with the event.
The payload structure depends on the event type. Some events may also contain a meta object with additional information, such as the fields changed by a product update.
Available Events
The following API v3 webhook events are currently available:
product_created
Triggered when a new product becomes available through the List Products endpoint.
product_updated
Triggered when general product information changes.
product_deleted
Triggered when a product is deleted from Skulytics and is no longer available through the List Products endpoint.
Coming Soon
The following API v3 webhook events are planned:
- product_status_updated
- product_pricing_updated
- product_document_updated
- product_spec_updated
- product_feature_updated
- product_rebate_created
- product_rebate_updated
- product_rebate_deleted
- product_inventory_quantity_updated
- product_inventory_pricing_updated
Refer to the documentation for each event type for its complete payload structure and processing requirements.
Getting Started
Clients can activate and manage their webhook integration through the Skulytics Customer Portal.
1. Build a Webhook Endpoint
Create an endpoint that:
- Accepts HTTP POST requests.
- Accepts JSON request bodies.
- Returns HTTP 200 OK within 10 seconds.
- Can route events using the type field.
HTTPS should be used in production.
2. Configure the Webhook in the Customer Portal
Go to the Skulytics Customer Portal:
From the webhook settings page, clients can:
- Activate or deactivate their webhook integration.
- Register or update their webhook endpoint URL.
- Enable or disable webhook retry behavior.
- Select which webhook event types they want to receive.
Clients do not need to subscribe to every available event type. They can enable only the events required by their integration.
For example, a client may choose to receive:
product_created
product_updated
product_deleted
product_pricing_updated
while leaving inventory, rebate, or specification events disabled.
For step-by-step instructions, see the Webhook Configuration Tutorial.
3. Process Events by Type
Skulytics sends all selected event types to the registered webhook endpoint.
Use the type field in each payload to route the event to the appropriate process in your system.
For example:
switch (event.type) {
case "product_created":
handleProductCreated(event.payload);
break;
case "product_updated":
handleProductUpdated(event.payload);
break;
case "product_deleted":
handleProductDeleted(event.payload);
break;
default:
logUnsupportedEvent(event);
}
Only event types enabled in the Customer Portal will be delivered to the registered endpoint.
Webhook Endpoint Requirements
A valid endpoint must:
- Be accessible by Skulytics.
- Accept HTTP POST requests.
- Accept JSON payloads.
- Return HTTP 200 OK within 10 seconds.
- Avoid blocking the acknowledgment with long-running processing.
- Handle repeated delivery attempts safely.
Clients should implement idempotent processing because the same event may be delivered more than once.
Retry Behavior
If a webhook delivery is not successfully acknowledged, Skulytics retries it according to the following schedule:
- Initial attempt: Immediately.
- First retry: 10 minutes after the initial attempt fails.
- Second retry: 30 minutes after the first retry fails.
- Final status: If the second retry also fails, the delivery is marked as failed.
A delivery attempt may fail when the endpoint:
- Cannot be reached.
- Does not respond within 10 seconds.
- Returns an unsuccessful HTTP status.
Retry behavior can be enabled or disabled for each registered webhook configuration.
Webhook URL Format
A registered webhook should use a stable HTTPS URL, such as:
https://companywebsite.com/webhooks/skulytics
The endpoint should remain publicly accessible and should not require interactive authentication.
Related Pages
- Webhook Migration Guide
- Product Created Webhook
- Product Updated Webhook
- Product Deleted Webhook
- API v3 Endpoint Documentation
