↑↓select↵openescclose

Horeca24 Partner API › Connection

Get a new signing secret

POSThttps://management.horeca-24.de/api/partner/v1/webhook/rotate-secret

The new secret is answered once. The previous one keeps signing for 24 hours, so each delivery carries two v1= signatures in that time. Colliding rotations may answer 409 REQUEST_IN_PROGRESS with Retry-After: 2.

Headers

AuthorizationstringRequired

Bearer pk_<connectionId>.<keyId>.<secret>

The connection's API key, from the restaurant's till. Treat it as one opaque string. 401 UNAUTHORIZED for a missing, wrong, expired or revoked key; 403 CONNECTION_REVOKED for the key of a deleted connection. After a rotation by the restaurant, the previous key keeps working for 24 hours.

Response

200The new secret
webhookSecretstringRequiredpattern: ^whsec_

Answered once. Store it.

previousExpiresAtstringOptionalformat: date-time

Until when the previous secret signs too

Errors

objectErrorBody

401

UNAUTHORIZED: the key is missing, malformed, unknown, wrong, expired or revoked

403

CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

409

STORE_OFFLINE, WEBHOOK_NOT_CONFIGURED, ORDER_CONFLICT, INVALID_TRANSITION or REQUEST_IN_PROGRESS. REQUEST_IN_PROGRESS carries Retry-After (seconds); retry with the same body.

Headers

Retry-AfterintegerOptional

Seconds to wait (REQUEST_IN_PROGRESS only)