Webhooks

Issues a new signing secret for the endpoint and returns it once. The previous secret keeps signing alongside it until it expires.

Issues a new signing secret for the endpoint and returns it once. The previous secret keeps signing alongside it until it expires.

While the previous secret is live, Owls-Signature carries two v1 values, one per secret. Accept either, then switch your receiver to the new secret.

post/api/v1/webhooks/{id}/rotate-secret

Request

  • Base URL: https://api.owlsinsight.com
  • URL: https://api.owlsinsight.com/api/v1/webhooks/{id}/rotate-secret
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

expire_previous_after_hoursnumber double

How long the previous secret keeps signing beside the new one: 0 to 168 hours (default 24). 0 retires it at once.

Response

OK

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.