The Ambassador Developer Hub

Welcome to the Ambassador developer hub. You'll find comprehensive guides and documentation to help you start working with Ambassador as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference


You can authenticate with the Ambassador API using your API username and API key.

You can find this information on your account settings page.


Your API key should never be shared or exposed. We provide an embeddable JavaScript snippet and SDKs for client-side integrations.


  • API Username (ex. username)
  • API Token (ex. xxxxxx)

URL Structure for an API Call:[[API_USERNAME]]/[[API_TOKEN]]/json/event/record



Passing your API token in the request header

Alternatively, you can add your API key in the request header. The requires a change to the URL structure. For example:

This call:[[API_USERNAME]/[[API_TOKEN]]/json/event/record

changes to:[[API_USERNAME]]/token/json/event/record

After changing the URL structure, you will need to pass your token in the header in the format:
Authorization: Token [[API_TOKEN]]

For example, if your API Token was xxxxxxx, the header would be:
Authorization: Token xxxxxxx

Updated about a year ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.