Skip to main content
PATCH
/
api
/
v1
/
webhooks
/
{webhook_id}
Update a webhook endpoint
curl --request PATCH \
  --url https://api.optimaldial.com/api/v1/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "events": [],
  "is_active": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "events": [],
  "is_active": true,
  "consecutive_failures": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "verified_at": "2023-11-07T05:31:56Z",
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "disabled_at": "2023-11-07T05:31:56Z"
}

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
​
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
​
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