↑↓select↵openescclose

Horeca24 Partner API › Connection

Read the webhook URL and the dates of the active secrets

GEThttps://management.horeca-24.de/api/partner/v1/webhook

Never answers the secrets themselves.

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 webhook configuration
urlstring or nullRequired
configuredbooleanRequired
secretsarray of objectRequired

The active secrets' dates; never the secrets

Show child attributesHide child attributes
createdAtstringRequiredformat: date-time
expiresAtstringOptionalformat: date-time

Present for the previous secret after a rotation

Errors

objectErrorBody

401

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

403

CONNECTION_REVOKED: the restaurant deleted the connection; stop sending