Webhooks

Entities and Actions

Complete reference of webhook entities and supported actions in Geins Management API

Entities and Actions Reference

This page provides a complete reference of all entities that support webhooks and their available actions. Use this to understand what events you can listen to in your application.

Supported Entities

The Webhook API supports the following entities:

Entity	Supported Actions	Category	Description
Product	`create`, `update`, `delete`	Product Lifecycle	Track product data changes
ProductMonitor	`create`, `notify`	Product Lifecycle	Customer subscriptions for product availability notifications
Brand	`create`, `update`, `delete`	Catalog	Monitor brand information
Category	`create`, `update`, `delete`	Catalog	Track category hierarchy and structure changes
Supplier	`create`, `update`, `delete`	Catalog	Supplier information additions and modifications
PageWidget	`update`, `delete`	Content	CMS widget and page content changes
Customer	`create`, `update`, `delete`, `passwordreset`, `obfuscate`	Customer	Customer lifecycle, profile updates, password resets
Order	`create`, `update`, `cancel`, `activate`, `complete`, `lock`, `cancelrow`, `return`	Order	Full order lifecycle from creation to fulfillment
Capture	`create`	Payment	Payment capture processing notifications
Refund	`create`	Payment	Refund creation and processing

Action Definitions

Understanding what each action represents:

Common Actions

create - Triggered when a new entity is created
update - Triggered when an entity's data is modified
delete - Triggered when an entity is removed from the system

Order-Specific Actions

cancel - Order is cancelled
activate - Order is activated/confirmed
lock - Order is locked for processing
complete - Order fulfillment is completed
cancelrow - Individual order row (line item) is cancelled
return - Return is created for the order

Customer-Specific Actions

passwordreset - Customer initiates password reset
obfuscate - Customer data is obfuscated (GDPR compliance)

ProductMonitor-Specific Actions

notify - Customer notification is triggered when product becomes available

Combining Entities and Actions

When creating a webhook, you specify:

Entity - What type of object to monitor
Actions - Which events to listen for (comma-separated)

Example configurations:

// Monitor all product changes
{
  "Entity": "Product",
  "Actions": "create,update,delete"
}

// Track order lifecycle
{
  "Entity": "Order",
  "Actions": "create,complete,return"
}

// Customer registration and updates only
{
  "Entity": "Customer",
  "Actions": "create,update"
}

Start with specific actions rather than listening to everything. This reduces noise and makes debugging easier.

Each entity type supports only specific actions. Attempting to use unsupported actions will result in a 400 Bad Request error. Refer to the sections above for valid action combinations.

Introduction

Real-time event notifications for your application. Get instant updates when products, orders, customers, or other entities change.

Placeholders

Placeholders allow you to customize webhook URLs and payloads with dynamic values. When a webhook is triggered, placeholders are replaced with actual data from the event.