Documentation

Introduction

With Stampede's API, you'll have the opportunity to interact with Stampede's infrastructure like pushing customer data, creating an in-venue order or creating a WiFi interaction.

Base URL's

Begin your integration by referencing the following base URL.

https://global.stampede.ai/

Rate Limiting

To maintain the performance and integrity of our services, Stampede has implemented a rate-limiting policy. Users are allowed up to 100 requests every 15 minutes.

Reference

20 endpoints across 6 areas. Start with Authentication, then read whichever area you are integrating.

Introduction

Authentication

For authenticating requests with Stampede, Bearer Tokens are included in the request headers to ensure secure and authorised access.

  • POSThttps://global.stampede.ai/oauth/token

Organisations and venues

Venues

When generating a new [`client_id`](/authentication.md#generating-a-client_id-and-client_secret) this will then be associated to an organisation ID, o…

  • GET/v1/venues

Guests

Guests

Guests are where all of the data lives. With these requests, you're able to search for guests and create new guests within Stampede.

  • GET/v1/guests
  • GET/v1/guests/:guest_id
  • POST/v1/guests
Tags

Tags are where you'll have the ability to tag customers with a certain condition, for example, "Golf Member" then within Stampede, you'll be able to c…

  • GET/v1/guests/:guest_id/tags
  • PUT/v1/guests/:guest_id/tags
  • DELETE/v1/guests/:guest_id/tags/by-name
Order

Ordering is where you'll be able to create an ordering interaction with a certain customer or view orders from a certain customer.

  • GET/v1/guests/:guest_id/order
  • POST/v1/guests/:guest_id/order
Booking

Booking is where you'll be able to create a booking interaction with a certain customer.

  • POST/v1/guests/:guest_id/booking
WiFi

WiFi is where you'll be able to view who owns a certain device using the MAC address or create a WiFi session for a customer.

  • GET/v1/guests/wifi
  • POST/v1/guests/:guest_id/wifi
Form

Create form submissions on behalf of a guest

  • POST/v1/guests/:guest_id/form

Marketing

Deal Codes

Deal codes allow Stampede users to uniquely send a code for each marketing email that gets sent out from Stampede.

  • GET/v1/deal
  • POST/v1/deal
  • GET/v1/code/search
  • POST/v1/code/revoke

Workflows

Workflows

Workflows allow you to trigger automation within Stampede by sending an incoming event.

  • POST/v1/workflows/incoming-event
  • POST/v1/workflows/{workflowId}/workflow-runs

Going live

Going Live

Once you've completed your app, you'll be eligible to enter the Stampede Marketplace (Where you generated your API keys from).