Skip to main content

Create a warranty session

POST 

/v1/warranty/sessions

Creates a warranty session for a given vehicle and customer. Returns a short-lived URL to redirect the user to the warranty tunnel.

Request​

Responses​

SessionResource resource created

Callbacks​

POST 

{$your-configured-webhook-endpoint}

[OUTGOING EVENT] Sent when the subscription tunnel reaches its final submit step, whether the contract subscription succeeded or failed — type distinguishes warranty.subscription.completed from warranty.subscription.error (the latter carries data.object.error with a localized message; success-only fields such as contractId, price or registrationDate are then omitted).

It is fire-and-forget: a webhook failure never alters the subscription outcome. Null fields are omitted from the JSON body.

The webhook URL comes from the Software record linked to the customer subscription (serviceUris, read through the IDP module). If no URL is configured, no request is sent.

Authentication: No signature header is added. Secure the receiver endpoint at the network level or validate data.object.id against your own records.