Skip to main content
POST
Create a webhook

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
type
enum<string>
required

Event that triggers the webhook

Available options:
job_complete
Example:

"job_complete"

url
string
required

HTTP(S) URL Coval POSTs to when the event fires

Required string length: 1 - 200
Example:

"https://example.com/hooks/coval"

auth_token
string | null

Optional secret Coval sends when calling your endpoint. Never returned.

Maximum string length: 255
Example:

"whsec_example_token"

Response

Webhook created successfully

webhook
object
required

A webhook subscription. The auth token is never returned.