Skip to content
Square and integrations

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.

1 min read

In short: click New API key and copy the client secret straight away. It is never shown again.

Create an API key

  1. Go to Marketplace & API › API Keys & Webhooks.
  2. Click New API key.
  3. Enter an Application name and click Create.
  4. Copy the Client ID and Client secret, then click I've saved my credentials.

Add a webhook

  1. Under Webhooks, click New webhook.
  2. Enter the URL that should receive events.
  3. Choose a Venue or All venues.
  4. Choose an Event (On customer create or On interaction create), then click Create.

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

  • A red dot means every delivery so far has failed. Check your endpoint is online and accepts the request.
  • Lost a client secret? Remove the key and create a new one.

Email support at agent@stampede.ai with:

  • The application name or webhook URL.
  • The time of an event that did not arrive.

Good to know

  • An API key lets your own app read and write your organisation's data.
  • Documentation in the same menu opens the developer guide.
  • FOH and IT cannot see Marketplace & API.

Still stuck, or have account-specific questions?

  1. Log in to stampede.ai
  2. Press Command + /On Windows, press Ctrl + /.
  3. Ask the agentIt answers about your own venues and account.
Log in to stampede.ai