Skip to main content
Route4Green
Docs menu
POST

/addons/route-optimization/webhooks

Register an HTTPS terminal-event webhook

Open in ChatGPTOpen in Claude

Path

POST/api/v1/partners/addons/route-optimization/webhooks
Authentication requiredapi-key

curl example

curl -X POST "https://<your-host>/api/v1/partners/addons/route-optimization/webhooks" \
  -H "api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "url": "string"
}'

Parameters

This endpoint takes no parameters.

Request body

Completed from backend source

The specification does not describe this fully. What follows was completed by hand from the backend source code, and will be replaced once the specification carries it.

FieldTypeRequiredDescription
urlstringYesDelivery URL for this webhook. HTTPS only. 1 to 2048 characters.
1 fieldsCreateRouteOptimizationWebhookDto

Responses

201Returns the generated signing secret once
409WEBHOOK_LIMIT_REACHED

Back to group: Route optimisation

POST /addons/route-optimization/webhooks | Route4Green