Skip to main content
POST
Create 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.

Body

application/json
url
string<uri>
required

HTTPS URL on a publicly resolvable host.

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

Response

Endpoint created and ping-verified.

webhook
object
required
secret
string
required

64-char hex string. Returned only on creation.

Example:

"5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8"