Horeca24 Partner API › Connection

Set or change the webhook URL

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

The URL must use https on port 443, carry no user:pass@, be at most 2048 characters long and name a host (no IP literal, no localhost) whose addresses are all public. The check is repeated at every delivery. A refused URL answers 422 INVALID_FIELD with path: "url".

webhookSecret is answered only the first time a URL is set; store it. A first or changed URL sends menu.updated right away if the restaurant has synced a menu; menuDelivery says how that went.

Until a URL is set, no events are produced and orders are refused (409 WEBHOOK_NOT_CONFIGURED).

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.

Request

application/jsonRequired

urlstringRequired1-2048 charsformat: uri

https, port 443, public host

Response

200Stored

urlstringRequiredformat: uri

webhookSecretstringOptionalpattern: ^whsec_

Only the first time a URL is set. Store it.

menuDeliverystringRequiredsentqueuedfailedskipped

The menu.updated sent for the URL - sent, queued (retried), failed, or skipped (nothing to send)

Errors

objectErrorBody

400

An error; see ErrorCode

401

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

403

CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

422

An error; see ErrorCode

PUT/webhook

cURL

curl -X PUT https://management.horeca-24.de/api/partner/v1/webhook \
  -H "Authorization: Bearer $PARTNER_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://partner.example/hooks/horeca24"
}'

Python

import os
import requests

url = "https://management.horeca-24.de/api/partner/v1/webhook"

headers = {
    "Authorization": "Bearer " + os.environ["PARTNER_API_KEY"],
}

payload = {
    "url": "https://partner.example/hooks/horeca24",
}

response = requests.put(url, headers=headers, json=payload)

print(response.status_code)
print(response.text)

JavaScript

const response = await fetch("https://management.horeca-24.de/api/partner/v1/webhook", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer " + process.env.PARTNER_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://partner.example/hooks/horeca24"
  }),
});

const data = await response.text();
console.log(response.status, data);

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://management.horeca-24.de/api/partner/v1/webhook',
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PARTNER_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'url' => 'https://partner.example/hooks/horeca24',
    ]),
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Try it

Sends a real request to https://management.horeca-24.de/api/partner/v1

ServerAuthorizationNever stored, never sent to us.Body

Response

200

200Stored

{
  "url": "https://partner.example/hooks/horeca24",
  "webhookSecret": "whsec_Q2hhbmdlIG1lIGJlZm9yZSBnb2luZyBsaXZlIQ",
  "menuDelivery": "sent"
}

400

400An error; see ErrorCode

{
  "error": {
    "code": "INVALID_AMOUNTS",
    "message": "itemsSubtotal must be 2700",
    "path": "amounts.itemsSubtotal",
    "requestId": "6b1f2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d"
  }
}

401

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

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "path": "string",
    "details": null,
    "requestId": "string"
  }
}

403

403CONNECTION_REVOKED: the restaurant deleted the connection; stop sending

{
  "error": {
    "code": "CONNECTION_REVOKED",
    "message": "string",
    "path": "string",
    "details": null,
    "requestId": "string"
  }
}

422

422An error; see ErrorCode

{
  "error": {
    "code": "INVALID_AMOUNTS",
    "message": "itemsSubtotal must be 2700",
    "path": "amounts.itemsSubtotal",
    "requestId": "6b1f2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d"
  }
}