Create a webhook subscription
curl --request POST \
--url https://api.reader.dev/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "<string>",
"name": "<string>",
"events": [
"<string>"
],
"secret": "<string>",
"headers": {}
}
'import requests
url = "https://api.reader.dev/v1/webhooks"
payload = {
"url": "<string>",
"name": "<string>",
"events": ["<string>"],
"secret": "<string>",
"headers": {}
}
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: '<string>',
name: '<string>',
events: ['<string>'],
secret: '<string>',
headers: {}
})
};
fetch('https://api.reader.dev/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.reader.dev/v1/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' => '<string>',
'name' => '<string>',
'events' => [
'<string>'
],
'secret' => '<string>',
'headers' => [
]
]),
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.reader.dev/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"secret\": \"<string>\",\n \"headers\": {}\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://api.reader.dev/v1/webhooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"secret\": \"<string>\",\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.reader.dev/v1/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\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"secret\": \"<string>\",\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"url": "<string>",
"name": "<string>",
"events": [
"<string>"
],
"headers": {},
"active": true,
"deliveryStats": {
"totalAttempts": 123,
"failedDeliveries": 123,
"lastDeliveryAt": "2023-11-07T05:31:56Z",
"lastDeliveryStatus": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"secret": "<string>"
}
}{
"success": false,
"error": {
"code": "invalid_request",
"message": "Invalid request body",
"details": {
"issues": [
{
"path": "url",
"code": "invalid_string",
"message": "Invalid url"
}
]
},
"docsUrl": "https://reader.dev/docs/home/concepts/errors#invalid-request"
}
}{
"success": false,
"error": {
"code": "conflict",
"message": "Maximum of 10 webhooks per workspace",
"details": {
"limit": 10
},
"docsUrl": "https://reader.dev/docs/home/concepts/errors#conflict"
}
}Webhooks
Create a webhook
POST
/
v1
/
webhooks
Create a webhook subscription
curl --request POST \
--url https://api.reader.dev/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"url": "<string>",
"name": "<string>",
"events": [
"<string>"
],
"secret": "<string>",
"headers": {}
}
'import requests
url = "https://api.reader.dev/v1/webhooks"
payload = {
"url": "<string>",
"name": "<string>",
"events": ["<string>"],
"secret": "<string>",
"headers": {}
}
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: '<string>',
name: '<string>',
events: ['<string>'],
secret: '<string>',
headers: {}
})
};
fetch('https://api.reader.dev/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.reader.dev/v1/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' => '<string>',
'name' => '<string>',
'events' => [
'<string>'
],
'secret' => '<string>',
'headers' => [
]
]),
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.reader.dev/v1/webhooks"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"secret\": \"<string>\",\n \"headers\": {}\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://api.reader.dev/v1/webhooks")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"secret\": \"<string>\",\n \"headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.reader.dev/v1/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\": \"<string>\",\n \"name\": \"<string>\",\n \"events\": [\n \"<string>\"\n ],\n \"secret\": \"<string>\",\n \"headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "<string>",
"url": "<string>",
"name": "<string>",
"events": [
"<string>"
],
"headers": {},
"active": true,
"deliveryStats": {
"totalAttempts": 123,
"failedDeliveries": 123,
"lastDeliveryAt": "2023-11-07T05:31:56Z",
"lastDeliveryStatus": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"secret": "<string>"
}
}{
"success": false,
"error": {
"code": "invalid_request",
"message": "Invalid request body",
"details": {
"issues": [
{
"path": "url",
"code": "invalid_string",
"message": "Invalid url"
}
]
},
"docsUrl": "https://reader.dev/docs/home/concepts/errors#invalid-request"
}
}{
"success": false,
"error": {
"code": "conflict",
"message": "Maximum of 10 webhooks per workspace",
"details": {
"limit": 10
},
"docsUrl": "https://reader.dev/docs/home/concepts/errors#conflict"
}
}Subscribe an HTTPS endpoint to job events. The
secret field, if provided, is used to sign every delivery with HMAC-SHA256. See Verifying signatures.
The secret is returned once on the create response and stripped from all subsequent list/get responses. Store it immediately.
Maximum 10 webhooks per workspace.
See Webhooks for the full delivery contract, event types, retry policy, and verification code.Authorizations
Body
application/json
⌘I

