Skip to main content
PATCH
Change a webhook endpoint

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

endpoint
string
required

The webhook endpoint id, from list_webhook_endpoints.

Required string length: 1 - 60

Body

application/json
url
string | null

An https URL that answers POST requests from the internet.

Required string length: 1 - 2048
events
string[] | null

Webhook event types from list_event_types, or ["*"] for all of them: client.created, client.invited, client.joined, checklist.sent, checklist.item_submitted, checklist.item_changes_requested, checklist.completed, document.uploaded, fact.accepted, account.connected, account.disconnected, message.created.

Required array length: 1 - 48 elements
Maximum string length: 100
description
string · null · null

A note for the firm about what the endpoint is for.

Maximum string length: 200
enabled
boolean | null

Response

Success.

object
enum<string>
required
Available options:
webhook_endpoint
id
string
required
url
string
required
description
string | null
required
events
string[]
required
status
enum<string>
required

active, failing (every delivery has failed for a day or 20 in a row) or disabled (turned off by a member or after 3 days of failures).

Available options:
active,
failing,
disabled
disabled_reason
enum<string> | null
required
Available options:
member,
failing
secret_hint
string
required

The secret’s prefix and last four characters. The full secret is never shown again.

previous_secret_expires_at
string | null
required

While set, requests are also signed with the secret before the last roll.

created_at
string
required

An ISO 8601 time in UTC.

last_delivery
object | null
required