Skip to content

Import Trip

Request

Webhook for planning a list of stops on a trip and assigning resources.

The documented schema is our default input format, but we can also map custom formats, keeping in mind the limitations that are documented under use cases.

Note that this webhook uses Basic Auth instead of the OAuth credentials used for the api. Please contact integrations@qargo.com to request credentials.

Security
BasicAuthWebhookCredentials
Bodyapplication/jsonrequired
Any of:
trip_identifierstring or null(Trip Identifier)
Any of:

External identifier for the trip

string
statusTripImportStatus (string) or null
Any of:

Status of the trip import

string(TripImportStatus)
Value:"CANCELLED"
planned_stopsArray of objects(Planned Stops)required

List of planned stops in the trip

start_timestampstring or null(Start Timestamp)
Any of:

Start timestamp of the trip in UTC

string (date-time)
primary_resourcesArray of objects or null(Primary Resources)
Any of:

List of primary resources assigned to the trip

unassigned_stopsArray of objects or null(Unassigned Stops)
Any of:

List of stops that couldn't be assigned to any resource

failureErrorStatus (object) or null
Any of:

Error details if the trip import failed upstream

POST
/v1/webhook/trip-import
{
  "trip_identifier": "string",
  "status": "CANCELLED",
  "planned_stops": [
    { … }
  ],
  "start_timestamp": "2019-08-24T14:15:22Z",
  "primary_resources": [
    { … }
  ],
  "unassigned_stops": [
    { … }
  ],
  "failure": {
    "error_type": "USER_INPUT_ERROR",
    "error_message": "string"
  }
}

Responses

Successful Response

Bodyapplication/json
Any of:
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"
  }
}