This event catalog for Rackbeat's webhooks is a structured list of events that can trigger webhook notifications. It provides details about relevant events, e.g. name, description, and the data payload it carries when sent via webhook. This catalog helps developers understand what events they can subscribe to and how to handle the corresponding data.

General Format for Webhook Delivery

Headers

Upon creating a new webhook, a 32-character "token" will be given to you. Store this token securely. It will be passed on every webhook in a Rackbeat-Webhook-Token header, and can be used to verify that the origin is Rackbeat.

Every webhook request includes these headers:

• Rackbeat-Webhook-Token: Your webhook's verification token
• Rackbeat-Webhook-Event: The event that triggered the webhook
• Rackbeat-Account-Id: Your Rackbeat account ID
• User-Agent: "Rackbeat Webhook"

Payload Structure

The payload structure varies by event type, but generally includeskey and key_name(name of the id/number/identifier/key for the element, which usually is "number" or "id"):

{
  "key": 123,
  "key_name": "id",
  "event": "order.created",
  "data": {
    // Event-specific data
  }
}

For "updated" events, additional fields are included:

• old_key: Previous identifier value (old id/number/identifier/key of the element). Included in case it was changed, but generally always supplied.
• new_key: New identifier value (new id/number/identifier/key of the element). Included in case it was changed, but generally always supplied.
• changed: Updated data (array of keys).

Account & Settings

Items, Products & BoMs

ℹ️ Read more about the differences between items, products and bill of materials as well as batches, collections, locations and units in our guide "Intro to Items, Products & BoMs".

Inventory & Movements

ℹ️ Read more about managing your warehouse operations, including stock adjustments, internal movements, checking processes, and inventory transactions in our guide "Intro to Inventory".

Inventory changes

💡

Good to know:

• Events will be sent for changes in inventory for BoMs (lots) and products.
• Type can be any of stock, available, in_order, purchased.

Inventory transactions

Event name: inventory_transaction.created

Example payload:

{
  "id": 1,
  "item": {
      "number": "shoe-box-1001",
      "type": "product",
      "totals": {
          "value": 377.5,
          "quantity": 250,
          "cost_price": 1.51
      }
  },    
  "location": {
      "number": 1000,
      // Totals are for item on that location, not for the location alone.
      "totals": {
          "value": 151.0,
          "quantity": 100,
          "cost_price": 1.51
      }
  },
  "quantity": 100,
  "cost_price": 1.51,
  "effective_from": "2019-08-01T11:39:10.958426+00:00"
}

Movements

Event name: movement.booked

Purchasing & Suppliers

Sales & Customers

Example payload for order shipment lines:

{  
    "key":          123,    // Line ID  
    "key_name":     "id",   // Name of the key in Rackbeat. For shipment lines its "id".  
    "shipment_id":  1,      // The related shipment's ID  
}