docs: v0.12.0 migration guide & documentation

README.md

@@ -79,7 +79,7 @@ See the [Outpost Features](https://outpost.hookdeck.com/docs/features) for more
 - [Quickstarts](https://outpost.hookdeck.com/docs/quickstarts)
 - [Features](https://outpost.hookdeck.com/docs/features)
 - [Guides](https://outpost.hookdeck.com/docs/guides)
-- [API Reference](https://outpost.hookdeck.com/docs/references/api)
+- [API Reference](https://outpost.hookdeck.com/docs/api)
 - [Configuration Reference](https://outpost.hookdeck.com/docs/references/configuration)
 
 _The Outpost documentation is built using the [Zudoku documentation framework](https://zuplo.link/outpost)._
@@ -180,7 +180,7 @@ Create a tenant with the following command, replacing `$TENANT_ID` with a unique
 
 
 ```sh
-curl --location --request PUT "$OUTPOST_URL/api/v1/$TENANT_ID" \
+curl --location --request PUT "$OUTPOST_URL/api/v1/tenants/$TENANT_ID" \
 --header "Authorization: Bearer $API_KEY"
 ```
 
@@ -189,7 +189,7 @@ Run a local server exposed via a localtunnel or use a hosted service such as the
 Create a webhook destination where events will be delivered to with the following command. Again, replace `$TENANT_ID` and `$API_KEY`. Also, replace `$URL` with the webhook destinations URL:
 
 ```sh
-curl --location "$OUTPOST_URL/api/v1/$TENANT_ID/destinations" \
+curl --location "$OUTPOST_URL/api/v1/tenants/$TENANT_ID/destinations" \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer $API_KEY" \
 --data '{
@@ -225,7 +225,7 @@ Check the logs on your server or your webhook capture tool for the delivered eve
 Get an Outpost portal link for the tenant:
 
 ```sh
-curl "$OUTPOST_URL/api/v1/$TENANT_ID/portal" \
+curl "$OUTPOST_URL/api/v1/tenants/$TENANT_ID/portal" \
 --header "Authorization: Bearer $API_KEY"
 ```
 
@@ -241,7 +241,7 @@ Open the `redirect_url` link to view the Outpost portal.
 
 ![Dashboard homepage](docs/public/images/dashboard-homepage.png)
 
-Continue to use the [Outpost API](https://outpost.hookdeck.com/docs/references/api) or the Outpost portal to add and test more destinations.
+Continue to use the [Outpost API](https://outpost.hookdeck.com/docs/api) or the Outpost portal to add and test more destinations.
 
 ## Contributing
 

contributing/step-by-step.md

@@ -82,15 +82,15 @@ OK%
 1: Create a tenant with ID: 123
 
 ```sh
-$ curl --location --request PUT 'localhost:3333/api/v1/123' \
+$ curl --location --request PUT 'localhost:3333/api/v1/tenants/123' \
 --header 'Authorization: Bearer apikey'
 {"id":"123","created_at":"..."}%
 ```
 
 2: Create a webhook-type destination
 
 ```sh
-$ curl --location 'localhost:3333/api/v1/123/destinations' \
+$ curl --location 'localhost:3333/api/v1/tenants/123/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer apikey' \
 --data '{
@@ -108,7 +108,7 @@ $ curl --location 'localhost:3333/api/v1/123/destinations' \
 Feel free to confirm that the destination is successfully created either in Redis or by listing the destination for tenant 123:
 
 ```sh
-$ curl --location 'localhost:3333/api/v1/123/destinations' \
+$ curl --location 'localhost:3333/api/v1/tenants/123/destinations' \
 --header 'Authorization: Bearer apikey'
 ```
 
@@ -149,7 +149,7 @@ $ go run ./cmd/destinations/webhooks
 You can also confirm the data by checking the data in ClickHouse or querying the Event API:
 
 ```sh
-$ curl --location 'localhost:3333/api/v1/123/events' \
+$ curl --location 'localhost:3333/api/v1/tenants/123/events' \
 --header 'Authorization: Bearer apikey'
 ```
 
@@ -160,7 +160,7 @@ $ curl --location 'localhost:3333/api/v1/123/events' \
 To get the portal URL:
 
 ```sh
-$ curl --location 'localhost:3333/api/v1/123/portal' \
+$ curl --location 'localhost:3333/api/v1/tenants/123/portal' \
 --header 'Authorization: Bearer apikey'
 {"redirect_url":"http://localhost:3333?token=eyJH..."}%
 ```

docs/pages/destinations.mdx

@@ -26,7 +26,7 @@ See the [roadmap](/docs/references/roadmap) for planned destination types. To be
 Destinations can be registered through the tenant portal or via the API. Each destination type has its own configuration and credentials. Refer to the [Create Destination API](/docs/api/destinations#create-destination) for the required `config` and `credentials` fields for each destination type.
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/aws-kinesis.mdx

@@ -26,7 +26,7 @@ Stream events to an Amazon Kinesis Data Stream.
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/aws-s3.mdx

@@ -27,7 +27,7 @@ Store events in an Amazon S3 bucket.
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/aws-sqs.mdx

@@ -24,7 +24,7 @@ Send events to an Amazon SQS queue.
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/azure-service-bus.mdx

@@ -21,7 +21,7 @@ Send events to an Azure Service Bus queue or topic.
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/gcp-pubsub.mdx

@@ -25,7 +25,7 @@ Publish events to a Google Cloud Pub/Sub topic.
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/hookdeck.mdx

@@ -25,7 +25,7 @@ This destination has no configuration fields. Routing and delivery settings are
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/rabbitmq.mdx

@@ -24,7 +24,7 @@ Send events to a RabbitMQ exchange via AMQP.
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/destinations/webhook.mdx

@@ -66,7 +66,7 @@ If `secret` is not provided, one will be auto-generated. Tenants cannot modify s
 ### Example
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{
@@ -85,7 +85,7 @@ Secret rotation allows you to change the signing secret without downtime. During
 To rotate a secret, set `rotate_secret` to `true` when updating a destination:
 
 ```sh
-curl --location --request PATCH 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations/<DESTINATION_ID>' \
+curl --location --request PATCH 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations/<DESTINATION_ID>' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{
@@ -104,7 +104,7 @@ When rotation is triggered:
 To customize the rotation window, set `previous_secret_invalid_at`:
 
 ```sh
-curl --location --request PATCH 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations/<DESTINATION_ID>' \
+curl --location --request PATCH 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations/<DESTINATION_ID>' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{
@@ -228,7 +228,7 @@ Standard Webhooks secrets use the format `whsec_<base64>`, which is automaticall
 Tenants can add custom HTTP headers to webhook requests. This is useful for authentication, routing, or passing additional metadata to their endpoint.
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/features/filter.mdx

@@ -273,7 +273,7 @@ Process only high-value orders:
 Filters are set when creating or updating a destination via the `filter` field:
 
 ```sh
-curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
+curl --location 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{
@@ -293,7 +293,7 @@ curl --location 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations' \
 To remove a filter from a destination, set the `filter` field to an empty object:
 
 ```sh
-curl --location --request PATCH 'https://<OUTPOST_API_URL>/api/v1/<TENANT_ID>/destinations/<DESTINATION_ID>' \
+curl --location --request PATCH 'https://<OUTPOST_API_URL>/api/v1/tenants/<TENANT_ID>/destinations/<DESTINATION_ID>' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/features/multi-tenant-support.mdx

@@ -15,7 +15,7 @@ View the Tenant API docs [here](/docs/api/tenants).
 Create a tenant with the following command, replacing `<TENANT_ID>` with a unique identifier such as "your_org_name", and the `<API_KEY>` with the value you set in your Outpost installation `API_KEY` environment variable:
 
 ```sh
-curl --location --request PUT 'localhost:3333/api/v1/<TENANT_ID>' \
+curl --location --request PUT 'localhost:3333/api/v1/tenants/<TENANT_ID>' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>'
 ```

docs/pages/features/topics.mdx

@@ -23,7 +23,7 @@ Events published for a given tenant are evaluated against the destination's topi
 Create destinations with the following request, replacing `<TENANT_ID>` and `<API_KEY>`. The `<TYPE>` must be one of the supported [event destination types](#event-destination-types), and the `<CONFIG>` contents will depend on the event destination type.
 
 ```sh
-curl --location 'localhost:3333/api/v1/<TENANT_ID>/destinations' \
+curl --location 'localhost:3333/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{
@@ -36,7 +36,7 @@ curl --location 'localhost:3333/api/v1/<TENANT_ID>/destinations' \
 For example, the following creates a webhook destination that subscribes to all topics (`*`) and delivers published events to the URL `https://example.test/webhooks`:
 
 ```sh
-curl --location 'localhost:3333/api/v1/<TENANT_ID>/destinations' \
+curl --location 'localhost:3333/api/v1/tenants/<TENANT_ID>/destinations' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <API_KEY>' \
 --data '{

docs/pages/guides.mdx

@@ -20,6 +20,7 @@ Welcome to the Outpost guides section. These guides will help you get the most o
 
 - [Migrate Existing Webhooks to Outpost](/guides/migrate-to-outpost)
 - [Schema Migration](/guides/migration)
+- [Upgrade to v0.12](/guides/upgrade-v0.12)
 
 ## Next Steps
 

docs/pages/guides/building-your-own-ui.mdx

@@ -21,7 +21,7 @@ Proxying through your own API can be useful if you want to limit access to some
 You can generate a JWT token by using the [Tenant JWT Token API](/docs/api/tenants#get-tenant-jwt-token).
 
 ```bash
-curl --location 'localhost:3333/api/v1/<TENANT_ID>/token' \
+curl --location 'localhost:3333/api/v1/tenants/<TENANT_ID>/token' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Bearer <API_KEY>' \
 ```
@@ -43,7 +43,7 @@ const [destination_types, setDestinationTypes] = useState([]);
 
 const fetchDestinations = async () => {
   // Get the tenant destinations
-  const response = await fetch(`${API_URL}/api/v1/destinations`, {
+  const response = await fetch(`${API_URL}/api/v1/tenants/destinations`, {
     headers: {
       Authorization: `Bearer ${token}`,
     },
@@ -341,7 +341,7 @@ Events are listed using the [List Events API](/docs/api/events#list-events). You
 const [events, setEvents] = useState([]);
 
 const fetchEvents = async () => {
-  const response = await fetch(`${API_URL}/api/v1/events`, {
+  const response = await fetch(`${API_URL}/api/v1/tenants/events`, {
     headers: {
       Authorization: `Bearer ${token}`,
     },

docs/pages/guides/publish-from-gcp-pubsub.mdx

@@ -6,7 +6,7 @@ This guide provides information on using GCP Pub/Sub to publish events to Outpos
 
 ## Message Structure
 
-GCP Pub/Sub messages should have the same payload structure as the [Publish API endpoint](/docs/references/api#publish).
+GCP Pub/Sub messages should have the same payload structure as the [Publish API endpoint](/docs/api/publish).
 
 ```json
 {

docs/pages/guides/publish-from-rabbitmq.mdx

@@ -6,7 +6,7 @@ This guide provides information on using RabbitMQ to publish events to Outpost.
 
 ## Message Structure
 
-RabbitMQ messages should have the same payload structure as the [Publish API endpoint](/docs/references/api#publish).
+RabbitMQ messages should have the same payload structure as the [Publish API endpoint](/docs/api/publish).
 
 ```json
 {

docs/pages/guides/publish-from-sqs.mdx

@@ -6,7 +6,7 @@ This guide provides information on using SQS to publish events to Outpost.
 
 ## Message Structure
 
-SQS messages should have the same payload structure as the [Publish API endpoint](/docs/references/api#publish).
+SQS messages should have the same payload structure as the [Publish API endpoint](/docs/api/publish).
 
 ```json
 {