Aurora releases a new API version when we make backward-incompatible changes to the Aurora API. Your Aurora API version controls the API behavior you see and is set when we first create your application. When we change the API in a backward-incompatible way (something that you can expect to happen every 1-2 years), we release a new dated version and support it for a minimum of 12 months. To avoid disrupting your integration and breaking your code, we don’t change your version automatically. It is your responsibility to upgrade when you are ready.

Upgrading your API version

Upgrading API versions for partner applications is currently a manual process. Please reach out to your Aurora representative if you wish to upgrade to the latest version.

Please note that upgrading the version for your partner application will upgrade the temporary keys for all your tenant integrations as well, so make sure that your back-end has all the necessary changes to support the new version before upgrading.

API versions

The following are all breaking changes to the Aurora Partner APIs. Click here to see the breaking changes for the corresponding version of the Aurora Sync API.

2024.05

• Changed application_partners to partner_applications in all paths. For example, /application_partners/{partner_application_id}/webhooks is now /partner_applications/{partner_application_id}/webhooks. Applies to webhooks, components and create_token paths.
• The root element in responses for the List Webhooks endpoint has been updated fromapplication_partner_webhooks to partner_application_webhooks
• The root element in responses for the Retrieve Webhook, Create Webhook, and Update Webhook endpoints have been updated from application_partner_webhookto partner_application_webhook
• The root element in requests for the Create Webhook, Update Webhook and Trigger Webhook endpoints has been updated from application_partner_webhookto partner_application_webhook.