Sign In
Sign Out

Webhook Request Structure

Recognition events are sent to the webhook as HTTP POST requests. Event data is sent in the request body in a JSON object. The signature and the algorithm used are sent in custom headers.

Body

Content Type: application/json

Contains a JSON object with the following properties:

  • detectionTimestamp (number): a millisecond-based Unix timestamp representing the time the vehicle was detected.
  • attachments (string array): contains a single object with the following properties:
    • mimeType (string): the MIME type of the image.
    • data (string): the original image as a Base 64 string.
  • event (object): the raw JSON result returned by the cloud API. For details please refer to the Vehicle Cloud API documentation.

Headers

  • X-Signature-Algorithm (string, optional): contains the algorithm used to sign the request. Only present if signing is configured.
    • Symmetric:
      • HS256: HMAC using SHA-256 hash algorithm
      • HS384: HMAC using SHA-384 hash algorithm
      • HS512: HMAC using SHA-512 hash algorithm
    • Asymmetric:
      • RS256: RSASSA using SHA-256 hash algorithm
      • RS384: RSASSA using SHA-384 hash algorithm
      • RS512: RSASSA using SHA-512 hash algorithm
      • PS256: RSASSA-PSS using SHA-256 hash algorithm
      • PS384: RSASSA-PSS using SHA-384 hash algorithm
      • PS512: RSASSA-PSS using SHA-512 hash algorithm
      • ES256: ECDSA using P-256 curve and SHA-256 hash algorithm
      • ES384: ECDSA using P-384 curve and SHA-384 hash algorithm
      • ES512: ECDSA using P-521 curve and SHA-512 hash algorithm
  • X-Signature (string, optional): contains the signature as a base64url encoded string.