Register and remove event webhooks on individual objects or on whole object types.
Webhooks - Register Object
Register a webhook for a specific Carrier Cloud object.
path Parameters
partnercodePartner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Webhooks - Register Object › Request Body
typeEvent to subscribe to: update, archive, gps, hos, arrive, depart, truckperformance. gps applies to driver, truck, trailer, order and segment objects; hos to drivers; arrive/depart to orders and segments; truckperformance to trucks.
cardidurlWebhooks - Register Object › Responses
Webhook registered on the object.
_idIdentifier of the registration. Keep it; removal is by card id and type.
Webhooks - Register Type
Register a webhook for all Carrier Cloud objects of a given type.
path Parameters
partnercodePartner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Webhooks - Register Type › Request Body
typeEvent to subscribe to: update, archive, gps, hos, arrive, depart, truckperformance. gps applies to driver, truck, trailer, order and segment objects; hos to drivers; arrive/depart to orders and segments; truckperformance to trucks.
cardtypeurlWebhooks - Register Type › Responses
Webhook registered for the object type on every board the partnership shares. Registering the same subscription twice is ignored.
Webhooks - Remove Object
Remove a previously registered object webhook. Remove a registered webhooks for the specific object specified.
path Parameters
partnercodePartner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.
cardidIdentifier of the object the webhook is registered on, for example a load id or a tractor id.
typeWebhook event type: update, archive, gps or hos (the removable types).
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Webhooks - Remove Object › Responses
Webhook removed.
Webhooks - Remove Type
Remove a previously registered type webhook. All registered webhooks for objects of the specified type will be removed.
path Parameters
partnercodePartner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.
cardtypeObject type the type-level webhook applies to, for example order, segment, driver, truck or trailer.
typeWebhook event type: update, archive, gps or hos (the removable types).
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Webhooks - Remove Type › Responses
Type-level webhook removed from every shared board.