PATCHlive

Enable or disable a webhook endpoint

Canonical API flag required. Requires callbacks:manage and the platform orchestrator role. Endpoint URLs are immutable; use POST to rotate. DELETE is an idempotent soft disable. PATCH cannot activate an endpoint while another endpoint is active.

/api/webhooks/endpoints/{id}updateWebhookEndpoint

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}

Request body

Required request body.

application/json

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    }
  }
}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalUpdateWebhookEndpointResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalWebhookEndpointResult",
      "type": "object",
      "properties": {
        "endpoint": {
          "$ref": "#/components/schemas/CanonicalWebhookEndpoint",
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "partnerId": {
              "type": "string"
            },
            "url": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "active",
                "retiring",
                "disabled"
              ]
            },
            "signatureVersion": {
              "type": "string",
              "const": "pc-webhook-ed25519-v1"
            },
            "replacesEndpointId": {
              "type": "string"
            },
            "overlapUntil": {
              "type": "string"
            },
            "createdAt": {
              "type": "string"
            },
            "updatedAt": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "partnerId",
            "url",
            "status",
            "signatureVersion",
            "createdAt",
            "updatedAt"
          ]
        },
        "rotation": {
          "type": "object",
          "properties": {
            "mode": {
              "type": "string"
            },
            "overlapUntil": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "endpoint"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ],
  "x-code-source": "lib/partner-api/v2/webhook-endpoints.ts"
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "endpoint": {
      "id": "id_test",
      "partnerId": "partner_test_123",
      "url": "https://partner.test.example/callbacks/peoples-court",
      "status": "active",
      "signatureVersion": "pc-webhook-ed25519-v1",
      "createdAt": "createdAt_test",
      "updatedAt": "updatedAt_test"
    }
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.