Create webhook
POST /v1/webhooks scope admin
Creates a webhook. The url must be https on a public host (private IPs, localhost and cloud metadata addresses are refused with unsafe_url). The signing secret is returned ONCE. At most 10 per workspace.
Headers
Authorization: Bearer praeko_… and X-Praeko-Contract: en. Always send both.Parameters
| Name | In | Description |
|---|---|---|
Idempotency-Key |
header | Idempotency key (1 to 255 visible characters, for example a UUID). Repeating the SAME request with the same key within 24 h returns the stored response (with Idempotent-Replayed: true) without running it again; a different request with the same key returns 422 idempotency_key_reuse; a request still in progress returns 409 idempotency_in_progress. 5xx errors are not stored. The key is scoped per workspace and per route. See Retry a request safely. |
Request body
JSON. Required fields must be sent; the others can be left out.
| Field | Type | Description |
|---|---|---|
url required |
string | URL that receives the events. Must be https on a public domain (no user and password; private IPs, localhost and internal names are refused with unsafe_url). Up to 2048 characters. |
events (optional) |
string[] | Events that trigger the webhook. At least one. Values: post.sent, post.failed, post.scheduled-fail; default: post.sent, post.failed. |
active (optional) |
boolean | Whether the webhook starts enabled. Default: true. |
{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}Example
curl -X POST "https://praeko.app/v1/webhooks" \
-H "Authorization: Bearer $PRAEKO_KEY" \
-H "X-Praeko-Contract: en" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}'const res = await fetch("https://praeko.app/v1/webhooks", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.PRAEKO_KEY}`,
"X-Praeko-Contract": "en",
"Content-Type": "application/json",
},
body: JSON.stringify({
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}),
});
console.log(res.status, await res.json());import { Praeko } from "@praeko/sdk";
const praeko = new Praeko({ url: "https://praeko.app", key: process.env.PRAEKO_KEY });
const resultado = await praeko.webhooks.create({
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
});
console.log(resultado);import os
import requests
resp = requests.post(
"https://praeko.app/v1/webhooks",
headers={
"Authorization": f"Bearer {os.environ['PRAEKO_KEY']}",
"X-Praeko-Contract": "en",
},
json={
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed",
],
"active": True,
},
)
print(resp.status_code, resp.json())<?php
$corpo = <<<'JSON'
{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}
JSON;
$ch = curl_init('https://praeko.app/v1/webhooks');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("PRAEKO_KEY"),
'X-Praeko-Contract: en',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => $corpo,
]);
$resposta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $resposta, PHP_EOL;
curl_close($ch);package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}`)
req, err := http.NewRequest("POST", "https://praeko.app/v1/webhooks", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("PRAEKO_KEY"))
req.Header.Set("X-Praeko-Contract", "en")
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
out, _ := io.ReadAll(resp.Body)
fmt.Println(resp.Status, string(out))
}require "net/http"
require "uri"
uri = URI("https://praeko.app/v1/webhooks")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV['PRAEKO_KEY']}"
request["X-Praeko-Contract"] = "en"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, response.bodyusing System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://praeko.app/v1/webhooks");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PRAEKO_KEY"));
request.Headers.Add("X-Praeko-Contract", "en");
request.Content = new StringContent("""
{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}
""", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String body = """
{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://praeko.app/v1/webhooks"))
.header("Authorization", "Bearer " + System.getenv("PRAEKO_KEY"))
.header("X-Praeko-Contract", "en")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}http POST "https://praeko.app/v1/webhooks" \
"Authorization: Bearer $PRAEKO_KEY" \
"X-Praeko-Contract: en" \
"Content-Type: application/json" \
--raw='{
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}'Official SDK for NodeInstall it with
npm install @praeko/sdk (see SDK and CLI).No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
Response
| Success status | When |
|---|---|
200 |
Success. |
{
"id": "wh_01KA3X4D8P6TQ1VZ0C7MH2NB5R",
"url": "https://example.com/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true,
"secretHint": "whsec_…k3Qw",
"consecutiveFailures": 0,
"createdAt": "2026-11-07T14:02:11.482Z",
"updatedAt": "2026-11-07T14:02:11.482Z",
"secret": "whsec_8vN2xQe4L1mTz7Hc0Yb5Wd3KfRj6PaUo9GtSi2XnVEw",
"warning": "store this secret now: it will not be shown again"
}warning is free text the server writes in Portuguese; the example shows it in English.
Errors
| Status | code | When |
|---|---|---|
| 400 | empty_body |
The request body is empty. |
| 400 | invalid_json |
The request body is not a JSON object. |
| 413 | body_too_large |
The request body is larger than 1 MB. |
| 422 | invalid_field |
url missing or events empty/unknown. |
| 422 | unsafe_url |
The url is not https, or points to a private network or localhost. |
| 409 | webhook_limit_reached |
This workspace already has 10 webhooks. |
| 422 | idempotency_key_reuse |
The Idempotency-Key was already used with a different request (different method, path, query or body). |
| 409 | idempotency_in_progress |
A request with the same Idempotency-Key is still in progress (retry in a moment). |
| 409 | idempotency_response_too_large |
The original response was larger than 256 KB and was not stored; fetch the resource with GET instead. |
Errors on any route
| Status | code | When |
|---|---|---|
| 401 | unauthorized |
The Authorization: Bearer … header is missing. |
| 401 | invalid_api_key |
The key does not exist. |
| 401 | revoked_api_key |
The key has been revoked. |
| 401 | expired_api_key |
The key has expired. |
| 403 | forbidden |
The key's scope is not enough for this route (see the scope badge). |
| 429 | rate_limited |
The per-minute request limit was exceeded. |
The body of every error is { "error": { "code", "message", "details"? } }. See all error codes.
Try it
Try it
Sign in to try itThe live test uses your key and your account. It stays off when you are not signed in.
Question or mistake on this page? contato@praeko.appView .md