Documentation Index
Fetch the complete documentation index at: https://docs.shakesco.com/llms.txt
Use this file to discover all available pages before exploring further.
For the complete documentation index, see llms.txt.
Events define the actions customers complete to earn tokens, for example signup, birthday, or buy-ticket. Each event has a token allocation and a flag controlling whether it can be claimed multiple times.
You can also manage events from the Customer Rewards dashboard.
POST /set-event-details
Create or update a token claim event on your BusinessToken contract.
Lowercase event identifier (e.g. "signup", "birthday", "buy-ticket")
Tokens awarded per claim (e.g. 5)
true = one-time event, false = can be claimed multiple times
{ "tx_hash": "0xabc123..." }
GET /event-details?event_name=…
Retrieve the allocation and claim policy for a specific event.
const res = await fetch(
"https://tokens.shakesco.com/event-details?event_name=signup",
{ headers: { Authorization: `Bearer ${API_KEY}` } }
);
{
"allocation": "5000000000000000000",
"should_not_claim_twice": true
}
GET /event-counter
Total number of events configured on your BusinessToken contract.
const res = await fetch("https://tokens.shakesco.com/event-counter", {
headers: { Authorization: `Bearer ${API_KEY}` },
});
const { event_count } = await res.json();
GET /event-by-index?index=0
Get the name of an event by its index (0-based). Combine with /event-counter to list all events.
for (let i = 0; i < eventCount; i++) {
const res = await fetch(
`https://tokens.shakesco.com/event-by-index?index=${i}`,
{ headers: { Authorization: `Bearer ${API_KEY}` } }
);
const { event_name } = await res.json();
console.log(event_name); // "signup", "birthday", ...
}
{ "event_name": "signup" }
GET /token-info
Returns basic information about your BusinessToken contract.
const res = await fetch("https://tokens.shakesco.com/token-info", {
headers: { Authorization: `Bearer ${API_KEY}` },
});
{
"name": "Launchpad Token",
"symbol": "SLP",
"image": "https://purple-selective-warbler-371.mypinata.cloud/ipfs/Qm...",
"total_supply": "20999900.0"
}