Shared Location Created (SMS Sent)

The Shared Location Created (SMS Sent) callback occurs when a customer receives an SMS indicating an order update that includes a link to view the driver's location. This callback returns detailed information describing the order, customer, and user (driver).

📘

Registering Your URL for the Shared Location Created (SMS Sent) Webhook

For information describing how to register your URL for a webhook and different webhook options, see Bringg Webhooks.

Response

{
  "shared_location": {
    "monitor_url": "https://us2-realtime.bringg.com",
    "rating_url": "https://us2-realtime.bringg.com/api/rate/UoJ2ahHW",
    "alerting_url": "https://us2-realtime.bringg.com/api/public_alert/UoJ2ahHW",
    "note_url": "https://us2-realtime.bringg.com/api/notes/UoJ2ahHW",
    "find_me_url": "https://us2-realtime.bringg.com/api/customer/task/9832913/find_me/UoJ2ahHW",
    "id": 11024537,
    "uuid": "UoJ2ahHW",
    "expired": false,
    "user_id": 599609,
    "task_id": 9832913,
    "customer_id": 8560418,
    "way_point_id": 14751552,
    "url": "https://app.bringg.com/sen.html?UoJ2ahHW&e=6",
    "alerting_token": "849f7105-f756-486b-a110-57bed710ca3a",
    "rating_token": "27b5f45d-dbba-4c7f-98ae-2d9d2a976667",
    "note_token": "9953d228-4c07-4232-bdde-956aa1888ad9",
    "tip_token": "7e7b8442-a2c9-4ade-9cda-0c6abb55dbdb",
    "find_me_token": "c56f8dc1-b284-4c80-b2ea-3a90371b07e1",
    "update_customer_token": "9f9f9511-d0cc-4d7b-aadb-330a57d9693d",
    "shared_on": "2020-07-01T18:58:39.389Z",
    "shared_type": 1,
    "sharing_method": 0,
    "tag_id": 554
  },
  "way_point": {
    "id": 14751552,
    "scheduled_at": "2020-06-29T21:44:26.412Z",
    "task_id": 9832913,
    "customer_id": 8560418,
    "eta": null,
    "etl": "2020-06-29T21:49:26.412Z",
    "name": "Customer Name",
    "address": "Fairview Drive",
    "address_second_line": null,
    "done": false,
    "address_type": null,
    "location_name": null,
    "no_earlier_than": "2020-06-29T21:14:26.412Z",
    "no_later_than": "2020-06-29T21:44:26.412Z",
    "lat": null,
    "lng": null,
    "phone": "+155555555555",
    "note": null,
    "allow_editing_inventory": true,
    "must_approve_inventory": false,
    "zipcode": null,
    "borough": null,
    "city": "",
    "state": null,
    "pickup_dropoff_option": 1,
    "etos": 300,
    "position": 2
  },
  "task_external_id": "ext123",
  "phone": "+155555555555",
  "email": null
}
{
  "shared_location": {
    "id": 156,
    "expired": null,
    "user_id": null,
    "task_id": null,
    "task":{
      "id": 1234,
      "external_id": "H834-j12"
    },
    "created_at": null,
    "updated_at": null,
    "customer_id": null,
    "way_point_id": 12345,
    "shared_on": null,
    "shared_successfully": null,
    "first_seen_on": null,
    "view_counter": 1,
    "shared_type": 3,
    "sharing_method": 7,
    "rating_token": null,
    "note_token": null,
    "find_me_token": null,
    "sms_price": null,
    "tag_id": 765,
    "sms_delivered": null,
    "update_customer_token": null,
    "sent_eta": null,
    "opt_in_out_token": null,
    "action_tokens": null,
    "expire_at": null,
    "cancel_token": null,
    "workflow_id": 124,
    "display_type": 4,
    "uuid": "eKRB9Gf",
    "failure_reason": null,
    "url": "https://c.bringg.com/#/eKRB9Gf/&e=6",
    "pickup_uuid": null,
    "secure_uuid": null
  },
  "webhook_type": "shared_location_created",
  "merchant_id": 12362,
}

Output Params

id

Int32

The Id of the order to which the SMS is associated.

alerting_token

UUID

The token used to send alerts for this shared locations.

created_at

datetime

The date and time this order was created. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z"

customer_id

Int32

The Id of the customer with which this order is associated.

expired

boolean

Indicates whether the shared location expired, where expired means the order completed or is set to not allow watching. The values are:

  • false or 0 - the shared location is not expired
  • true or 1 - the shared location is expired

failure_reason

string

If the SMS and email failed, the reason for failure.

find_me_token

UUID

The token used when the customer uses the find me feature.

first_seen_on

datetime

The date and time the shared location was seen for the first time. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z"

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

note_token

UUID

The token used for a note about this shared location.

pickup_uuid

string

The token used for a pickup at this shared location.

rating_token

UUID

The token used for a rating at this shared location.

shared_on

datetime

The date and time an attempt was made to share this SMS. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z"

shared_successfully

boolean

Indicates whether the SMS about the shared location was successful. The values are:

  • false or 0 - the SMS was not successful
  • true or 1 - the SMS was successful

shared_type

Int32

The type or reason for the SMS. The values include:

  • 0 - created
  • 1 - start
  • 2 - checked_in
  • 3 - checked_out
  • 4 - route
  • 5 - late
  • 6 - reschedule
  • 7 - ready_for_pickup
  • 8 - schedule_ready
  • 9 - acknowledged
  • 10 - schedule
  • 11 - opt_in_ready
  • 12 - eta_delay
  • 13 - customer_pickup
  • 14 - opt_in_confirmation
  • 15 - custom_workflow

sharing_method

Int32

The type of the SMS share. The values include:

  • 0 - phone
  • 1 - email
  • 2 - websocket
  • 3 - none
  • 4 - other
  • 5 - api
  • 6 - push
  • 7 - webhook

sms_delivered

datetime

If the SMS was delivered, the date and time the SMS of delivery. This is in UTC and is in the format is " %Y-%m-%dT%H:%M:%S%z"

sms_price

double

Description of this parameter is pending.

tag_id

Int32

If a tag exists, this is the Bringg tab Id.

task_external_id

String

Order External ID (the Order ID in your system)

task_id

Int32

The Bringg order Id.

tip_token

UUID

If the customer tipped the user (driver), the token used for that tip.

update_customer_token

UUID

The token used to update the customer.

updated_at

datetime

The date and time of the last update for this order. This is in UTC and is in the format is %Y-%m-%dT%H:%M:%S%z".

url

string

The URL of the webpage for this shared location update.

user_id

Int32

The Id of the user (driver) .

uuid

string

The universal unique Id of this order.

view_counter

Int32

The number of times that the URL for this particular shared location has been viewed.

way_point_id

Int32

The Id of the way point to which this SMS is associated.