Event notifications
A webhook notifies your system about platform events — listings, responses, moderation, messages, orders — without polling.
How to connect
- In the "API" section, in the "Webhooks" block press "Add webhook".
- Enter the "URL" of your system and tick the "Events".
- Save the webhook.
- Press "Signing secret" in the address row and store the secret in your system.
From your own system the addresses are created, listed and removed with a key holding the "Manage webhooks" permission — the /rest/v1/identity/seller/webhooks operations, the secret — /rest/v1/identity/seller/webhooks/{id}/secret.
How to receive
- The body is JSON:
type— the event type,timestamp— the moment,data— the data; thedataschema of every event is in the "API reference". - The signature follows Standard Webhooks: the
webhook-id,webhook-timestamp,webhook-signatureheaders; verify it with the standard library before applying the payload. - Answer 2xx at once and process asynchronously on your side; the platform retries a failed delivery.
Delivery log
- Press "Delivery log" in the address row: events newest first with the outcome and the next attempt.
- "Retry delivery" at an event sends it once more.
- "Test delivery" sends a signed example of the chosen event — a receipt check before the first real one.
An event whose content was removed after its retention period cannot be retried.
Was this article helpful?
Did not find the answer to your question?
Create a request