🔐 Read Keys: Letting Your Other Sites See Support History

The connection also runs the other way. Give another site of yours a read key and it can ask the desk about a customer, so a membership site or a dashboard can show "3 tickets, 1 open" next to a person without anybody opening the desk.

Where to find it:

Open Settings, Integrations and scroll to For developers. Open Let another site of yours read support history.

Making a key:

1. Type a label that says where the key will be used, for example Membership site.
2. Press Create Read Key.
3. The key is shown once in a green box with a Copy button. Copy it then.

Afterwards only a short hint is kept, the first and last few characters, so you can tell your keys apart. Keys are stored as a one-way hash, so nobody who can read your database can recover them.

Your keys:

The table lists each key's label, its hint, when it was created and when it was last used. Revoke beside a key cuts it off at once, and only that key, so you can stop one site without touching the others. A key that is never used is easy to spot.

What a key can read:

For one email address: the customer's name, how many tickets they have, how many are open and how many solved, a count per status, the first and last ticket dates, and the subject, status, priority, product and category of their ten most recent tickets. Spam is counted separately. A second address returns desk totals for a dashboard tile: open tickets, new tickets in the last seven days and how many the AI answered by itself.

What is never sent:

Message text, private notes, drafts, and anything about other customers. Keys are read-only, so nothing can be created, changed or deleted with one. Requests are limited to 120 a minute per address.

For your developer:

Send the key in the X-ASD-Key header. The customer address is /wp-json/asd/v1/customer with an email parameter, and the totals address is /wp-json/asd/v1/stats. The exact addresses for your site are printed under the key table. A customer with no tickets returns 404, a missing or wrong key returns 403, and too many requests return 429.

Good uses:

• Show "tickets, open" beside each member on your membership site.
• A dashboard tile with open tickets and new tickets this week.
• Your Mailer showing whether a subscriber has an open ticket before a broadcast.

A real example:

Yoursite Studio has two keys: Membership site, used an hour ago, and Studio dashboard, not used yet. The members area shows each member "2 tickets, 0 open" beside their profile.

Step by step, giving a site access:

1. Make a key labelled for that site with Create Read Key, and copy it.
2. On the other site, store the key where it calls the desk.
3. Have it send the key in the X-ASD-Key header to the customer address with ?email= and the customer's email.
4. Check Last used in the key table to see it working.

Tips:

• One key per site, labelled by site, makes revoking simple.
• To pull data from another site into the desk instead, see Connecting Other Sites With Keys.