Enable a webhook endpoint

Private beta: request access to use webhooks. Resume a disabled endpoint so its URL accepts deliveries again. Returns the updated endpoint.

POST /api/v1/webhooks/endpoints/{endpointId}/enable

Enable a webhook endpoint

cURL

curl -X POST "https://api.trigger.dev/api/v1/webhooks/endpoints/stripe/enable" \
  -H "Authorization: Bearer $TRIGGER_SECRET_KEY"

200

{
  "id": "wh_cm1a2b3c4d5e6f",
  "declaredId": "stripe",
  "source": "stripe",
  "status": "active",
  "secretProvisioning": "provider",
  "secretSet": true,
  "tenantId": "<string>",
  "externalRef": "<string>",
  "url": "https://api.trigger.dev/webhooks/v1/ingest/q3Xb7k2LmP9sT4vW1yZ0aQ",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "subscribers": [
    {
      "id": "process-checkout",
      "type": "task",
      "taskId": "process-checkout",
      "filter": "event.type == 'checkout.session.completed'"
    }
  ],
  "setupPrompt": "<string>"
}

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.

Response

200

application/json

Successful request

id · string · required

The endpoint's id.

Example:

"wh_cm1a2b3c4d5e6f"

declaredId · string · required

The id the endpoint is declared with in code (webhooks.endpoint.define({ id })).

Example:

"stripe"

source · string · required

The provider source that verifies and types the endpoint's events.

Example:

"stripe"

status · enum<string> · required

active accepts deliveries. inactive was disabled, or is no longer in the current deployment, and its URL responds with 404.

Available options: active, inactive, deleting

secretProvisioning · enum<string> · required

Who supplies the signing secret: provider issues it (store it with the set secret endpoint), integrator means you choose it (generate one), and either accepts both.

Available options: provider, integrator, either

secretSet · boolean · required

Whether a signing secret or public key is set. Every delivery is rejected until it is.

tenantId · string | null · required

Reserved for dynamic endpoints. null for a declared endpoint.

externalRef · string | null · required

Reserved for dynamic endpoints. null for a declared endpoint.

url · string · required

The webhook URL to register with the provider.

Example:

"https://api.trigger.dev/webhooks/v1/ingest/q3Xb7k2LmP9sT4vW1yZ0aQ"

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

subscribers · object[] · required

The tasks and agents that receive the endpoint's deliveries.

Show child attributes

setupPrompt · string · required

Instructions for an AI coding agent to register the endpoint with its provider and set up the signing secret.