4 Webhook endpoints

Protocol

All webhook endpoints must be accessible by HTTPS protocol. HTTP or other protocols are not allowed.

Acknowledging webhook notifications and timeouts

When receiving a webhook notification, the endpoint must respond with HTTP 200 within 10 seconds in order to acknowledge all events in notification. All other HTTP response codes or timeouts are treated as an error indicator and will resend event data later.

Note: Redirection responses (HTTP 3xx, especially 301 "Moved permanently", 302 "Moved temporarily", 307 "Temporary redirect" and 308 "Permanent redirect") are not interpreted and considered as error indicators.

Resent event data

Event data, that is not acknowledged correctly by the webhook endpoint is resent after a period of time. The endpoint must be able to deal with resent event data. The endpoint can use the event ID contained in each event data to identify such data.

Resent event data may be combined with other event data in a webhook message.

Event timestamps

Due to several reasons (different event types, resent event data, ...), event data cannot be sent in chronological order in all cases. For such cases, each event data is augmented with a timestamp to indicate when the event occurred.

Retrieving additional information

Event data in webhook notifications provide a set of basic common information.

Additional data can be retrieved by SOAP webservices or Rest API. It is highly recommended to store data locally, that has already been retrieved and use SOAP-/Rest API only if needed.