Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

OptimalDial API key, prefixed od_live_, sent as Authorization: Bearer .... Mint keys in the in-app developer panel; they are scoped to a single organization.

Path Parameters

webhook_id
string<uuid>
required

Body

application/json
url
string<uri>
description
string
Maximum string length: 500
events
enum<string>[]
Available options:
upload.created,
upload.completed,
upload.failed,
contact.completed,
contact.failed,
spam.detected,
number.verified
is_active
boolean

Response

Updated endpoint.

id
string<uuid>
required
user_id
string<uuid>
required
organization_id
string<uuid>
required
url
string<uri>
required
events
enum<string>[]
required
Available options:
upload.created,
upload.completed,
upload.failed,
contact.completed,
contact.failed,
spam.detected,
number.verified
is_active
boolean
required
consecutive_failures
integer
required
Required range: x >= 0
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
Maximum string length: 500
verified_at
string<date-time> | null
last_success_at
string<date-time> | null
last_failure_at
string<date-time> | null
disabled_at
string<date-time> | null