Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.coval.dev/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "job_complete",
  "url": "https://example.com/hooks/coval",
  "auth_token": "whsec_example_token"
}
'
import requests

url = "https://api.coval.dev/v1/webhooks"

payload = {
"type": "job_complete",
"url": "https://example.com/hooks/coval",
"auth_token": "whsec_example_token"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'job_complete',
url: 'https://example.com/hooks/coval',
auth_token: 'whsec_example_token'
})
};

fetch('https://api.coval.dev/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coval.dev/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'job_complete',
'url' => 'https://example.com/hooks/coval',
'auth_token' => 'whsec_example_token'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.coval.dev/v1/webhooks"

payload := strings.NewReader("{\n \"type\": \"job_complete\",\n \"url\": \"https://example.com/hooks/coval\",\n \"auth_token\": \"whsec_example_token\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.coval.dev/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"job_complete\",\n \"url\": \"https://example.com/hooks/coval\",\n \"auth_token\": \"whsec_example_token\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"job_complete\",\n \"url\": \"https://example.com/hooks/coval\",\n \"auth_token\": \"whsec_example_token\"\n}"

response = http.request(request)
puts response.read_body
{
  "webhook": {
    "name": "webhooks/abc123DEF456ghi789JKL0",
    "id": "abc123DEF456ghi789JKL0",
    "type": "job_complete",
    "url": "https://example.com/hooks/coval",
    "create_time": "2025-10-14T12:00:00Z",
    "has_auth_token": true,
    "last_triggered_at": "2025-10-15T09:30:00Z"
  }
}
{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request body",
"details": [
{
"field": "url",
"description": "url must be an HTTP(S) URL."
}
]
}
}
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}
{
"error": {
"code": "PERMISSION_DENIED",
"message": "Insufficient permissions",
"details": [
{
"field": "permissions",
"description": "API key does not have required permission: webhooks:write"
}
]
}
}
{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}
{
"error": {
"code": "INTERNAL",
"message": "Service temporarily unavailable",
"details": [
{
"description": "Database routing is temporarily unavailable. Please retry."
}
]
}
}

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.