Remote

Register a new reusable remote callback.

Create a new reusable callback.

post/fleets/{fid}/remote/callbacks

Request

Base URL
https://api-cert.groupe-psa.com/connectedcar/v3
Auth
HTTP basic and API key in query parameter client_id
TypeScript
https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/docs/fleets/:fid/remote/callbacks/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fidstring required

Resource is related to this fleet ID only.

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.