TextKitDocs

Update a webhook endpoint

Change the URL, the subscribed events, or pause and resume delivery with active.

PATCH/v1/webhooks/{id}

Path Parameters

  • idstringrequired

    Example: we_a1B2c3D4e5F6.

Body Parameters

  • urlstring (uri)
  • events* or array of string
  • activeboolean

    false pauses delivery; pending retries for a paused endpoint are dropped.

  • descriptionstring

    At most 120 characters. Nullable.

  • numbersarray of string

    Replace the number filter; [] or null clears it. At most 100 items. Nullable.

Details

Send only the fields to change. The signing secret is unchanged (POST /v1/webhooks/{id}/rotate_secret replaces it).

Recorded in the audit log as webhook.updated. Scope: webhooks:write.

Responses

  • 200WebhookEndpoint

    The updated endpoint

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • idstring

    Example: we_a1B2c3D4e5F6.

  • objectwebhook_endpoint
  • urlstring (uri)
  • events* or array of string
  • numbersarray of string

    The number filter: only events about these numbers. Empty: every number.

  • activeboolean
  • modetest, live

    Which events it receives: the mode of the key that created it (or chosen in the console). A key lists and changes only its own mode's endpoints.

  • descriptionstring

    Nullable.

  • created_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded