Rating Submitted

This webhook is triggered when a consumer submits a rating on the order via the order rating screen.

📘

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

{
  "rating": {
    "id": 3452,
    "rating": 4,
    "created_at": "2022-07-20T12:01:30.191Z",
    "updated_at": null,
    "task": {
      "id": 345623,
      "status": 1,
      "title": "pickup",
      "external_id": "12443523",
      "way_points": [
        {
          "id": 34666,
          "position": 1,
          "scheduled_at": "2018-03-13T23:00:00.000Z",
          "eta": "2018-03-13T23:05:00.000Z",
          "address": "4196 Water St. , NY 10002"
        }
      ]
    },
    "rating_reasons": [
      {
        "text": "Driver friendlinesss"
      },
       {
        "text": "Ease of use"
      }
    ]
  },
  "webhook_type": "rating_submitted",
  "merchant_id": 1,
}
{
  "rating": {
    "id": null,
    "rating": null,
    "created_at": null,
    "updated_at": null,
    "comment": null,
    "task": {
      "id": null,
      "status": null,
      "title": null,
      "external_id": null,
      "way_points": [
        {
          "id": null,
          "position": null,
          "scheduled_at": null,
          "eta": null,
          "address": null
        }
      ]
    },
    "rating_reasons": [
      {
        "text": null
      }
    ]
  },
  "webhook_type": "rating_submitted",
  "merchant_id": 12362,
}

Output params

id

Int32

Bringg's unique ID.

rating

Int32

The number of stars submitted by the customer.

created_at

datetime

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

updated_at

datetime

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

task

array of mixed

The order's details.

way_points

array of mixed

Details for each destination in the order.

rating_reasons

array of strings

The rating reasons selected by the customer.