Create a trigger

API Reference / Functions / Create a trigger

Creates a trigger for a Function visible on the branch. The required type discriminator selects the trigger-specific configuration. The supported types are schedule and storage_object_created. A schedule trigger uses a numeric five-field cron expression interpreted in UTC. A storage-object-created trigger fires only after a successful upload to one exact bucket and may narrow matches to an object-key prefix.

The name must be unique among triggers visible on the branch, including inherited triggers.

Note: This endpoint is currently in Beta.

• project_id (string, path, required) The Neon project ID
• branch_id (string, path, required) The Neon branch ID

• type (string, required) Trigger type discriminator. Possible values: schedule
• function_slug (string, required) The branch-local Function slug to invoke.
• name (string, required) Human-readable name, unique among triggers visible on the branch.
• function_path (string, optional) Path passed to the target Function. Defaults to /. Default: /
• schedule (object, required) A numeric five-field cron schedule interpreted in UTC.
  • cron (string, required) Numeric five-field cron expression (minute through day-of-week), interpreted in UTC.
• enabled (boolean, optional) Whether future occurrences should be scheduled. Default: true

• trigger (object, optional) A branch-effective trigger discriminated by type. The supported trigger types are schedule and storage_object_created.

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/triggers" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.createProjectBranchTrigger({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});

default General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

• If no response is returned from the API, a network error or timeout likely occurred.
• In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.

• request_id (string, optional) Unique identifier for the request, useful for debugging. You can set this value manually by including an X-Request-ID header in the request. If not provided, the value will be generated automatically.

• code (string, required) Machine-readable code classifying the error type. See message for a human-readable explanation. Default: ``

• message (string, required) Error message