Webhooks
Create or rotate a webhook subscription
Creates the (business, environment) webhook endpoint, or rotates the signing secret if one already exists. The plaintext secret is returned exactly once.
POST
/
v1
/
webhook-subscriptions
Create or rotate the webhook subscription for this environment
curl --request POST \
--url https://api.usecleff.com/v1/webhook-subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://api.example.com/cleff/webhooks",
"enabled_events": [
"payout.disbursement_submitted",
"payout.acknowledged",
"payout.estimated_arrival_at",
"payout.disbursed",
"beneficiary.details_submitted",
"beneficiary.bank_account.registered",
"beneficiary.enrollment_rejected"
]
}
'import requests
url = "https://api.usecleff.com/v1/webhook-subscriptions"
payload = {
"url": "https://api.example.com/cleff/webhooks",
"enabled_events": ["payout.disbursement_submitted", "payout.acknowledged", "payout.estimated_arrival_at", "payout.disbursed", "beneficiary.details_submitted", "beneficiary.bank_account.registered", "beneficiary.enrollment_rejected"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://api.example.com/cleff/webhooks',
enabled_events: [
'payout.disbursement_submitted',
'payout.acknowledged',
'payout.estimated_arrival_at',
'payout.disbursed',
'beneficiary.details_submitted',
'beneficiary.bank_account.registered',
'beneficiary.enrollment_rejected'
]
})
};
fetch('https://api.usecleff.com/v1/webhook-subscriptions', 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.usecleff.com/v1/webhook-subscriptions",
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://api.example.com/cleff/webhooks',
'enabled_events' => [
'payout.disbursement_submitted',
'payout.acknowledged',
'payout.estimated_arrival_at',
'payout.disbursed',
'beneficiary.details_submitted',
'beneficiary.bank_account.registered',
'beneficiary.enrollment_rejected'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.usecleff.com/v1/webhook-subscriptions"
payload := strings.NewReader("{\n \"url\": \"https://api.example.com/cleff/webhooks\",\n \"enabled_events\": [\n \"payout.disbursement_submitted\",\n \"payout.acknowledged\",\n \"payout.estimated_arrival_at\",\n \"payout.disbursed\",\n \"beneficiary.details_submitted\",\n \"beneficiary.bank_account.registered\",\n \"beneficiary.enrollment_rejected\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.usecleff.com/v1/webhook-subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://api.example.com/cleff/webhooks\",\n \"enabled_events\": [\n \"payout.disbursement_submitted\",\n \"payout.acknowledged\",\n \"payout.estimated_arrival_at\",\n \"payout.disbursed\",\n \"beneficiary.details_submitted\",\n \"beneficiary.bank_account.registered\",\n \"beneficiary.enrollment_rejected\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecleff.com/v1/webhook-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://api.example.com/cleff/webhooks\",\n \"enabled_events\": [\n \"payout.disbursement_submitted\",\n \"payout.acknowledged\",\n \"payout.estimated_arrival_at\",\n \"payout.disbursed\",\n \"beneficiary.details_submitted\",\n \"beneficiary.bank_account.registered\",\n \"beneficiary.enrollment_rejected\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"id": "<string>",
"environment": "<string>",
"url": "<string>",
"enabled_events": [
"<string>"
],
"enabled": true,
"created_at": "<string>"
},
"secret": "whsec_sandbox_F2x…"
}Authorizations
Cleff API key issued to a Business that self-registers via POST /v1/registration
Body
application/json
Example:
"https://api.example.com/cleff/webhooks"
Opt-in allowlist of event types to receive. Only values from this enum are accepted; a value outside it is rejected on this request.
Available options:
payout.disbursement_submitted, payout.acknowledged, payout.estimated_arrival_at, payout.disbursed, beneficiary.details_submitted, beneficiary.bank_account.registered, beneficiary.enrollment_rejected Example:
[
"payout.disbursement_submitted",
"payout.acknowledged",
"payout.estimated_arrival_at",
"payout.disbursed",
"beneficiary.details_submitted",
"beneficiary.bank_account.registered",
"beneficiary.enrollment_rejected"
]
⌘I
Create or rotate the webhook subscription for this environment
curl --request POST \
--url https://api.usecleff.com/v1/webhook-subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://api.example.com/cleff/webhooks",
"enabled_events": [
"payout.disbursement_submitted",
"payout.acknowledged",
"payout.estimated_arrival_at",
"payout.disbursed",
"beneficiary.details_submitted",
"beneficiary.bank_account.registered",
"beneficiary.enrollment_rejected"
]
}
'import requests
url = "https://api.usecleff.com/v1/webhook-subscriptions"
payload = {
"url": "https://api.example.com/cleff/webhooks",
"enabled_events": ["payout.disbursement_submitted", "payout.acknowledged", "payout.estimated_arrival_at", "payout.disbursed", "beneficiary.details_submitted", "beneficiary.bank_account.registered", "beneficiary.enrollment_rejected"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://api.example.com/cleff/webhooks',
enabled_events: [
'payout.disbursement_submitted',
'payout.acknowledged',
'payout.estimated_arrival_at',
'payout.disbursed',
'beneficiary.details_submitted',
'beneficiary.bank_account.registered',
'beneficiary.enrollment_rejected'
]
})
};
fetch('https://api.usecleff.com/v1/webhook-subscriptions', 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.usecleff.com/v1/webhook-subscriptions",
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://api.example.com/cleff/webhooks',
'enabled_events' => [
'payout.disbursement_submitted',
'payout.acknowledged',
'payout.estimated_arrival_at',
'payout.disbursed',
'beneficiary.details_submitted',
'beneficiary.bank_account.registered',
'beneficiary.enrollment_rejected'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.usecleff.com/v1/webhook-subscriptions"
payload := strings.NewReader("{\n \"url\": \"https://api.example.com/cleff/webhooks\",\n \"enabled_events\": [\n \"payout.disbursement_submitted\",\n \"payout.acknowledged\",\n \"payout.estimated_arrival_at\",\n \"payout.disbursed\",\n \"beneficiary.details_submitted\",\n \"beneficiary.bank_account.registered\",\n \"beneficiary.enrollment_rejected\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.usecleff.com/v1/webhook-subscriptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://api.example.com/cleff/webhooks\",\n \"enabled_events\": [\n \"payout.disbursement_submitted\",\n \"payout.acknowledged\",\n \"payout.estimated_arrival_at\",\n \"payout.disbursed\",\n \"beneficiary.details_submitted\",\n \"beneficiary.bank_account.registered\",\n \"beneficiary.enrollment_rejected\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecleff.com/v1/webhook-subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://api.example.com/cleff/webhooks\",\n \"enabled_events\": [\n \"payout.disbursement_submitted\",\n \"payout.acknowledged\",\n \"payout.estimated_arrival_at\",\n \"payout.disbursed\",\n \"beneficiary.details_submitted\",\n \"beneficiary.bank_account.registered\",\n \"beneficiary.enrollment_rejected\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"subscription": {
"id": "<string>",
"environment": "<string>",
"url": "<string>",
"enabled_events": [
"<string>"
],
"enabled": true,
"created_at": "<string>"
},
"secret": "whsec_sandbox_F2x…"
}