Creates a new webhook setting
curl --request POST \
--url https://gateway.paybyrd.com/api/v2/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "https://your-url.com/webhook"
}
'import requests
url = "https://gateway.paybyrd.com/api/v2/webhooks"
payload = { "url": "https://your-url.com/webhook" }
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://your-url.com/webhook'})
};
fetch('https://gateway.paybyrd.com/api/v2/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://gateway.paybyrd.com/api/v2/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://your-url.com/webhook'
]),
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://gateway.paybyrd.com/api/v2/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://your-url.com/webhook\"\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://gateway.paybyrd.com/api/v2/webhooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://your-url.com/webhook\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.paybyrd.com/api/v2/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://your-url.com/webhook\"\n}"
response = http.request(request)
puts response.read_body{
"id": "8668e1dc-3f0c-407d-9aff-f5dda1ee8eaf",
"url": "https://your-url.com/webhook",
"webhookUser": "b73e9449-e1dc-485a-b4c7-19c540e96cd1",
"webhookPassword": "@bc123",
"events": []
}Webhooks
Creates a new webhook setting
This endpoint allows you to configure more than one address for webhooks notifications.
POST
/
api
/
v2
/
webhooks
Creates a new webhook setting
curl --request POST \
--url https://gateway.paybyrd.com/api/v2/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "https://your-url.com/webhook"
}
'import requests
url = "https://gateway.paybyrd.com/api/v2/webhooks"
payload = { "url": "https://your-url.com/webhook" }
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://your-url.com/webhook'})
};
fetch('https://gateway.paybyrd.com/api/v2/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://gateway.paybyrd.com/api/v2/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://your-url.com/webhook'
]),
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://gateway.paybyrd.com/api/v2/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://your-url.com/webhook\"\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://gateway.paybyrd.com/api/v2/webhooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://your-url.com/webhook\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.paybyrd.com/api/v2/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://your-url.com/webhook\"\n}"
response = http.request(request)
puts response.read_body{
"id": "8668e1dc-3f0c-407d-9aff-f5dda1ee8eaf",
"url": "https://your-url.com/webhook",
"webhookUser": "b73e9449-e1dc-485a-b4c7-19c540e96cd1",
"webhookPassword": "@bc123",
"events": []
}Authorizations
Body
application/json
Your server URL to receive the notifications from Paybyrd
⌘I

