UpdateWebhookEndpointReq

All fields are optional — only the keys present in the request body are updated; omitted keys are left untouched. Explicit null is treated as 'no change' (no field-clear semantic). To stop a webhook from firing without losing the endpoint, set isActive: false (the supported pause mechanism — see DELETE for permanent removal).

  • description
    Type: string

    Replace the free-text label.

  • eventTypes
    Type: array string[] · WebhookEventType[] 1…enum

    Replace the subscribed event types. The new list fully replaces the previous one — to add a single type, send the full updated list including the existing types.

    values
    • workflow.started
    • workflow.failed
    • workflow.completed
    • workflow.declined
    • workflow.voided
    • Type: string · WebhookEventTypeenum

      Type of webhook event

      values
      • workflow.started
      • workflow.failed
      • workflow.completed
      • workflow.declined
      • workflow.voided
  • isActive
    Type: boolean

    Pause (false) or resume (true) deliveries. While paused: no new events fire to this webhook, in-flight retries still complete, the config keeps its id and secret, and it does NOT count toward the per-namespace cap of 4 active webhooks. Resuming reactivates without re-running setup.

  • url
    Type: stringFormat: uri

    Replace the destination URL. Must be HTTPS and publicly reachable. New URL takes effect for events fired after this update — in-flight retries continue against the previous URL.