Get webhook
Download OpenAPIAuthorization
api_key In: query
Path Parameters
Webhook ID
uuidResponse Body
application/json
curl -X GET "https://example.com/v2/webhooks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"{ "success": true, "data": { "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "callback_url": "https://example.com/webhooks/timetocargo", "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" }, "status": "OK", "status_description": "Request completed successfully"}Create webhook POST
Creates a webhook for your account. The response `data` includes a signing `secret` (22 characters from the base64url alphabet: A–Z, a–z, 0–9, `-`, `_`). The secret is shown only in this response and is not returned when the webhook is read later, so store it securely immediately. For each delivery, TimeToCargo sends a `POST` request to your `callback_url`. The request contains a `WebhookOutgoingPayload` JSON object and these headers: - `x-timetocargo-signature` — HMAC SHA-256 signature of `timestamp + '.' + rawBody`, prefixed with `sha256=`; - `x-timetocargo-timestamp` — Unix timestamp used to generate the signature; - `x-timetocargo-event-id` — unique event ID matching `payload.id`; - `x-timetocargo-delivery-id` — unique delivery attempt ID.
Update webhook PATCH
Updates the `callback_url`, activation status, and subscribed event types. With `regenerate_secret=true`, the response `data` includes the new `secret`. It is shown only in that response and is not returned when the webhook is read later.