The widget API is structured around REST, HTTP, and JSON. It uses HTTP methods for indicating the action to take on a resource and HTTP status codes for expressing error states.

Base URL

The API is accessed using a base URL:

  • Sandbox:
  • Prod:

All API calls should be made over HTTPS.
Generally, the URL will be in the form https://<base-url>/v2/<resource>, for example


All requests to the API are authenticated by providing your API key. The API key should be provided in a form of Bearer authentication:
Authorization: Bearer <token>


Each business account can have multiple API keys to run different widget product instances.