Does Business Engine support Webhooks?

What Is a Webhook?

A webhook is an event-driven notification mechanism that pushes data to another application whenever a defined trigger occurs, such as a change in order status or a specific timestamp. Unlike APIs (which require polling), webhooks push data instantly.

Webhooks and APIs are most powerful when used together—webhooks trigger actions, while APIs can be used to fetch additional data.

Setting Up Webhooks

To set up webhooks in Business Engine, simply send the endpoint URL (i.e., where the webhook should be terminated) to COS Systems Support.

Common Webhook Events in Business Engine

Business Engine supports a wide range of webhook events. Here are some of the most frequently used:

Order Activated
Triggered when a service order is activated.

{
    "created": 1729710749,
    "data": {
        "externalOrderNumber": null,
        "id": "956b1d79-c618-4019-b571-b212002f6b41",
        "operation": "Activated",
        "serviceProviderId": "e13a8827-f8d3-46a4-a5ae-afea0118dc63",
        "terminationCode": null
    },
    "entity": null,
    "id": "271f92ba-bc4e-44d1-ac91-ed2d76bceae3",
    "type": "OrderOperation"
}

Order Terminated
Triggered when an order is terminated.

{
    "created": 1729651733,
    "data": {
        "externalOrderNumber": null,
        "id": "8ec3f00e-0776-4ab3-9ab3-b0ed014511c0",
        "operation": "Terminated",
        "serviceProviderId": "e13a8827-f8d3-46a4-a5ae-afea0118dc63",
        "terminationCode": null
    },
    "entity": null,
    "id": "271f92ba-bc4e-44d1-ac91-ed2d76bceae3",
    "type": "OrderOperation"
}

Order Created
Triggered when a new order is placed by a customer.

{
    "created": 1729651731,
    "data": {
        "customerId": "df26f3ae-9fe8-4111-a8a9-fd38ca7b255b",
        "externalOrderNumber": null,
        "id": "1cb33029-cc8b-4dc4-a3d9-b212002e5c09",
        "previousCustomerId": null,
        "previousOrderId": null,
        "serviceProviderId": "e13a8827-f8d3-46a4-a5ae-afea0118dc63"
    },
    "entity": null,
    "id": "c672671b-5a18-4906-a4aa-9c4a5b4a24d6",
    "type": "OrderCreated"
}

Use Cases

CRM synchronization – Update customer records when orders are created or terminated.
Billing platform integration – Trigger invoicing or cancellation workflows externally.
Ticketing systems – Automatically create support tickets on status changes.
Customer notifications – Send emails or SMS based on specific actions (e.g., service activation).
Reporting and analytics – Log events for usage tracking and performance metrics.
Third-party system alerts – Notify other platforms when key service events occur.

Added Functionality:

April 2025:

Location updates in Business Engine now trigger the "Object Changed" webhook.