Skip to main content
PUT
/
onboarding
/
api
/
v1
/
webhooks
Update Webhook
curl --request PUT \
  --url https://api.carbnconnect.com/onboarding/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "url": "https://testmywebhook.requestcatcher.com/test112",
  "status": "disabled"
}
'
import requests

url = "https://api.carbnconnect.com/onboarding/api/v1/webhooks"

payload = {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"url": "https://testmywebhook.requestcatcher.com/test112",
"status": "disabled"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
url: 'https://testmywebhook.requestcatcher.com/test112',
status: 'disabled'
})
};

fetch('https://api.carbnconnect.com/onboarding/api/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.carbnconnect.com/onboarding/api/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
'url' => 'https://testmywebhook.requestcatcher.com/test112',
'status' => 'disabled'
]),
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.carbnconnect.com/onboarding/api/v1/webhooks"

payload := strings.NewReader("{\n \"id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"url\": \"https://testmywebhook.requestcatcher.com/test112\",\n \"status\": \"disabled\"\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.carbnconnect.com/onboarding/api/v1/webhooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"url\": \"https://testmywebhook.requestcatcher.com/test112\",\n \"status\": \"disabled\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.carbnconnect.com/onboarding/api/v1/webhooks")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"url\": \"https://testmywebhook.requestcatcher.com/test112\",\n \"status\": \"disabled\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "url": "https://testmywebhook.requestcatcher.com/test112",
  "status": "enabled",
  "event_category": "ONRAMP_TRANSACTION_STATUS"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
id
string<uuid>
required

Unique identifier of the webhook to update

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

url
string<uri>

The HTTPS URL where webhook events will be sent. Must use HTTPS protocol.

Pattern: ^https://.*
Example:

"https://testmywebhook.requestcatcher.com/test112"

status
enum<string>

Status of the webhook. Webhooks are created with 'disabled' status by default and must be enabled using this endpoint.

Available options:
enabled,
disabled
Example:

"disabled"

Response

Webhook updated successfully

id
string<uuid>

Unique identifier of the updated webhook

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

url
string<uri>

Updated webhook URL

Example:

"https://testmywebhook.requestcatcher.com/test112"

status
enum<string>

Updated webhook status

Available options:
enabled,
disabled
Example:

"enabled"

event_category
string

The event category for this webhook (cannot be changed after creation)

Example:

"ONRAMP_TRANSACTION_STATUS"