Retrieve your webhook endpoint
Returns your organisation's webhook endpoint, as a list with zero or one item. Check
verificationStatus: events are delivered only while it is verified and isEnabled is
true. failureCount and backoffUntil show whether deliveries are currently failing.
Requires the READ_WEBHOOKS permission.
bearerAuthAuthorizationBearer <token>An access token from the OAuth2 client-credentials grant. Exchange your API key
(client_id + client_secret) at the token endpoint and send
Authorization: Bearer <access_token>.
Your webhook endpoint, if one is registered.
application/json- response
statusCode*integermessage*stringdata*array<>items <= 1curl -X GET 'https://sandbox-api.fastrac.example/b2b/webhook/info'{ "statusCode": 200, "message": "Request successful.", "data": [ { "id": 41, "name": "Production events", "url": "https://hooks.sinartebet.co.id/shipping-engine", "isEnabled": true, "verificationStatus": "verified", "apiVersion": "V3", "timeoutMs": 10000, "maxAttempts": 8, "eventTypes": [ "shipment.*" ], "activeSecretKeyIds": [ "whsec_main_2026" ], "createdAt": "2026-11-02T07:00:00.000Z", "updatedAt": "2026-11-18T09:30:00.000Z", "backoffUntil": null, "failureCount": 0 } ]}Was this page helpful?
List balance logs GET
Lists every credit and debit on your balance, newest first: order payments, refunds of cancelled shipments, price adjustments, return (RTS) fees, COD proceeds and top-ups. Use it to reconcile your balance with your own records. Any valid API key can call it; no extra permission is needed.
Set your webhook endpoint POST
Registers, or replaces, the single webhook endpoint of your organisation. Calling it again replaces the URL, secret and event types; the new secret takes effect immediately with no overlap, so deploy it to your endpoint first. **Verification challenge.** Before saving, Shipping Engine sends your URL an unsigned `POST` with `{"challenge":"<uuid>"}` (10-second timeout). Reply with any `2xx` and the body `{"challenge":"<uuid>"}` or the raw uuid. - Challenge passed: the endpoint is saved as `verified` and starts receiving events. - Challenge failed on a **new** endpoint: it is saved with `verificationStatus: failed` (still `201`) and **receives no events**. Fix your endpoint and call this again. - Challenge failed while you already have a **verified** endpoint: `422`, and the current endpoint stays active and unchanged. Always check `data.challenge.success` in the response. Requires the `MANAGE_WEBHOOKS` permission.