Webhook API Reference
Rotate Webhook Secret
Replace the signing secret of a webhook endpoint.
The new secret is shown only in this response. The old secret stops working at once and the endpoint is paused: events that happen before you activate it again are not sent to it. Update your receiver with the new secret, then activate the endpoint. Every call replaces the secret again, so don't retry a request that succeeded.
Authorization
api_key x-access-token<token>
In: header
Path Parameters
webhook_id*string
ID of the webhook endpoint
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/shipos/webhooks/string/rotate-secret"{ "success": true, "secret": "string", "message": "string"}