Cargotime

Создание вебхука

Скачать OpenAPI
POST
/v2/webhooks

Создаёт вебхук для вашего аккаунта.

В ответе вы получите secret для проверки подписи (22 символа из алфавита base64url: A–Z, a–z, 0–9, -, _). Секрет показывается только в этом ответе и не возвращается при последующем чтении вебхука, поэтому сразу сохраните его в безопасном месте.

При каждой доставке Cargotime отправляет POST-запрос на ваш callback_url. Запрос содержит JSON-объект WebhookOutgoingPayload и заголовки:

  • x-cargotime-signature — HMAC SHA-256-подпись строки timestamp + '.' + rawBody с префиксом sha256=;
  • x-cargotime-timestamp — метка времени Unix, использованная для подписи;
  • x-cargotime-event-id — уникальный идентификатор события, совпадающий с payload.id;
  • x-cargotime-delivery-id — уникальный идентификатор попытки доставки.

Авторизация

api_key
api_key<token>

Передаётся в: query

Тело запроса

application/json

Типы TypeScript

Используйте тип request body в TypeScript.

Тело ответа

application/json

curl -X POST "https://example.com/v2/webhooks" \  -H "Content-Type: application/json" \  -d '{    "callback_url": "https://example.com/webhooks/cargotime",    "is_active": true,    "event_types": [      "tracking.eta_update",      "tracking.history_update",      "tracking.info_found",      "tracking.info_not_found",      "tracking.auto_archiving",      "tracking.delivered"    ]  }'
{  "success": true,  "data": {    "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",    "callback_url": "https://example.com/webhooks/cargotime",    "is_active": true,    "event_types": [      "tracking.eta_update",      "tracking.history_update",      "tracking.info_found",      "tracking.info_not_found",      "tracking.auto_archiving",      "tracking.delivered"    ],    "created_at": "2026-07-08T09:39:36.311Z",    "updated_at": "2026-07-08T13:10:43.554Z",    "secret": "AaBbCcDdEe-_0123456789"  },  "status": "OK",  "status_description": "Запрос выполнен успешно"}