Rotate HMAC secret key

Management Rotates the HMAC secret key for a webhook subscription. Returns the new plaintext key exactly once. The old key is immediately invalidated. Rate limited to once every 5 minutes.

post

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

webhookSubscriptionIdstring · uuidRequired

Webhook Subscription ID

Body

reasonstring · max: 255Optional

Reason for rotation (default: "Manual rotation")

Example: Quarterly key rotation per security policy

Responses

200

HMAC secret key rotated successfully. The new key is shown once.

application/json

400

HMAC signing is not enabled for this webhook subscription

application/json

401Error

application/json

403

Forbidden.

application/json

404

Not found.

application/json

429

Secret rotation is limited to once every 5 minutes

application/json

post/api/{storeCode}/webhook/subscription/{webhookSubscriptionId}/rotate-secret

POST /api/{storeCode}/webhook/subscription/{webhookSubscriptionId}/rotate-secret HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "reason": "Quarterly key rotation per security policy"
}

{
  "message": "HMAC secret key rotated successfully",
  "newSecretKey": "whsec_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
  "warning": "This is the only time the secret key will be displayed. Store it securely."
}