Docs menu
PATCH
/addons/route-optimization/webhooks/{webhookId}
Activate, deactivate, or rotate a webhook secret
Path
PATCH
/api/v1/partners/addons/route-optimization/webhooks/{webhookId}Authentication required
api-keycurl example
curl -X PATCH "https://<your-host>/api/v1/partners/addons/route-optimization/webhooks/{webhookId}" \
-H "api-key: YOUR_API_KEY" \
-H "content-type: application/json" \
-d '{
"is_active": false,
"rotate_secret": false
}'Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| webhookId | path | number | Yes |
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.
| Field | Type | Required | Description |
|---|---|---|---|
| is_active | boolean | No | Enable or disable delivery without deleting the webhook. |
| rotate_secret | boolean | No | When true, generates a new signing secret and returns it once in the response. The previous secret stops working immediately. |
2 fieldsUpdateRouteOptimizationWebhookDto
Responses
404ROUTE_OPT_WEBHOOK_NOT_FOUND