Merge pull request #26 from tinybirdco/readmes

readmes

Author: sdairs

apps/web/package.json

@@ -19,6 +19,7 @@
     "nuqs": "^2.2.3",
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
+    "react-markdown": "^9.0.1",
     "recharts": "^2.15.0",
     "tailwind-merge": "^2.5.5",
     "tailwindcss-animate": "^1.0.7"

apps/web/pnpm-lock.yaml

@@ -0,0 +1,83 @@
+# Send Auth0 Logs Streams to Tinybird
+
+[Auth0](https://auth0.com) is a developer-focused user management platform to handle user authentication with many prebuilt UI components. By integrating Auth0 with Tinybird, you can analyze your user authentication data in real time and enrich it with other data sources.
+
+Some common use cases for sending Auth0 logs to Tinybird include:
+
+1. Tracking net user and organization growth.
+2. Monitoring user churn.
+3. Identifying common auth errors.
+4. Creating custom dashboards for auth analysis.
+5. User authentication audit logs.
+
+Read on to learn how to send data from Auth0 Logs Streams to Tinybird.
+
+## Before you start
+
+Before you connect Auth0 Logs Streams to Tinybird, ensure:
+
+* You have an Auth0 account.
+* You have a Tinybird Workspace.
+
+## Connect Auth0 to Tinybird
+
+1. From the Auth0 dashboard, select **Monitoring** > **Streams**.
+   
+2. Select **Create Stream**.
+
+3. In Tinybird, create a Data Source, called `auth0_logs` in this example, with the following schema:
+
+```tb {% title = 'Data Source schema for Auth0 logs streams %}
+SCHEMA >
+    `log_id` String `json:$.log_id`,
+    `type` String `json:$.data.type` DEFAULT 'unknown',
+    `date` DateTime64(3) `json:$.data.date` DEFAULT now(),
+    `client_name` LowCardinality(String) `json:$.data.client_name` DEFAULT 'unknown',
+    `user_id` String `json:$.data.user_id` DEFAULT 'unknown',
+    `connection_id` Nullable(String) `json:$.data.connection_id`,
+    `ip` Nullable(String) `json:$.data.ip`,
+    `data_log_id` Nullable(String) `json:$.data.log_id`,
+    `user_name` Nullable(String) `json:$.data.user_name`,
+    `client_id` Nullable(String) `json:$.data.client_id`,
+    `client_ip` Nullable(String) `json:$.data.client_ip`,
+    `tenant_name` Nullable(String) `json:$.data.tenant_name`,
+    `description` Nullable(String) `json:$.data.description`,
+    `connection` Nullable(String) `json:$.data.connection`,
+    `audience` Nullable(String) `json:$.data.audience`,
+    `scope` Array(Nullable(String)) `json:$.data.scope[:]`,
+    `user_agent` Nullable(String) `json:$.data.user_agent`,
+    `hostname` Nullable(String) `json:$.data.hostname`,
+    `strategy` Nullable(String) `json:$.data.strategy`,
+    `strategy_type` Nullable(String) `json:$.data.strategy_type`,
+    `tracking_id` Nullable(String) `json:$.data.tracking_id`,
+    `event_schema_version` Nullable(String) `json:$.data.['$event_schema'].version`,
+    `auth0_client` JSON `json:$.data.auth0_client` DEFAULT '{}',
+    `details` JSON `json:$.data.details` DEFAULT '{}'
+
+ENGINE "MergeTree"
+ENGINE_PARTITION_KEY "toYYYYMM(date)"
+ENGINE_SORTING_KEY "type, user_id, date"
+```
+
+Using the [JSON Data Type](/sql-reference/data-types/json) you can store the semi-structured data you receive from Auth0 Logs Streams in a single column. You can later retrieve various events and their metadata as needed in your Pipes.
+
+4. In Tinybird, copy a token with privileges to append to the Data Source you created. You can use the admin token or create one with the required scope.
+
+5. Back in Auth0, paste the Events API URL in your Webhook Endpoint URL. Use the query parameter `name` to match the name of the Data Source you created in Tinybird. For example: 
+
+```
+https://api.tinybird.co/v0/events?name=auth0_logs&token=TOKEN
+```
+
+Content Type is `application/json` and Content Format is `JSON Lines`.
+
+1. Select the any event category to filter, like `All`, and a date in case you want to perform some backfilling. Then select **Save**.
+
+2. You're done. Any of the Auth0 Log Streams events you selected is automatically sent to Tinybird through the [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api).
+
+You can check the status of the integration from the **Health** tab in the created webhook or from the **Log** tab in the Tinybird `auth0_logs` Data Source. 
+    
+## See also
+
+* [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api)
+* [Auth0 Logs Streams](https://auth0.com/docs/customize/log-streams/custom-log-streams)

apps/web/public/content/auth0.md

@@ -0,0 +1,64 @@
+# Send Clerk webhooks to Tinybird
+
+[Clerk](https://clerk.com/) is a developer-focused user management platform to handle user authentication with many prebuilt UI components. By integrating Clerk with Tinybird, you can analyze your user authentication data in real time and enrich it with other data sources.
+
+Some common use cases for sending Clerk webhooks to Tinybird include:
+
+1. Tracking net user and organization growth.
+2. Monitoring user churn.
+3. Identifying common auth errors.
+4. Creating custom dashboards for auth analysis.
+5. Enriching other data sources with real-time auth metrics.
+
+Read on to learn how to send data from Clerk to Tinybird.
+
+## Before you start
+
+Before you connect Clerk to Tinybird, ensure:
+
+* You have a Clerk account.
+* You have a Tinybird Workspace.
+
+## Connect Clerk to Tinybird
+
+1. From the Clerk UI, select **Configure** > **Webhooks**.
+   
+2. Select **Add Endpoint**.
+
+3. In Tinybird, create a Data Source, called `clerk` in this example, with the following schema:
+
+```tb {% title = 'Data Source schema for Clerk events %}
+SCHEMA >
+  'ingest_timestamp' DateTime `json:$.time` DEFAULT now(),
+  'record' JSON `json:$`
+
+ENGINE "MergeTree"
+ENGINE_SORTING_KEY "ingest_timestamp"
+ENGINE_TTL ""
+ENGINE_PARTITION_KEY ""
+```
+
+Using the [JSON Data Type](/sql-reference/data-types/json) you can store the semi-structured data you receive from Clerk in a single column. You can later retrieve various events and their metadata as needed in your Pipes.
+
+4. Back in Clerk, paste the Events API URL in your Webhook Endpoint URL. Use the query parameter `name` to match the name of the Data Source you created in Tinybird, for example: 
+
+```
+https://api.tinybird.co/v0/events?name=clerk
+```
+
+1. Return to Tinybird, and copy a token with privileges to write to the Data Source you created. You can use the admin token or create one with the required scope.
+
+2. Return to the Clerk Webhooks page, and update the URL to add a new search parameter `token` with the token you copied. The final URL looks like the following:
+
+```
+https://api.tinybird.co/v0/events?name=clerk&token=p.eyXXXXX
+```
+
+3. Select the checkboxes for the Clerk events you want to send to Tinybird, and select **Create**.
+
+4. You're done. Any of the Clerk events you selected is automatically sent to Tinybird through the [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api). You can test the integration from the **Testing** tab in the Clerk Webhooks UI. 
+   
+    
+## See also
+
+* [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api)

apps/web/public/content/clerk.md

@@ -0,0 +1,62 @@
+# Send GitLab events to Tinybird
+[GitLab](https://gitlab.com) is a platform for building and deploying web applications. By integrating GitLab with Tinybird, you can analyze your GitLab events in real time and enrich it with other data sources.
+
+Some common use cases for sending GitLab events to Tinybird include:
+
+1. Analyze GitLab issues and merge requests.
+2. Analyze GitLab push events.
+3. Analyze and monitor GitLab pipeline.
+4. Analyze custom DORA metrics.
+
+All this allows you to build a more complete picture of your GitLab events and improve your DevOps processes.
+
+Read on to learn how to send events from GitLab to Tinybird.
+
+## Before you start
+
+Before you connect GitLab to Tinybird, ensure:
+
+* You have a GitLab account.
+* You have a Tinybird Workspace.
+
+## Connect GitLab to Tinybird
+
+1. In GitLab, go to **Settings** > **Webhooks**.
+   
+2. Select **Add new webhook**.
+
+3. Webhooks payloads vary depending on the event type. You can check here the list of [GitLab events](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html). So it's recommended to select one event type and create a Tinybird Data Source for it.
+
+Select **Issues Events**.
+
+4. In Tinybird, create a Data Source, called `gitlab_work_item`. You can follow this [schema](https://github.com/tinybirdco/tinynest/blob/main/tinybird/datasources/gitlab_work_item.datasource)
+
+Some columns use the [JSON Data Type](/sql-reference/data-types/json) to store the semi-structured data you receive from GitLab webhooks in a single column. You can later retrieve various events and their metadata as needed in your Pipes.
+
+Some other columns are a JSON string. Use the [JSONExtract](/sql-reference/functions/json-functions) functions to extract the data you need in your Pipes.
+
+5. In Tinybird, copy a token with privileges to append to the Data Source you created. You can use the admin token or create one with the required scope.
+
+6. Back in GitLab, paste the Events API URL in your Webhook URL. Use the query parameter `name` to match the name of the Data Source you created in Tinybird.
+
+```
+https://api.tinybird.co/v0/events?name=gitlab_work_item
+```
+
+1. Select **Add custom header** and add 'Authorization' as **Header name** and paste the token you created in Tinybird as **Header value**.
+
+```
+Bearer <TOKEN>
+```
+
+8. You're done. You can select **Test** to check if the webhook is working.
+
+Check the status of the integration from the **Log** tab in the Tinybird `gitlab_work_item` Data Source. 
+
+You can add more GitLab Webhooks to Tinybird by following the same steps. Find here some more [GitLab schemas](https://github.com/tinybirdco/tinynest/blob/main/tinybird/datasources/).
+    
+## See also
+
+* [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api)
+* [GitLab Webhooks](https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html)
+* [Tinybird Data Sources](https://github.com/tinybirdco/tinynest/blob/main/tinybird/datasources/)

apps/web/public/content/gitlab.md

@@ -0,0 +1,61 @@
+# Send Orb events to Tinybird
+
+[Orb](https://withorb.com) is a developer-focused platform to manage your subscription billing and revenue operations. By integrating Orb with Tinybird, you can analyze your subscription billing data in real time and enrich it with other data sources.
+
+Some common use cases for sending Orb events to Tinybird include:
+
+1. Tracking and monitoring subscriptions.
+2. Monitoring user churn.
+3. Creating custom dashboards for subscription analysis.
+4. Subscriptions logs.
+
+Read on to learn how to send events from Orb to Tinybird.
+
+## Before you start
+
+Before you connect Orb to Tinybird, ensure:
+
+* You have an Orb account.
+* You have a Tinybird Workspace.
+
+## Connect Orb to Tinybird
+
+1. From the Orb dashboard, select **Developers** > **Webhooks**.
+   
+2. Select **Add Endpoint**.
+
+3. In Tinybird, create a Data Source, called `orb` in this example, with the following schema:
+
+```tb {% title = 'Data Source schema for Orb events %}
+SCHEMA >
+    `id` String `json:$.id`,
+    `type` LowCardinality(String) `json:$.type` DEFAULT 'unknown',
+    `date` DateTime64(3) `json:$.created_at` DEFAULT now(),
+    `resource_name` LowCardinality(String) `json:$.resource_name` DEFAULT 'unknown',
+    `details` JSON `json:$.properties` DEFAULT '{}'
+
+ENGINE "MergeTree"
+ENGINE_PARTITION_KEY "toYYYYMM(date)"
+ENGINE_SORTING_KEY "type, resource_name, date"
+```
+
+Using the [JSON Data Type](/sql-reference/data-types/json) you can store the semi-structured data you receive from Orb in a single column. You can later retrieve various events and their metadata as needed in your Pipes.
+
+4. In Tinybird, copy a token with privileges to append to the Data Source you created. You can use the admin token or create one with the required scope.
+
+5. Back in Orb, paste the Events API URL in your Webhook Endpoint URL. Use the query parameter `name` to match the name of the Data Source you created in Tinybird. For example: 
+
+```
+https://api.tinybird.co/v0/events?name=orb&token={% user("userToken") %}
+```
+
+1. Select **Send test request** to test the connection and check the data gets to the `orb` Data Source in Tinybird.
+
+2. You're done. Any of the Orb events is automatically sent to Tinybird through the [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api).
+
+You can check the status of the integration by clicking on the Webhook endpoint in Orb or from the **Log** tab in the Tinybird `orb` Data Source. 
+    
+## See also
+
+* [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api)
+* [Orb webhooks](https://docs.withorb.com/guides/integrations-and-exports/webhooks)

apps/web/public/content/orb.md

@@ -0,0 +1,43 @@
+# Send Resend webhooks to Tinybird
+
+With [Resend](https://resend.com/) you can send and receive emails programmatically. By integrating Resend with Tinybird, you can analyze your email data in real time.
+
+Some common use cases for sending Resend webhooks to Tinybird include:
+
+1. Tracking email opens and clicks.
+2. Monitoring delivery rates and bounces.
+3. Analyzing user engagement patterns.
+4. Creating custom dashboards for email performance.
+5. Enriching other data sources with real-time email metrics.
+
+Read on to learn how to send data from Resend to Tinybird.
+
+## Before you start
+
+Before you connect Resend to Tinybird, ensure:
+
+* You have a Resend account.
+* You have a Tinybird Workspace.
+
+## Connect Resend to Tinybird
+
+1. Open the Resend UI and go to the Webhooks page.
+   
+2. Select "Add Webhook".
+
+3. Go to your Tinybird Workspace, create a new Data Source and select the Events API. From the dialog, copy the API URL.
+
+4. Paste this into the Webhook URL field. The end of URL has a search parameter `name` that you can customize to give your Data Source a name. The URL looks like: `https://api.tinybird.co/v0/events?name=your_data_source_name`.
+
+5. Return to the dialog in Tinybird, and copy the token from the Authorization header. The token looks like: `p.eyXXXXX`.
+
+6. Return to the Resend Webhooks page, and update the URL to add a new search parameter `token` with the token you copied. The URL looks like: `https://api.tinybird.co/v0/events?name=your_data_source_name&token=p.eyXXXXX`.
+
+7. Select the checkboxes for the Resend events you want to send to Tinybird, and select "Add".
+
+8. You're done. Sending emails to Resend will now push events to Tinybird via the [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api).
+   
+    
+## See also
+
+* [Events API](https://tinybird.co/docs/get-data-in/ingest-apis/events-api).