Triggers

Update trigger

Update a trigger.

patch/api/triggers/{trigger_id}

Path parameters

trigger_idstring required

ID of the trigger to update.

Request body

status'ENABLED' | 'DISABLED'

Current trigger lifecycle state.

descriptionstring

Optional note describing this trigger.

inputsobject

Values for the preset's inputs.

Example request

{
  "status": "ENABLED",
  "description": "Reviews I am tagged on, sent to my team's review channel",
  "inputs": {
    "repository": "acme/payments-api"
  },
  "delivery": {
    "webhook_url": "https://customer.app/webhook",
    "auth": {
      "secret": "secret_test_123"
    }
  }
}

Response

Trigger updated.

request_idstring required

Platform-generated request ID for support correlation.

Example response

{
  "trigger": {
    "trigger_id": "trigger_test_123",
    "preset_id": "GITHUB_1",
    "description": "Reviews I am tagged on, sent to my team's review channel",
    "status": "ENABLED",
    "inputs": {
      "repository": "acme/payments-api"
    },
    "delivery": {
      "webhook_url": "https://customer.app/webhook",
      "auth": {
        "secret": "secret_test_123"
      }
    }
  }
}