GRgroupe-psa
Remote

Update an existing remote callback.

Update an existing Callback that has been posted (and accepted previously) for this fleet. The callback object (body) provided should be complete (aggregation is not supported for the update). This object can be retrieved using the GET /fleets/{fid}/remote/callbacks/{cbid} API then modify it and finally publish it (via this PUT API)

put/fleets/{fid}/remote/callbacks/{cbid}

Request

Path parameters

fidstring required

Resource is related to this fleet ID only.

cbidstring required

The remote callback ID.

Request body

labelstring
remoteTypesRemoteType[] required

Example request

{
  "retryPolicy": {
    "policy": "None",
    "retryNumber": 10,
    "retryDelay": 60
  },
  "callback": {
    "webhook": {
      "target": "https://my.post.callback",
      "name": "My_Webhook",
      "attributes": [
        {
          "type": "Header",
          "key": "X-Vehicle_Id",
          "value": "$vin"
        }
      ]
    }
  },
  "remoteTypes": [
    "Doors"
  ]
}

Response

Remote callback creation or update success response

callbackIdstring

Uniq remote callback ID returned when the callback was subscribed (created) succefuly.

status'Running' | 'Paused' | 'Failed'

Example response

{
  "_links": {
    "fleet": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "callback": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.