Skip to main content

Topic Format

Each topic identifies a specific event for a specific entity using a reverse-DNS format:
For example: com.jtl.erp.workflow.v1.item.changed represents a changed event for the item entity. The topic you declare in capabilities.erp.webhooks.subscriptions[].topics is delivered as-is in the event payload. The topic matches the event’s type and subject fields, so you can use these fields to identify and route events without maintaining a separate lookup table. Topics are matched exactly. If your app needs to receive multiple events, declare each topic separately.

Payload

All ERP topics use the same event envelope and data structure. The data object contains:
  • objectKey: the key of the entity that triggered the event
  • a timestamp for when the event occurred
  • information about the user who triggered the event
The payload does not contain the entity’s fields or current state. Use objectKey to retrieve the entity through the GraphQL API when you need its details. See Handling Webhooks for the full envelope and a worked example.

Items

Topics that fire on changes to items in the item catalog.

Customers

Topics that fire on changes to customer records.

Orders

Topics that cover the sales order lifecycle, including payment and fulfilment milestones.

Invoices

Topics that cover outgoing invoices and their payment status.

Credit Notes

Topics that fire on changes to credit notes.

Delivery Notes

Topics that cover delivery note creation and dispatch.

Returns

Topics that cover returns and the status transitions of individual return positions.

Payments

Topics that cover payment records and bank reconciliation.

Picking

Topics that cover pick lists and pick confirmations.

Warehouse Movements

Topics that fire on stock bookings into and out of the warehouse.

Stock Transfers

Topics that cover transfers of stock between warehouses.

Shipments

Topics that cover packages, tracking, and carrier export.

Fulfillment Network

Topics that cover fulfillment orders and the fulfiller’s processing status.

What’s Next?

Handling Webhooks

Declare subscriptions, receive deliveries, and fetch the changed entity.

Webhooks & Events

How ERP webhooks compare to AppBridge events and SCX polling.

Best Practices

Production patterns for error handling, security, and performance.