Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions apps/docs/content/docs/integrations/hex.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Create a new group in the Hex workspace, optionally with initial members.
| --------- | ---- | ----------- |
| `id` | string | Newly created group UUID |
| `name` | string | Group name |
| `createdAt` | string | Creation timestamp |
| `createdAt` | string | Creation timestamp \(not returned by the create endpoint, so usually null\) |

</ReferenceDetails>

Expand Down Expand Up @@ -245,7 +245,7 @@ Get metadata and details for a specific Hex project by its ID.

### Hex Get Project Runs

Retrieve API-triggered runs for a Hex project with optional filtering by status and pagination.
Retrieve runs for a Hex project (API-triggered, scheduled, and app refresh runs) with optional filtering by status and trigger, and offset pagination.

<ReferenceDetails>

Expand All @@ -268,11 +268,12 @@ Retrieve API-triggered runs for a Hex project with optional filtering by status
| ↳ `runId` | string | Run UUID |
| ↳ `runUrl` | string | URL to view the run |
| ↳ `status` | string | Run status \(PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL\) |
| ↳ `runTrigger` | string | How the run was triggered \(API, SCHEDULED, APP_REFRESH\) |
| ↳ `startTime` | string | Run start time |
| ↳ `endTime` | string | Run end time |
| ↳ `elapsedTime` | number | Elapsed time in seconds |
| ↳ `elapsedTime` | number | Elapsed run time in milliseconds |
| ↳ `traceId` | string | Trace ID |
| ↳ `projectVersion` | number | Project version number |
| ↳ `projectVersion` | string | Project version that was run \("1", "2", ...; "draft" for notebook runs\) |
| `total` | number | Total number of runs returned |
| `traceId` | string | Top-level trace ID |
| `nextPage` | string | Cursor for the next page of runs |
Expand All @@ -291,7 +292,9 @@ Return the warehouse tables queried by a Hex project, including data connection
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The UUID of the Hex project |
| `limit` | number | No | Maximum number of tables to return \(1-100\) |
| `limit` | number | No | Maximum number of tables to return \(1-100, default: 25\) |
| `after` | string | No | Cursor to fetch the page of results after this value |
| `before` | string | No | Cursor to fetch the page of results before this value |

#### Output

Expand All @@ -302,6 +305,8 @@ Return the warehouse tables queried by a Hex project, including data connection
| ↳ `dataConnectionName` | string | Data connection name |
| ↳ `tableName` | string | Table name |
| `total` | number | Total number of tables returned |
| `after` | string | Cursor for the next page of results |
| `before` | string | Cursor for the previous page of results |

</ReferenceDetails>

Expand All @@ -326,11 +331,12 @@ Check the status of a Hex project run by its run ID.
| `runId` | string | Run UUID |
| `runUrl` | string | URL to view the run |
| `status` | string | Run status \(PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL\) |
| `runTrigger` | string | How the run was triggered \(API, SCHEDULED, APP_REFRESH\) |
| `startTime` | string | ISO 8601 run start time |
| `endTime` | string | ISO 8601 run end time |
| `elapsedTime` | number | Elapsed time in seconds |
| `elapsedTime` | number | Elapsed run time in milliseconds |
| `traceId` | string | Trace ID for debugging |
| `projectVersion` | number | Project version number |
| `projectVersion` | string | Project version that was run \("1", "2", ...; "draft" for notebook runs\) |

</ReferenceDetails>

