Webhooks

Regenerate HMAC secret

post/nhsapi/v1/Webhooks/{id}/regenerate_secret

Request

  • Base URL: https://www.example.com
  • URL: https://www.example.com/nhsapi/v1/Webhooks/{id}/regenerate_secret
  • Auth: none declared

Headers

X-External-Account-Tokenstring

External account token for authentication

Request body

hmac_secretstring

Optional new HMAC secret (min 32 chars). If not provided, will be auto-generated

Example request

{
  "hmac_secret": "new_secret_at_least_32_characters_long_for_security"
}

Response

secret regenerated

idinteger
hmac_secretstring

The new HMAC secret

noticestring

Example response

{
  "id": 1,
  "hmac_secret": "new_secret_at_least_32_characters_long_for_security",
  "notice": "HMAC secret regenerated. Store it securely. It will not be shown again in full."
}

Changes

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