Create API keys and webhooks
Create a client ID and secret for an app that uses the Stampede API, and send customer events to your own URL.
2 min read · Updated
In short: click New API key and copy the client secret straight away. It is never shown again.
Create an API key
- Go to Marketplace & API › API Keys & Webhooks.
- Click New API key.
- Enter an Application name and click Create.
- Copy the Client ID and Client secret, then click I've saved my credentials.
Add a webhook
- Under Webhooks, click New webhook.
- Enter the URL that should receive events.
- Choose a Venue or All venues.
- Choose an Event (On customer create or On interaction create), then click Create.
What the API can do
The API is built around your guests. With it, an app can:
- List your venues.
- Find, create and tag guests.
- Add a guest's orders, bookings, Wi-Fi visits and form answers to their profile.
- Send events into your automated workflows.
It does not read your booking diary, table plans, deposits or reports, so calls for those are expected to fail. It is for sending guests and visits as they happen. To bring in a list of past guests, import a CSV instead.
Every endpoint is in the developer guide at https://stampede.ai/developer, also linked from Documentation in the same menu.
Check it worked
A webhook's dot is grey until the first event is sent, and green once deliveries succeed.
If it does not work
Only some guests come back
Long lists come back a page at a time. Use the cursor in each response to ask for the next page, until there are none left.
A guest search returns an error
Check the limit you pass is a whole number, such as 100.
Calls fail with your key
Lost a client secret, or has someone who had it left? Remove the key and create a new one. A red webhook dot means every delivery so far has failed: check your endpoint is online and accepts the request.
You need a venue's ID
It is in the web address of any venue page in Stampede, straight after venues/.
Email support at agent@stampede.ai with:
- The application name or webhook URL.
- The request you sent and the error that came back.
Good to know
- An API key lets your own app read and write your organisation's data.
- FOH and IT cannot see Marketplace & API.
Related articles
A deposit did not come off the Square bill
The deposit only moves onto the Square bill when the booking is marked Seated. How to push a missing one, and what to do after a table move.Products, prices or customers are not syncing from Square
A Square change is missing in Stampede? Run Sync from Square on Products, then check the item is stocked at that venue in Square.Is it a Square question or a Stampede one?
Till layout, cashing up, Z reports and handheld item tools live in Square. Bookings, deposits, table matches and ordering menus live in Stampede.Square bill missing from a booking, or on the wrong one
Square bills find their booking through the table. Fix Table Mappings, move a bill to the right booking, or unlock its tables.