Versioning

The version is in the URL: https://api.poweredbyaura.com/v1. Everything in v1 is described by one OpenAPI file, which you can download and use to generate a client.

Changes that can happen within v1

These do not break a well-built integration, so they are made without a new version and recorded in the changelog:

• New endpoints.
• New optional request fields.
• New fields in responses and webhook payloads.
• New error codes and failure codes.
• New values in metadata-style free-form objects such as details.

Build your integration to ignore fields it does not know and to handle unknown codes by HTTP status and retryable.

Changes that need a new version

• Removing or renaming a field, endpoint or event.
• Changing a field’s type or meaning.
• Adding a new purchase state.
• Making an optional request field required.

A breaking change ships as a new version, such as /v2, alongside the old one. The old version keeps working for at least six months after the new one is released, and your technical contact tells you before that period starts.

Webhook events

New event types are only sent to you once you ask for them, so a new event type never reaches an endpoint that does not expect it.