Subcontractor Dispatch Payload

Request

Payload for sending a trip dispatch. In this case, we send the payload to an external endpoint for processing.

By default, we send our standard SubcontractorDispatch schema, but the body can also be a custom mapped format.

Bodyapplication/jsonrequired

Any of:

operationstring(DispatchOperation)required

Enum:"CREATE""UPDATE""CANCEL"

payloadobject(SubcontractorDispatchOutput)required

POST

https://<external_subco_receiving_endpoint>

{
  "operation": "CREATE",
  "payload": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "orders": [ … ],
    "custom_fields": {},
    "resource_allocations": [ … ],
    "stops": [ … ]
  }
}

Responses

Successful Response

Bodyapplication/json

Any of:

Response schema for the subcontractor dispatch payload. This schema is used to return errors or success messages.

errorsArray of objects or null(Errors)

Any of:

List of errors that occurred during the webhook processing. If empty/omitted, the webhook was processed successfully.

Response

{
  "errors": {
    "error_message": "The payload is invalid.",
    "error_type": "USER_INPUT_ERROR"
  }
}