Webhooks

Replace the signing secret

Changed on

Answers the endpoint with a new secret.

Send an Idempotency-Key. The secret is shown once, so a retry after a lost response would rotate a second time and leave you holding one that signs nothing — with the header, the retry is answered with the secret the first call minted.

Deliveries already queued are signed with whichever secret is current when they are actually sent, so accept both for as long as your backlog can be deep — up to about a day where transient failures are being retried.

post/company/v3/webhooks/{id}/secret

Request

  • Base URL: https://api.clockster.com
  • URL: https://api.clockster.com/company/v3/webhooks/{id}/secret
  • Auth: HTTP bearer

Path parameters

idinteger required

The id of the row, as this API issued it.

Headers

Idempotency-Keystring

A value you choose, unique per attempt. Send the same one when retrying and the first answer is replayed instead of the write happening twice. Optional, and only on the writes that carry no key of your own.

Response

Success

Changes

    • info

      the endpoint scheme security companyToken was added to the API

    • breaking

      the response's property type changed from array to object for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status