Skip to content

Commit

Permalink
add projects tutorial skeleton page
Browse files Browse the repository at this point in the history
  • Loading branch information
shanamatthews committed Jul 14, 2023
1 parent 4d35978 commit f03bd79
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 2 deletions.
3 changes: 2 additions & 1 deletion src/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ The current version of the web API is known as **v0** and is considered to be in
- [Permissions](/api/permissions/)
- [Rate Limits](/api/ratelimits)
- [Requests](/api/requests/)
- [Tutorial](/api/tutorial/)
- [Tutorial: Create and List Teams](/api/teams-tutorial/)
- [Tutorial: Create and Manage Projects](/api/projects-tutorial/)
42 changes: 42 additions & 0 deletions src/api/projects-tutorial.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Create and Manage Projects with the Sentry API
sidebar_order: 8
---

Intro text

## Prerequisites

- A Sentry account with an organization-level role of Admin or higher <!-- TODO SHANA confirm -->

We recommend using a free [Sentry developer account](https://sentry.io/pricing/) for this tutorial.

## Get an Sentry Authentication Token

You must pass an authentication token along with your API calls to authenticate with Sentry. Auth tokens can be associated with a user or with an organization. We recommend using tokens associated with an organization when possible, because user tokens stop working once a user is removed from an organization.

For this guide, we will generate an organization auth token by creating an internal integration.

[Internal Integrations](/product/integrations/integration-platform/internal-integration/) can be used to create custom Sentry integrations for your organization. However, they can also be used as a tool to create and manage your organization auth tokens.

1. Open [sentry.io](https://sentry.io/)

1. Press "Settings" in the left menu to open the **Organization Settings** page.

1. Press "Custom Integrations" in the left side panel to create a new internal integration and org-level auth token.

1. Press the "Create New Integration" button.

1. Make sure "Internal Integration" is selected in the modal and press "Next".

1. Enter a name for your integration.

1. Under "Permissions" select "Read & Write" in the "Organization" dropdown.

Creating a new team requires an auth token with organization write permissions. Listing teams only requires read permissions.

1. Press "Save Changes".

1. Scroll down to the bottom of the page and copy the generated token under "Tokens".

You'll need this token for all your future API calls.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/gatsby/createPages/createApiReference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const createApiReference = async ({
const data = await getDataOrPanic(
`
query {
allFile(filter: {absolutePath: {}, relativePath: {in: ["permissions.mdx", "auth.mdx", "index.mdx", "requests.mdx", "pagination.mdx", "ratelimits.mdx", "tutorial.mdx"]}, dir: {regex: "/api/"}}) {
allFile(filter: {absolutePath: {}, relativePath: {in: ["permissions.mdx", "auth.mdx", "index.mdx", "requests.mdx", "pagination.mdx", "ratelimits.mdx", "teams-tutorial.mdx", "projects-tutorial.mdx"]}, dir: {regex: "/api/"}}) {
nodes {
id
childMarkdownRemark {
Expand Down

0 comments on commit f03bd79

Please sign in to comment.