Create a webhook endpoint
curl --request POST \
--url https://api.ringup.dev/v1/webhook_endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://example.com/webhooks/ringup",
"events": [
"checkout.succeeded",
"checkout.failed"
]
}
'import requests
url = "https://api.ringup.dev/v1/webhook_endpoints"
payload = {
"url": "https://example.com/webhooks/ringup",
"events": ["checkout.succeeded", "checkout.failed"]
}
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://example.com/webhooks/ringup',
events: ['checkout.succeeded', 'checkout.failed']
})
};
fetch('https://api.ringup.dev/v1/webhook_endpoints', 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.ringup.dev/v1/webhook_endpoints",
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://example.com/webhooks/ringup',
'events' => [
'checkout.succeeded',
'checkout.failed'
]
]),
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.ringup.dev/v1/webhook_endpoints"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhooks/ringup\",\n \"events\": [\n \"checkout.succeeded\",\n \"checkout.failed\"\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.ringup.dev/v1/webhook_endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhooks/ringup\",\n \"events\": [\n \"checkout.succeeded\",\n \"checkout.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ringup.dev/v1/webhook_endpoints")
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://example.com/webhooks/ringup\",\n \"events\": [\n \"checkout.succeeded\",\n \"checkout.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"webhook_endpoint_id": "wh_2b6f14ac",
"url": "https://example.com/webhooks/ringup",
"events": [
"checkout.succeeded",
"checkout.failed"
],
"signing_secret": "whsec_example_not_a_real_secret"
}API Reference
Create a webhook endpoint
Register an HTTPS endpoint for signed events. The signing secret is returned once.
POST
/
v1
/
webhook_endpoints
Create a webhook endpoint
curl --request POST \
--url https://api.ringup.dev/v1/webhook_endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://example.com/webhooks/ringup",
"events": [
"checkout.succeeded",
"checkout.failed"
]
}
'import requests
url = "https://api.ringup.dev/v1/webhook_endpoints"
payload = {
"url": "https://example.com/webhooks/ringup",
"events": ["checkout.succeeded", "checkout.failed"]
}
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://example.com/webhooks/ringup',
events: ['checkout.succeeded', 'checkout.failed']
})
};
fetch('https://api.ringup.dev/v1/webhook_endpoints', 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.ringup.dev/v1/webhook_endpoints",
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://example.com/webhooks/ringup',
'events' => [
'checkout.succeeded',
'checkout.failed'
]
]),
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.ringup.dev/v1/webhook_endpoints"
payload := strings.NewReader("{\n \"url\": \"https://example.com/webhooks/ringup\",\n \"events\": [\n \"checkout.succeeded\",\n \"checkout.failed\"\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.ringup.dev/v1/webhook_endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://example.com/webhooks/ringup\",\n \"events\": [\n \"checkout.succeeded\",\n \"checkout.failed\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ringup.dev/v1/webhook_endpoints")
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://example.com/webhooks/ringup\",\n \"events\": [\n \"checkout.succeeded\",\n \"checkout.failed\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"webhook_endpoint_id": "wh_2b6f14ac",
"url": "https://example.com/webhooks/ringup",
"events": [
"checkout.succeeded",
"checkout.failed"
],
"signing_secret": "whsec_example_not_a_real_secret"
}⌘I