Metric Deliveries

Send Capture and eBay metrics to your own systems, on a schedule.

Admins onlyOpen in Superlister

Overview

Destinations

Signing secret

Subscriptions

Recent deliveries

Receiving deliveries

Click the screen or use the arrow keys to step through.

01 / 23

01Overview

Metric Deliveries: Open Settings and choose Metric Deliveries, under General. It sends the metrics you choose to a web address you own, as signed JSON (a webhook), on the days and at the times you set. It’s for connecting Superlister to your own reporting tools, so you’ll usually set it up with whoever looks after those. All times are UK time and follow British Summer Time. Only admins can open it.

02Destinations

A destination is the address deliveries are sent to. A workspace can have up to 20.

Your destinations: Each destination shows its name, whether it’s Enabled or Disabled, how it authenticates and its address. Choose Edit to change it in the same form you use to add one.
Add destination: Opens the destination form below the list.
Name and HTTPS URLRequired: Name is a label for the destination, such as Reporting system. HTTPS URL is the address that receives the deliveries.
Endpoint authentication: Every delivery is signed. Choose HMAC signature only, or add a credential on top: HMAC + Bearer token asks for a Bearer token, and HMAC + Basic authentication asks for a Username and Password. When you edit a destination, leave these blank to keep the saved credentials.
Destination enabled: On by default. Turn it off to pause everything sent to this destination. A subscription can’t be made active, or send a test, while its destination is off.
Save destination: Saves the destination. Changing a destination cancels any deliveries still waiting to go out with its old details. Cancel closes the form without saving.

03Signing secret

Your receiving system uses this secret to check that a delivery really came from Superlister.

Save your signing secret: When you add a destination, its signing secret is shown once, at the top of the page. Copy it into your receiving system with the copy button, then choose I have saved it. You can’t see it again afterwards.
Rotate secret: Creates a new signing secret if the old one is lost or exposed, and shows it once in the same way. After you confirm, update your receiving system straight away. Deliveries still waiting to go out with the old secret are cancelled.

04Subscriptions

A subscription says which metrics to send, to which destination, and when. A workspace can have up to 50.

Your subscriptions: Each subscription shows whether it’s Active or Paused, how many metrics it sends, its destination and when it next sends. Choose Edit to change it.
Send test: Sends a delivery straight away, filled with placeholder values, so you can check your receiving system works. It appears under Recent deliveries shortly after. You can send up to five tests a minute.
Create subscription: Opens the subscription form. It’s greyed out until you’ve added a destination.
Subscription name and DestinationRequired: Give the subscription a name, such as Daily store performance, and choose where to send it. The first enabled destination is picked for you. Disabled destinations are marked (disabled).
Metrics: Each box is one metric, such as Images per user, eBay sold value or eBay current open auction value. The text under it explains how it’s counted. The cross removes it; a subscription always keeps at least one. The same metric can’t appear twice with the same reporting period.
User performance (combined): Sends one block per person. Under Fields per user, choose any of Number of listings, Number of images, Average time between listings and Average images per listing; at least one stays on. Include pre-calculated aggregates adds workspace totals, each available only when its matching field is on. Timing values are in seconds.
Reporting period: The time each delivery covers: Today, the Current calendar week, month or year, or Last X minutes / hours / days, up to 366 days. Include today up to the report time adds today’s activity so far to the calendar periods. Calendar weeks start on Monday. eBay current open auction value is a snapshot, so it has no period.
Add metric: Adds another metric, up to 20. If you’ve added separate per-user metrics, Combine user metrics merges those with the same period into one User performance (combined) metric.
Delivery schedule: Choose the days to send on, then First send, Last send (included) and Every (minutes), from 15 to 1440. Both the first and last send happen, so pick a frequency that lands exactly on the last send time, for example 09:00 to 17:00 every 60 minutes.
Subscription active: Off for a new subscription. Turn it on to start sending on the schedule; turn it off to pause. Its destination must be enabled.
Example payload: Shows the JSON your system will receive, with placeholder values. It updates as you change the form, once the name, metrics and schedule are valid.
Save subscription: Saves the subscription. Cancel closes the form without saving.

05Recent deliveries

Recent deliveries: Lists the latest 50 deliveries and updates every 15 seconds while the page is open. Use Subscription to show one subscription’s deliveries. Open a delivery to see each attempt. Superlister retries temporary errors by itself; a delivery your system rejects, or that keeps failing, is marked failed. View payload shows exactly what was sent, and Retry delivery, shown only for failed deliveries, sends it again. Tests are marked Test.

06Receiving deliveries

Receiving and verifying deliveries: Each delivery carries webhook-id, webhook-timestamp and webhook-signature headers. Your system should check the signature with the signing secret, reject deliveries more than five minutes old, and ignore an ID it has already seen. Failed deliveries may be retried with the same ID. Money values are in pounds, sent as decimal strings. Share this panel with whoever builds your receiving system.