Criar webhook
POST /v1/webhooks escopo admin
Cria um webhook. A url precisa ser https e de um host público (IP privado, localhost e endereços de metadados de nuvem são recusados com unsafe_url). O secret de assinatura volta UMA vez. No máximo 10 por workspace.
Cabeçalhos
Authorization: Bearer praeko_… e X-Praeko-Contract: en. Sempre envie os dois.Parâmetros
| Nome | Onde | Descrição |
|---|---|---|
Idempotency-Key |
cabeçalho | Chave de idempotência (1 a 255 caracteres visíveis, por exemplo um UUID). Repetir o MESMO pedido com a mesma chave, em até 24 h, devolve a resposta guardada (com Idempotent-Replayed: true) sem executar de novo; outro pedido com a mesma chave dá 422 idempotency_key_reuse; um pedido ainda em andamento dá 409 idempotency_in_progress. Erros 5xx não são guardados. A chave vale por workspace e por rota. Veja Repetir uma requisição. |
Corpo da requisição
JSON. Campos obrigatórios precisam ir; os outros podem ser omitidos.
| Campo | Tipo | Descrição |
|---|---|---|
url obrigatório |
texto | Endereço que recebe os eventos. Precisa ser https, de um domínio público (sem usuário e senha; IP privado, localhost e nomes internos são recusados com unsafe_url). Até 2048 caracteres. |
events (opcional) |
string[] | Eventos que disparam o webhook. Pelo menos um. Valores: post.sent, post.failed, post.scheduled-fail; padrão: post.sent, post.failed. |
active (opcional) |
verdadeiro/falso | Se o webhook começa ligado. Padrão: true. |
{
"url": "https://exemplo.com.br/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}Exemplo
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://exemplo.com.br/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://exemplo.com.br/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://exemplo.com.br/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://exemplo.com.br/hooks/praeko",
"events": [
"post.sent",
"post.failed",
],
"active": True,
},
)
print(resp.status_code, resp.json())<?php
$corpo = <<<'JSON'
{
"url": "https://exemplo.com.br/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://exemplo.com.br/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://exemplo.com.br/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://exemplo.com.br/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://exemplo.com.br/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://exemplo.com.br/hooks/praeko",
"events": [
"post.sent",
"post.failed"
],
"active": true
}'SDK oficial para NodeInstale com
npm install @praeko/sdk (veja SDK e CLI).Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Resposta
| Status de sucesso | Quando |
|---|---|
200 |
Sucesso. |
{
"id": "wh_01KA3X4D8P6TQ1VZ0C7MH2NB5R",
"url": "https://exemplo.com.br/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": "guarde este segredo agora: ele não aparece de novo"
}Erros
| Status | code | Quando |
|---|---|---|
| 400 | empty_body |
O corpo veio vazio. |
| 400 | invalid_json |
O corpo não é um objeto JSON. |
| 413 | body_too_large |
O corpo passa de 1 MB. |
| 422 | invalid_field |
url ausente ou events vazio/desconhecido. |
| 422 | unsafe_url |
A url não é https, aponta para rede privada ou localhost. |
| 409 | webhook_limit_reached |
Já são 10 webhooks neste workspace. |
| 422 | idempotency_key_reuse |
A Idempotency-Key já foi usada com outro pedido (método, caminho, query ou corpo diferentes). |
| 409 | idempotency_in_progress |
Um pedido com a mesma Idempotency-Key ainda está em andamento (repita em instantes). |
| 409 | idempotency_response_too_large |
A resposta original passou de 256 KB e não foi guardada; consulte o recurso por GET. |
Erros de qualquer rota
| Status | code | Quando |
|---|---|---|
| 401 | unauthorized |
Faltou o cabeçalho Authorization: Bearer …. |
| 401 | invalid_api_key |
A chave não existe. |
| 401 | revoked_api_key |
A chave foi revogada. |
| 401 | expired_api_key |
A chave expirou. |
| 403 | forbidden |
O escopo da chave não basta para esta rota (veja o selo de escopo). |
| 429 | rate_limited |
Passou do limite de requisições por minuto. |
O corpo de todo erro é { "error": { "code", "message", "details"? } }. Veja todos os códigos.
Testar
Testar
Entre para testarO teste ao vivo usa a sua chave e a sua conta. Para quem não entrou, fica desligado.
Dúvida ou erro nesta página? contato@praeko.appVer .md