James Ritchie
fade22015f
* Adds new features table to top of v4 upgrade guide * Adds wait idempotency to wait-until, wait-for, and wait-for-token pages * Adds new priority docs page and updates the v4 upgrade guide * Adds new task lifecycle hooks * Removes the message about requiring tasks to be exported * Adds new global lifecycle hooks section * Moves sections from upgrade guide into the table * Adds hidden task page * Improves the global lifecycle hooks section * Updates middleware and locals section * Adds new useWaitToken page to the react hooks section * Adds a new ai.tool section * Moves Docker (legacy) page into self-hosting section * Removes known issues from v4 upgrade guide * Replace “toolTask” with “ai.tool” in the Streams page example * Renames guide to “Migrating from v3” and adds redirect * Remove references to v4 * Removes changelog from migration guide * The installation guide now references `@latest update` * Changes all references from `/sdk/v3` to `/sdk` * Updates @v4-beta to @latest * Fixed broken link * Fixes broken link * Adds an upgrade to v4 using AI section * Fixes 2 broken links * Adds an entry for targetting preview branches * Updates the run statuses * Adds boolean helpers section to the runs and realtime pages * Updates the concurrency page * Updates the test page to include the new options * Adds SDK and curl options for the preview branch targeting * Updates new bulk actions page * Remove the releasing concurrency section * Got rid of some more @v4-beta mentions * Improved rate limit docs * Improved migrating docs * Removed commented sections of the docs * useWaitToken hook * Fixed the description * Fix for missing test image --------- Co-authored-by: Matt Aitken <matt@mattaitken.com> Co-authored-by: Dan <8297864+D-K-P@users.noreply.github.com>
55 lines
1.8 KiB
Plaintext
55 lines
1.8 KiB
Plaintext
---
|
|
title: "API keys"
|
|
description: "How to authenticate with Trigger.dev so you can trigger tasks."
|
|
---
|
|
|
|
### Authentication and your secret keys
|
|
|
|
When you [trigger a task](/triggering) from your backend code, you need to set the `TRIGGER_SECRET_KEY` environment variable.
|
|
|
|
Each environment has its own secret key. You can find the value on the API keys page in the Trigger.dev dashboard:
|
|
|
|
|
|
|
|
<Note>
|
|
For preview branches, you need to also set the `TRIGGER_PREVIEW_BRANCH` environment variable as
|
|
well. You can find the value on the API keys page when you're on the preview branch.
|
|
</Note>
|
|
|
|
### Automatically Configuring the SDK
|
|
|
|
To automatically configure the SDK with your secret key, you can set the `TRIGGER_SECRET_KEY` environment variable. The SDK will automatically use this value when calling API methods (like `trigger`).
|
|
|
|
```bash .env
|
|
TRIGGER_SECRET_KEY="tr_dev_…"
|
|
TRIGGER_PREVIEW_BRANCH="my-branch" # Only needed for preview branches
|
|
```
|
|
|
|
You can do the same if you are self-hosting and need to change the default URL by using `TRIGGER_API_URL`.
|
|
|
|
```bash .env
|
|
TRIGGER_API_URL="https://trigger.example.com"
|
|
TRIGGER_PREVIEW_BRANCH="my-branch" # Only needed for preview branches
|
|
```
|
|
|
|
The default URL is `https://api.trigger.dev`.
|
|
|
|
### Manually Configuring the SDK
|
|
|
|
If you prefer to manually configure the SDK, you can call the `configure` method:
|
|
|
|
```ts
|
|
import { configure } from "@trigger.dev/sdk";
|
|
import { myTask } from "./trigger/myTasks";
|
|
|
|
configure({
|
|
secretKey: "tr_dev_1234", // WARNING: Never actually hardcode your secret key like this
|
|
previewBranch: "my-branch", // Only needed for preview branches
|
|
baseURL: "https://mytrigger.example.com", // Optional
|
|
});
|
|
|
|
async function triggerTask() {
|
|
await myTask.trigger({ userId: "1234" }); // This will use the secret key and base URL you configured
|
|
}
|
|
```
|