Get It Done Logo
Get It Done

Update a webhook endpoint

PATCH/v1/webhook-endpoints/{endpoint_id}

Partial update of url/event_types/enabled — org-scoped, 404 for a cross-org or unknown id. NEVER rotates the secret (use the `rotate-secret` action). Changing `url` to a different value resets `verified` to false. The (re-validated) URL check can answer 422 `webhook_url_rejected`.

Required scopes
webhooks:write
Availability
Pro & Team plans
Quota cost
1 API call
Idempotency
Not applicable

Request

Path parameters

FieldTypeDescription
endpoint_idrequiredstring

Request body

FieldTypeDescription
urlstringNew destination URL, re-validated the same way as create. Changing the URL to a DIFFERENT value resets `verified` to false — the new destination must be re-verified.
event_types"task.created" | "task.updated" | "task.archived"[]Replaces the full subscribed-type set.
enabledbooleanEnable or disable delivery. Re-enabling (false → true) clears any prior auto-disable reason and resets the consecutive-failure counter.
Raw request schema
{
  "type": "object",
  "properties": {
    "url": {
      "description": "New destination URL, re-validated the same way as create. Changing the URL to a DIFFERENT value resets `verified` to false — the new destination must be re-verified.",
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "event_types": {
      "description": "Replaces the full subscribed-type set.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WebhookEndpointEventType"
      }
    },
    "enabled": {
      "description": "Enable or disable delivery. Re-enabling (false → true) clears any prior auto-disable reason and resets the consecutive-failure counter.",
      "type": "boolean"
    }
  },
  "description": "Partial update — only send the fields you want to change; at least one is required."
}

Response 200

The updated endpoint.

Fields

FieldTypeDescription
idrequiredstringStable id of the endpoint.
urlrequiredstringThe https destination URL.
enabledrequiredbooleanFalse when disabled — manually, or auto-disabled after repeated delivery failures (see `disabled_reason`).
event_typesrequired"task.created" | "task.updated" | "task.archived"[]Subscribed event types. An EMPTY array means "every type".
verifiedrequiredbooleanTrue once the `verify` action has proven this endpoint accepts a correctly-signed request.
disabled_reasonrequiredstring | nullWhy the endpoint was auto-disabled, or null when never auto-disabled.
created_atrequiredstring (date-time)ISO-8601 UTC.
updated_atrequiredstring (date-time)ISO-8601 UTC.
Raw response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Stable id of the endpoint."
    },
    "url": {
      "type": "string",
      "description": "The https destination URL."
    },
    "enabled": {
      "type": "boolean",
      "description": "False when disabled — manually, or auto-disabled after repeated delivery failures (see `disabled_reason`)."
    },
    "event_types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WebhookEndpointEventType"
      },
      "description": "Subscribed event types. An EMPTY array means \"every type\"."
    },
    "verified": {
      "type": "boolean",
      "description": "True once the `verify` action has proven this endpoint accepts a correctly-signed request."
    },
    "disabled_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Why the endpoint was auto-disabled, or null when never auto-disabled."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "ISO-8601 UTC."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
      "description": "ISO-8601 UTC."
    }
  },
  "required": [
    "id",
    "url",
    "enabled",
    "event_types",
    "verified",
    "disabled_reason",
    "created_at",
    "updated_at"
  ],
  "additionalProperties": false,
  "description": "A webhook endpoint configuration — NEVER includes the signing secret (shown once, at creation/rotation)."
}

Example request

curl
curl -X PATCH https://app.nowgetitdone.com/v1/webhook-endpoints/whep_a1b2c3 \
  -H "Authorization: Bearer gid_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Possible errors