Expand All @@ -344,7 +350,7 @@ List all collections in the Hex workspace.

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `limit` | number | No | Maximum number of collections to return \(1-500, default: 25\) |
| `limit` | number | No | Maximum number of collections to return \(1-100, default: 25\) |
| `sortBy` | string | No | Sort by field: NAME |
| `after` | string | No | Cursor to fetch the page of results after this value |
| `before` | string | No | Cursor to fetch the page of results before this value |
Expand Down Expand Up @@ -376,7 +382,7 @@ List all data connections in the Hex workspace (e.g., Snowflake, PostgreSQL, Big

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `limit` | number | No | Maximum number of connections to return \(1-500, default: 25\) |
| `limit` | number | No | Maximum number of connections to return \(1-100, default: 25\) |
| `sortBy` | string | No | Sort by field: CREATED_AT or NAME |
| `sortDirection` | string | No | Sort direction: ASC or DESC |
| `after` | string | No | Cursor to fetch the page of results after this value |
Expand All @@ -402,7 +408,7 @@ List all data connections in the Hex workspace (e.g., Snowflake, PostgreSQL, Big

### Hex List Groups

List all groups in the Hex workspace with optional sorting.
List all groups in the Hex workspace with optional sorting, or only the groups a user belongs to.

<ReferenceDetails>

Expand All @@ -413,6 +419,7 @@ List all groups in the Hex workspace with optional sorting.
| `limit` | number | No | Maximum number of groups to return \(1-500, default: 25\) |
| `sortBy` | string | No | Sort by field: CREATED_AT or NAME |
| `sortDirection` | string | No | Sort direction: ASC or DESC |
| `userId` | string | No | Return only groups this user UUID belongs to |
| `after` | string | No | Cursor to fetch the page of results after this value |
| `before` | string | No | Cursor to fetch the page of results before this value |

Expand Down Expand Up @@ -440,7 +447,7 @@ List all projects in your Hex workspace with optional filtering by status.

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `limit` | number | No | Maximum number of projects to return \(1-100\) |
| `limit` | number | No | Maximum number of projects to return \(1-100, default: 25\) |
| `includeArchived` | boolean | No | Include archived projects in results |
| `statusFilter` | string | No | Filter by status: PUBLISHED, DRAFT, or ALL |
| `includeComponents` | boolean | No | Include components in results |
Expand Down Expand Up @@ -473,6 +480,10 @@ List all projects in your Hex workspace with optional filtering by status.
| ↳ `lastPublishedAt` | string | Last published timestamp |
| ↳ `createdAt` | string | Creation timestamp |
| ↳ `archivedAt` | string | Archived timestamp |
| ↳ `trashedAt` | string | Trashed timestamp |
| ↳ `categories` | array | Project categories |
| ↳ `name` | string | Category name |
| ↳ `description` | string | Category description |
| `total` | number | Total number of projects returned |
| `after` | string | Cursor for the next page of results |
| `before` | string | Cursor for the previous page of results |
Expand All @@ -489,7 +500,7 @@ List all users in the Hex workspace with optional filtering and sorting.

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `limit` | number | No | Maximum number of users to return \(1-100, default: 25\) |
| `limit` | number | No | Maximum number of users to return \(1-500, default: 25\) |
| `sortBy` | string | No | Sort by field: NAME or EMAIL |
| `sortDirection` | string | No | Sort direction: ASC or DESC |
| `groupId` | string | No | Filter users by group UUID |
Expand Down
30 changes: 29 additions & 1 deletion apps/docs/content/docs/integrations/stripe.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,8 @@ List all Payment Intents
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `customer` | string | No | Filter by customer ID |
| `created` | json | No | Filter by creation date \(e.g., \{"gt": 1633024800\}\) |
| `starting_after` | string | No | Next-page cursor: last Payment Intent ID from the previous page. Do not combine with ending_before. |
| `ending_before` | string | No | Previous-page cursor: first Payment Intent ID from the current page. Do not combine with starting_after. |

#### Output

Expand Down Expand Up @@ -543,6 +545,7 @@ Search for Payment Intents using query syntax
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query \(e.g., "status:'succeeded' AND currency:'usd'"\) |
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `page` | string | No | Pagination token from metadata.next_page of the previous search; omit for the first page |

#### Output

Expand Down Expand Up @@ -598,6 +601,7 @@ Search for Payment Intents using query syntax
| `metadata` | json | Search metadata including count and has_more |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
| ↳ `next_page` | string | Token for the next page of search results, or null when there are no more results |

</ReferenceDetails>

Expand Down Expand Up @@ -830,6 +834,8 @@ List all customers
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `email` | string | No | Filter by email address |
| `created` | json | No | Filter by creation date |
| `starting_after` | string | No | Next-page cursor: last customer ID from the previous page. Do not combine with ending_before. |
| `ending_before` | string | No | Previous-page cursor: first customer ID from the current page. Do not combine with starting_after. |

#### Output

Expand Down Expand Up @@ -891,6 +897,7 @@ Search for customers using query syntax
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query \(e.g., "email:'customer@example.com'"\) |
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `page` | string | No | Pagination token from metadata.next_page of the previous search; omit for the first page |

#### Output

Expand Down Expand Up @@ -937,6 +944,7 @@ Search for customers using query syntax
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
| ↳ `next_page` | string | Token for the next page of search results, or null when there are no more results |

</ReferenceDetails>

Expand Down Expand Up @@ -1116,7 +1124,7 @@ Update an existing subscription
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | string | Yes | Subscription ID \(e.g., sub_1234567890\) |
| `items` | json | No | Updated array of items with price IDs |
| `items` | json | No | Subscription items to change, e.g. \[\{"id": "si_123", "price": "price_456"\}\]. Include the existing item "id" to update or delete \(with "deleted": true\) that item; an entry without "id" adds a new item alongside the current ones. |
| `cancel_at_period_end` | boolean | No | Cancel subscription at period end |
| `metadata` | json | No | Updated metadata |

Expand Down Expand Up @@ -2538,6 +2546,8 @@ List all invoices
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `customer` | string | No | Filter by customer ID |
| `status` | string | No | Filter by invoice status |
| `starting_after` | string | No | Next-page cursor: last invoice ID from the previous page. Do not combine with ending_before. |
| `ending_before` | string | No | Previous-page cursor: first invoice ID from the current page. Do not combine with starting_after. |

#### Output

Expand All @@ -2562,6 +2572,7 @@ Search for invoices using query syntax
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query \(e.g., "customer:'cus_1234567890'"\) |
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `page` | string | No | Pagination token from metadata.next_page of the previous search; omit for the first page |

#### Output

Expand All @@ -2571,6 +2582,7 @@ Search for invoices using query syntax
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
| ↳ `next_page` | string | Token for the next page of search results, or null when there are no more results |

</ReferenceDetails>

Expand Down Expand Up @@ -2700,6 +2712,8 @@ List all charges
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `customer` | string | No | Filter by customer ID |
| `created` | json | No | Filter by creation date \(e.g., \{"gt": 1633024800\}\) |
| `starting_after` | string | No | Next-page cursor: last charge ID from the previous page. Do not combine with ending_before. |
| `ending_before` | string | No | Previous-page cursor: first charge ID from the current page. Do not combine with starting_after. |

#### Output

Expand All @@ -2724,6 +2738,7 @@ Search for charges using query syntax
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query \(e.g., "status:'succeeded' AND currency:'usd'"\) |
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `page` | string | No | Pagination token from metadata.next_page of the previous search; omit for the first page |

#### Output

Expand All @@ -2733,6 +2748,7 @@ Search for charges using query syntax
| `metadata` | json | Search metadata including count and has_more |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
| ↳ `next_page` | string | Token for the next page of search results, or null when there are no more results |

</ReferenceDetails>

Expand Down Expand Up @@ -2850,6 +2866,8 @@ List all products
| --------- | ---- | -------- | ----------- |
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `active` | boolean | No | Filter by active status |
| `starting_after` | string | No | Next-page cursor: last product ID from the previous page. Do not combine with ending_before. |
| `ending_before` | string | No | Previous-page cursor: first product ID from the current page. Do not combine with starting_after. |

#### Output

Expand All @@ -2874,6 +2892,7 @@ Search for products using query syntax
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query \(e.g., "name:'shirt'"\) |
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `page` | string | No | Pagination token from metadata.next_page of the previous search; omit for the first page |

#### Output

Expand All @@ -2883,6 +2902,7 @@ Search for products using query syntax
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
| ↳ `next_page` | string | Token for the next page of search results, or null when there are no more results |

</ReferenceDetails>

Expand Down Expand Up @@ -2981,6 +3001,8 @@ List all prices
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `product` | string | No | Filter by product ID |
| `active` | boolean | No | Filter by active status |
| `starting_after` | string | No | Next-page cursor: last price ID from the previous page. Do not combine with ending_before. |
| `ending_before` | string | No | Previous-page cursor: first price ID from the current page. Do not combine with starting_after. |

#### Output

Expand All @@ -3005,6 +3027,7 @@ Search for prices using query syntax
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query \(e.g., "active:'true' AND currency:'usd'"\) |
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `page` | string | No | Pagination token from metadata.next_page of the previous search; omit for the first page |

#### Output

Expand All @@ -3014,6 +3037,7 @@ Search for prices using query syntax
| `metadata` | json | Search metadata |
| ↳ `count` | number | Number of items returned |
| ↳ `has_more` | boolean | Whether more items exist beyond this page |
| ↳ `next_page` | string | Token for the next page of search results, or null when there are no more results |

</ReferenceDetails>

Expand Down Expand Up @@ -3054,6 +3078,8 @@ List all Events
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
| `type` | string | No | Filter by event type \(e.g., payment_intent.created\) |
| `created` | json | No | Filter by creation date \(e.g., \{"gt": 1633024800\}\) |
| `starting_after` | string | No | Next-page cursor: last event ID from the previous page. Do not combine with ending_before. |
| `ending_before` | string | No | Previous-page cursor: first event ID from the current page. Do not combine with starting_after. |

#### Output

Expand Down Expand Up @@ -3092,7 +3118,9 @@ Triggers when Stripe events occur (payments, subscriptions, invoices, etc.)
| `id` | string | Unique identifier for the event |
| `type` | string | Event type \(e.g., payment_intent.succeeded, customer.created, invoice.paid\) |
| `object` | string | Always "event" |
| `account` | string | Connected account that originated the event \(Connect events only; absent or null otherwise\) |
| `api_version` | string | Stripe API version used to render the event |
| `context` | string | Authentication context needed to fetch the event or related object \(null when not applicable\) |
| `created` | number | Unix timestamp when the event was created |
| `data` | json | Event data containing the affected Stripe object. Structure varies by event type - access via data.object for the resource \(PaymentIntent, Customer, Invoice, etc.\) |
| `livemode` | boolean | Whether this event occurred in live mode \(true\) or test mode \(false\) |
Expand Down
Loading
Loading