Create an outbound webhook subscription
curl --request POST \
--url https://api.example.com/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://erp.example.com/webhooks/caratuva",
"eventTypes": [
"payment_intent.settled",
"payment_intent.failed"
]
}
'import requests
url = "https://api.example.com/v1/webhooks"
payload = {
"url": "https://erp.example.com/webhooks/caratuva",
"eventTypes": ["payment_intent.settled", "payment_intent.failed"]
}
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({
url: 'https://erp.example.com/webhooks/caratuva',
eventTypes: ['payment_intent.settled', 'payment_intent.failed']
})
};
fetch('https://api.example.com/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.example.com/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([
'url' => 'https://erp.example.com/webhooks/caratuva',
'eventTypes' => [
'payment_intent.settled',
'payment_intent.failed'
]
]),
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.example.com/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://erp.example.com/webhooks/caratuva\",\n \"eventTypes\": [\n \"payment_intent.settled\",\n \"payment_intent.failed\"\n ]\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.example.com/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://erp.example.com/webhooks/caratuva\",\n \"eventTypes\": [\n \"payment_intent.settled\",\n \"payment_intent.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/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 \"url\": \"https://erp.example.com/webhooks/caratuva\",\n \"eventTypes\": [\n \"payment_intent.settled\",\n \"payment_intent.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "ckwh001",
"orgId": "ckorg001",
"url": "https://erp.example.com/webhooks/caratuva",
"eventTypes": [
"payment_intent.settled",
"payment_intent.failed"
],
"active": true,
"createdAt": "2026-06-30T12:00:00.000Z",
"updatedAt": "2026-06-30T12:00:00.000Z",
"secret": "whsec_3f9a1c7e0b2d4f6a8c1e3b5d7f9a0c2e"
}{
"statusCode": 400,
"error": "ValidationError",
"message": "url must be a valid URL and eventTypes must contain 1–32 known event types."
}Webhooks
Create an outbound webhook subscription
Subscribe an HTTPS endpoint to one or more event types. Caratuva POSTs each matching event signed with a per-subscription HMAC secret (the x-caratuva-signature header). The signing secret is returned ONCE in this response and is never retrievable again — persist it now so you can verify delivery signatures; if you lose it, rotate the secret to mint a new one.
POST
/
v1
/
webhooks
Create an outbound webhook subscription
curl --request POST \
--url https://api.example.com/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://erp.example.com/webhooks/caratuva",
"eventTypes": [
"payment_intent.settled",
"payment_intent.failed"
]
}
'import requests
url = "https://api.example.com/v1/webhooks"
payload = {
"url": "https://erp.example.com/webhooks/caratuva",
"eventTypes": ["payment_intent.settled", "payment_intent.failed"]
}
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({
url: 'https://erp.example.com/webhooks/caratuva',
eventTypes: ['payment_intent.settled', 'payment_intent.failed']
})
};
fetch('https://api.example.com/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.example.com/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([
'url' => 'https://erp.example.com/webhooks/caratuva',
'eventTypes' => [
'payment_intent.settled',
'payment_intent.failed'
]
]),
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.example.com/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://erp.example.com/webhooks/caratuva\",\n \"eventTypes\": [\n \"payment_intent.settled\",\n \"payment_intent.failed\"\n ]\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.example.com/v1/webhooks")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://erp.example.com/webhooks/caratuva\",\n \"eventTypes\": [\n \"payment_intent.settled\",\n \"payment_intent.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/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 \"url\": \"https://erp.example.com/webhooks/caratuva\",\n \"eventTypes\": [\n \"payment_intent.settled\",\n \"payment_intent.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "ckwh001",
"orgId": "ckorg001",
"url": "https://erp.example.com/webhooks/caratuva",
"eventTypes": [
"payment_intent.settled",
"payment_intent.failed"
],
"active": true,
"createdAt": "2026-06-30T12:00:00.000Z",
"updatedAt": "2026-06-30T12:00:00.000Z",
"secret": "whsec_3f9a1c7e0b2d4f6a8c1e3b5d7f9a0c2e"
}{
"statusCode": 400,
"error": "ValidationError",
"message": "url must be a valid URL and eventTypes must contain 1–32 known event types."
}Authorizations
apiKeybearer
Body
application/json
Required array length:
1 - 32 elementsAvailable options:
invoice.created, invoice.approved, invoice.buyer_invited, invoice.buyer_kyc_approved, invoice.buyer_kyc_rejected, invoice.on_ramp_started, invoice.fiat_received, invoice.on_chain_confirmed, invoice.offramp_initiated, invoice.settled, invoice.offramp_failed, invoice.failed, invoice.cancelled, invoice.expired, payment_intent.created, payment_intent.buyer_kyc_approved, payment_intent.buyer_kyc_rejected, payment_intent.on_chain_confirmed, payment_intent.settled, payment_intent.failed, payment_intent.cancelled, payment_intent.expired, connected_account.created, connected_account.kyb_approved, connected_account.kyb_rejected, connected_account.ready_to_collect