> ## Documentation index
>
> Fetch the complete documentation index at: https://andesine.app/docs/llms.txt
> Use it to find all pages before you explore further.

# Update a webhook

`PUT https://api.andesine.app/webhooks/{id}`

Checks expectedRevision and validates the merged configuration. A URL change cancels pending deliveries and returns a replacement secret once. Scope changes require authority over the previous and new scope.

Required API key permissions: webhooks. Write permissions also grant read access for the same resource.

## Authentication

Use one of:

- `apiKey` (http, bearer, Andesine API key)
- `oauth` (http, bearer, Andesine OAuth access token)

## Parameters

### Path

- `id` (string, required)

### Header

- `x-workspace-id` (string, optional): Required for OAuth: ID of the workspace to access. API keys use their own workspace.

## Request body

The body is required.

Content type: `application/json`

- `name` (string, optional)
- `url` (string, optional)
- `enabled` (boolean, optional)
- `eventTypes` (array of `WebhookEventName`, optional)
- `schemaVersion` (constant, optional): Value: `1`.
- `collections` (any of, optional)
  - Any of: Option 1 (object)
    - `mode` (constant, required): Value: `"all"`.
  - Any of: Option 2 (object)
    - `mode` (constant, required): Value: `"selected"`.
    - `roots` (array of string, required)
- `channels` (any of, optional)
  - Any of: Option 1 (object)
    - `mode` (constant, required): Value: `"all"`.
  - Any of: Option 2 (object)
    - `mode` (constant, required): Value: `"selected"`.
    - `codes` (array of string, required)
- `restrictedContent` (boolean, optional): Include restricted collections, including ones restricted later.
- `expectedRevision` (number, required)

## Responses

### 200

OK

Content type: `application/json`

Type: any of.

- Any of: Option 1 (object)
  - `secretChanged` (constant, required): Value: `false`.
  - `endpoint` (`WebhookEndpoint`, required)
    - `name` (string, required)
    - `url` (string, required)
    - `enabled` (boolean, required)
    - `eventTypes` (array of `WebhookEventName`, required)
    - `schemaVersion` (constant, required): Value: `1`.
    - `collections` (any of, required)
      - Any of: Option 1 (object)
        - `mode` (constant, required): Value: `"all"`.
      - Any of: Option 2 (object)
        - `mode` (constant, required): Value: `"selected"`.
        - `roots` (array of string, required)
    - `channels` (any of, required)
      - Any of: Option 1 (object)
        - `mode` (constant, required): Value: `"all"`.
      - Any of: Option 2 (object)
        - `mode` (constant, required): Value: `"selected"`.
        - `codes` (array of string, required)
    - `restrictedContent` (boolean, required): Include restricted collections, including ones restricted later.
    - `id` (string, required)
    - `workspaceID` (string, required)
    - `revision` (number, required)
    - `destinationRevision` (number, required)
    - `createdAt` (string, required)
    - `updatedAt` (string, required)
    - `disabledReason` (any of, required)
      - Any of: Option 1 (string). One of: `"manual"`, `"failures"`.
      - Any of: Option 2 (null)
    - `health` (object, required)
      - `consecutiveFailures` (number, required)
      - `firstFailureAt` (any of, required)
        - Any of: Option 1 (string)
        - Any of: Option 2 (null)
      - `lastFailureAt` (any of, required)
        - Any of: Option 1 (string)
        - Any of: Option 2 (null)
      - `lastFailureCategory` (any of, required)
        - Any of: Option 1 (string). One of: `"http_status"`, `"timeout"`, `"network"`, `"destination_policy"`, `"internal"`.
        - Any of: Option 2 (null)
      - `lastSuccessAt` (any of, required)
        - Any of: Option 1 (string)
        - Any of: Option 2 (null)
      - `pendingCount` (number, required)
      - `failedCount` (number, required)
    - `signing` (object, required)
      - `rotatedAt` (string, required)
      - `previousSecretExpiresAt` (any of, required)
        - Any of: Option 1 (string)
        - Any of: Option 2 (null)
- Any of: Option 2 (object)
  - `endpoint` (`WebhookEndpoint`, required)
  - `secret` (string, required): One-time signing secret. Never returned by configuration or history reads.
  - `secretChanged` (constant, required): Value: `true`.

### 400

400

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"BAD_REQUEST"`.
  - `status` (constant, required): Value: `400`.
  - `message` (string, required): Default: `"Bad Request"`.
  - `data` (`ValidationErrorData`, optional)
    - `hints` (array of string, optional): Suggested next steps. Wording can change; use error codes and structured data for program logic.
    - `issues` (array of `ValidationIssue`, optional)
      - `message` (string, required)
      - `code` (string, optional)
      - `path` (array of any of, optional)
        - Any of: Option 1 (string)
        - Any of: Option 2 (number)
        - Any of: Option 3 (object)
          - `key` (any of, required)
            - Any of: Option 1 (string)
            - Any of: Option 2 (number)
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)

### 401

401

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"UNAUTHORIZED"`.
  - `status` (constant, required): Value: `401`.
  - `message` (string, required): Default: `"Unauthorized"`.
  - `data` (`ErrorData`, optional)
    - `hints` (array of string, optional): Suggested next steps. Wording can change; use error codes and structured data for program logic.
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)

### 403

403

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"FORBIDDEN"`.
  - `status` (constant, required): Value: `403`.
  - `message` (string, required): Default: `"Forbidden"`.
  - `data` (`ForbiddenErrorData`, optional)
    - `hints` (array of string, optional): Suggested next steps. Wording can change; use error codes and structured data for program logic.
    - `missingPermissions` (array of string, optional)
    - `requiredPlan` (constant, optional): Value: `"pro"`.
    - `action` (string, optional): The requested action that was denied.
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)

### 404

404

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"NOT_FOUND"`.
  - `status` (constant, required): Value: `404`.
  - `message` (string, required): Default: `"Not Found"`.
  - `data` (`ErrorData`, optional)
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)

### 409

409

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"CONFLICT"`.
  - `status` (constant, required): Value: `409`.
  - `message` (string, required): Default: `"Conflict"`.
  - `data` (`ErrorData`, optional)
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)

### 429

429

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"TOO_MANY_REQUESTS"`.
  - `status` (constant, required): Value: `429`.
  - `message` (string, required): Default: `"Too Many Requests"`.
  - `data` (`RateLimitErrorData`, optional)
    - `hints` (array of string, optional): Suggested next steps. Wording can change; use error codes and structured data for program logic.
    - `limit` (string, optional): The limit that was reached: a short-term rate limit, or a monthly API call, AI credit, or spending limit. One of: `"rate"`, `"api-calls"`, `"ai-credits"`, `"spending"`.
    - `retryAfterSeconds` (number, optional): Minimum delay before another attempt, in seconds. Also sent in Retry-After.
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)

### 500

500

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"INTERNAL_SERVER_ERROR"`.
  - `status` (constant, required): Value: `500`.
  - `message` (string, required): Default: `"Internal Server Error"`.
  - `data` (`ErrorData`, optional)
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)

### 503

503

Content type: `application/json`

Type: one of.

- One of: Option 1 (object)
  - `defined` (constant, required): Value: `true`.
  - `code` (constant, required): Value: `"SERVICE_UNAVAILABLE"`.
  - `status` (constant, required): Value: `503`.
  - `message` (string, required): Default: `"Service Unavailable"`.
  - `data` (`ErrorData`, optional)
- One of: Option 2 (object)
  - `defined` (constant, required): Value: `false`.
  - `code` (string, required)
  - `status` (number, required)
  - `message` (string, required)
  - `data` (any, optional)