Skip to content

Commit

Permalink
[pivotal] Instruct users to use a dedicated Shortcut API token
Browse files Browse the repository at this point in the history
If a user of this importer configures it with a token that is
simultaneously making requests to Shortcut from a different
script/automation/integration, then that significantly increases the
likelihood that they could be throttled by the Shortcut API. This
script does not currently provide explicit handling for HTTP 429
requests, and it would be difficult for users to reason about why they
were being throttled, so I've added this to the documentation at
Toby's suggestion.

Co-authored-by: Toby Crawley <[email protected]>
  • Loading branch information
semperos and tobias committed Apr 10, 2024
1 parent 7a59690 commit cb583ad
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pivotal-import/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to run this, you will require a Pivotal account and the ability to sign

1. Sign up for a Shortcut account at [https://www.shortcut.com/signup](https://www.shortcut.com/signup).
- **NOTE:** Do not run this importer against an existing Shortcut workspace that already has data you wish to keep.
1. [Create an API token](https://app.shortcut.com/settings/account/api-tokens) and [export it into your environment](../Authentication.md).
1. [Create a new API token](https://app.shortcut.com/settings/account/api-tokens) and [export it into your environment](../Authentication.md). Ensure you use this token only for this importer, so that you aren't rate limited unexpectedly by the Shortcut API.
1. Export your Pivotal project to CSV and save the file to `data/pivotal_export.csv`.
1. Create/Invite all users you want to reference into your Shortcut workspace.
- **NOTE:** If you're not on a Shortcut trial, please [reach out to our support team](https://help.shortcut.com/hc/en-us/requests/new) before running this import to make sure you're not billed for users that you want to be disabled after import.
Expand Down

0 comments on commit cb583ad

Please sign in to comment.