Set a webhook signing secret

Private beta: request access to use webhooks. Store the signing secret or public key the provider issued for this endpoint, such as the whsec_ secret Stripe returns when you create a webhook endpoint. It replaces any existing secret.

PUT /api/v1/webhooks/endpoints/{endpointId}/secret

Set a signing secret

cURL

curl -X PUT "https://api.trigger.dev/api/v1/webhooks/endpoints/stripe/secret" \
  -H "Authorization: Bearer $TRIGGER_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"secret": "whsec_..."}'

200

{
  "id": "wh_cm1a2b3c4d5e6f",
  "secretSet": true
}

Authorizations

Authorization · string · header · required

Use a named environment API key. It starts with tr_dev_sk_, tr_prod_sk_, tr_stg_sk_, etc.

Create a named API key in the API Keys section of your Trigger.dev project dashboard. Choose the narrowest access preset that supports your integration.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

import { configure } from "@trigger.dev/sdk";

configure({ accessToken: "tr_dev_sk_1234" });

Path Parameters

endpointId · string · required

The endpoint's declared id (the id passed to webhooks.endpoint.define) or its wh_ id. A value starting with wh_ is always a generated id, since declared ids can't start with wh_. A declared id names the endpoint's declared instance in the key's environment.

Body

application/json

secret · string · required

The signing secret or public key. Leading and trailing whitespace is trimmed.

Required string length: 1 - 4096

Example:

"whsec_5f2b..."

Response

200

application/json

Successful request

id · string · required

The endpoint's wh_ id.

Example:

"wh_cm1a2b3c4d5e6f"

secretSet · boolean · required