Webhooks for Delivery Operations: Event Overview

Bitrix24 notifies the delivery service when calculating the delivery total, creating a delivery order, or canceling an order. For each action, Bitrix24 sends a JSON HTTP request to the URL specified in the delivery service handler settings.

Handler URLs are defined in the parameters of the sale.delivery.handler.add method. Through these URLs, the external delivery service receives order data and returns the processing result in JSON.

Quick navigation: All Events

User documentation: Delivery Services

How to Receive EventsHow to Receive Events

1. Create a delivery service handler using the sale.delivery.handler.add method
2. Specify the URLs for calculating, creating, and canceling a delivery order in the SETTINGS parameter
3. Implement the processing of inbound JSON HTTP requests
4. Return a JSON response in the format described on the relevant event page

Handler URLsHandler URLs

parameter	Event	When Bitrix24 sends a request
CALCULATE_URL	Calculate shipping cost	When the manager calculates the preliminary shipping cost
CREATE_DELIVERY_REQUEST_URL	Create delivery order	When the manager places a delivery order
CANCEL_DELIVERY_REQUEST_URL	Cancel delivery order	When the manager cancels a previously placed delivery order

CALCULATE_URL is required when creating a delivery service handler. Specify the URLs for creating and canceling an order if the delivery service supports checking out and canceling orders from Bitrix24.

Exchange FormatExchange Format

Bitrix24 sends an HTTP request with a JSON body to the handler URL. The request structure depends on the event and is described on the specific event page.

The external handler must return a JSON response:

• A successful response confirms the calculation, creation, or cancellation of the order
• An error response provides a reason that can be displayed to the manager

Handler Server AvailabilityHandler Server Availability

Handler URLs must be accessible for inbound requests from Bitrix24. If the delivery service server is unavailable or returns a response in an unexpected JSON format, the delivery action will result in an error.

Overview of EventsOverview of Events

Scope: sale

Who can receive events: delivery service handler

Event	Triggered
Calculate shipping cost	During preliminary shipping cost calculation
Create delivery order	When placing a delivery order
Cancel delivery order	When canceling a previously placed delivery order