Skip to main content
POST
/
api
/
v1
/
webhook_subscription
Create Webhook Subscription
curl --request POST \
  --url https://checkout.suave.money/api/v1/webhook_subscription \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhook_url": "<string>",
  "env_mode": "live"
}
'
import requests

url = "https://checkout.suave.money/api/v1/webhook_subscription"

payload = {
"webhook_url": "<string>",
"env_mode": "live"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({webhook_url: '<string>', env_mode: 'live'})
};

fetch('https://checkout.suave.money/api/v1/webhook_subscription', 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://checkout.suave.money/api/v1/webhook_subscription",
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([
'webhook_url' => '<string>',
'env_mode' => 'live'
]),
CURLOPT_HTTPHEADER => [
"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://checkout.suave.money/api/v1/webhook_subscription"

payload := strings.NewReader("{\n \"webhook_url\": \"<string>\",\n \"env_mode\": \"live\"\n}")

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

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://checkout.suave.money/api/v1/webhook_subscription")
.header("Content-Type", "application/json")
.body("{\n \"webhook_url\": \"<string>\",\n \"env_mode\": \"live\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://checkout.suave.money/api/v1/webhook_subscription")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhook_url\": \"<string>\",\n \"env_mode\": \"live\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "Successfully registered webhook endpoint in test|live mode for {vendor_name}.",
  "data": {
    "webhook_id": "ep_2k4DQEpnKDxp1TcvsNIRiKDBQtj",
    "webhook_url": "webhook endpoint url",
    "env_mode": "test",
    "created_at": "2024-08-01T17:38:56.892Z",
    "updated_at": "2024-08-01T17:38:56.892Z"
  }
}

Body

application/json
webhook_url
string
env_mode
enum<string>
default:live

The env_mode parameter allows you to specify whether the webhook is intended for testing or production environments.

Available options:
test,
live

Response

200 - application/json

Subscription created successfully

message
string
Example:

"Successfully registered webhook endpoint in test|live mode for {vendor_name}."

data
object