Payload

Payloads are data packages containing a predefined set of parameters (fields and values) which Bringg sends and receives from other systems via webhooks, APIs, or websockets.

Payloads arrive at a designated URL in another systems in standard JSON format. For example, see the payload format for an API call to assign a new driver to an order:

{
    "task id": 1234567,
    "user": {
        "external_id":"driver1",
        "name": "Driver Name",
        "profile image": "https://url.to.image",
        "phone": "+15555555555",
        "email": "driver@fleet.com"
    },
       "delivery cost":12.99,
       "green_delivery": true
}