sdkDeterministic

Update webhook endpoint

pipeline.updateWebhookEndpoint

Update an outbound webhook endpoint, its explicit subscriptions, filters, destination authentication, or active and paused status.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

endpointIdrequired

string

No description.

name

string

No description.

url

string

No description.

eventTypes

string[]

No description.

filters

object

No description.

destinationAuth

object

Destination authentication. Use { type: "keep" } to preserve the configured secret.

active

boolean

No description.

status

string

No description.

active | paused

Example

TypeScripttypescript

await pipeline.updateWebhookEndpoint({
  "endpointId": "00000000-0000-4000-8000-000000000000"
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "endpoint": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "eventTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "filters": {
          "type": "object"
        },
        "apiVersion": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "paused",
            "auto_paused"
          ]
        },
        "pauseReason": {
          "type": [
            "string",
            "null"
          ]
        },
        "health": {
          "type": "string",
          "enum": [
            "never_delivered",
            "healthy",
            "failing"
          ]
        },
        "destinationAuth": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "headerName": {
              "type": [
                "string",
                "null"
              ]
            },
            "configured": {
              "type": "boolean"
            }
          },
          "required": [
            "type",
            "headerName",
            "configured"
          ]
        },
        "consecutiveFailures": {
          "type": "number"
        },
        "lastSuccessAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastFailureAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "lastError": {
          "type": [
            "string",
            "null"
          ]
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "workspaceId",
        "name",
        "url",
        "eventTypes",
        "filters",
        "apiVersion",
        "status",
        "pauseReason",
        "health",
        "destinationAuth",
        "consecutiveFailures",
        "lastSuccessAt",
        "lastFailureAt",
        "lastError",
        "createdAt",
        "updatedAt"
      ]
    }
  },
  "required": [
    "endpoint"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.