API Reference

Shift Started for Driver

The Shift Started For Driver callback occurs when a user (driver) starts a shift. This callback returns information identifying the user (driver), the UTC time the user's (driver's) shift began, and the user's (driver's) geoposition. The callback may also include the content of any forms or notes completed when starting a shift.

📘

Register Your URL for this Webhook

To start receiving webhooks from Bringg, you must first register a URL. Detailed guidance on setting up and managing Bringg webhooks is available in the following resources:

🚧

URL Lifespan

URLs provided in Bringg webhooks, such as the link to an uploaded photo, are valid for 6 days, after which time the link expires.

Therefore, it is important to extract the asset from the link as possible.

If the link has expired, send the Get Order API call which will return a fresh link for the relevant URL in the response.

For Personal Information (PI) data concerns, all proof of delivery (POD) assets are deleted after 45 days. See our Help page on PI.


Response

{
"id": 4250127,
"user_id": 334626,
"start_shift": "2020-08-10T06:21:37.193Z",
"lat": 31.9641707,
"lng": 34.7948816,
"user_external_id": "1509239",
"notes":[],
"forms":[]
}

Output Params

id

Int32

The unique Id of this user (driver) shift record.

user_id

Int32

The unique Id of this user (driver).

start_shift

datetime

The date and time this user (driver) started this shift. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z".

lat

double

The geoposition latitude of this user (driver) when starting a shift.

lng

double

The geoposition longitude of this user (driver) when starting a shift.

user_external_id

Int32

The unique external Id of this user (driver).

notes

Mixed

Information describing the note and the note content. See note was added to task callback.

forms

Mixed

Information describing the form and the form content. See form was added to task callback.