Skip to content

Commit

Permalink
Fix readme reference
Browse files Browse the repository at this point in the history
  • Loading branch information
davidstanley01 committed Dec 19, 2018
1 parent c7b0ea9 commit 91627d1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,15 @@ HS_APP_ID=your-app-id
HS_APP_SECRET=your-app-secret
```

### Legacy Token Flow
### Legacy Credentials Flow
To ease the transition of legacy apps to the new API, the API client uses the [transition service](https://developer.helpscout.com/mailbox-api/migration/transition-service/) to exchange the legacy `clientId` and `apiKey` for an `access_token`.

Just as with the `client_credentials` flow described above, if the API client does not have an `access_token` when attempting an API call, it will make a pre-flight request to the transition service to exchange the legacy credentials for a valid `access_token`.

To use this grant type, set the following environment variables:

```
HS_AUTH_TYPE=legacy_token
HS_AUTH_TYPE=legacy_credentials
HS_CLIENT_ID=your-client-id
HS_API_KEY=your-api-key
```
Expand Down

0 comments on commit 91627d1

Please sign in to comment.