curl --request PATCH \
--url https://api.engineapi.com.br/v1/webhooks/config \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"webhookUrl": "<string>",
"events": []
}
'import requests
url = "https://api.engineapi.com.br/v1/webhooks/config"
payload = {
"webhookUrl": "<string>",
"events": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhookUrl: '<string>', events: []})
};
fetch('https://api.engineapi.com.br/v1/webhooks/config', 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.engineapi.com.br/v1/webhooks/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'webhookUrl' => '<string>',
'events' => [
]
]),
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.engineapi.com.br/v1/webhooks/config"
payload := strings.NewReader("{\n \"webhookUrl\": \"<string>\",\n \"events\": []\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.engineapi.com.br/v1/webhooks/config")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webhookUrl\": \"<string>\",\n \"events\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engineapi.com.br/v1/webhooks/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhookUrl\": \"<string>\",\n \"events\": []\n}"
response = http.request(request)
puts response.read_bodyAtualizar configuração de webhooks
Configura a URL de destino e os eventos que deseja receber. Não há campo secret neste endpoint: o secret HMAC (whsec_...) é gerado pela API na primeira vez que você configura uma webhookUrl (partner ainda sem secret) e só muda via POST /v1/webhooks/secret/regenerate (invalida o anterior imediatamente). O secret completo (revealedOnce: true) só vem nesta resposta quando ela acabou de gerá-lo; guarde-o na hora — não é recuperável, só regenerável. Qualquer outro PATCH (secret já existia) devolve mascarado. Cada entrega é assinada com HMAC SHA-256 (header X-Webhook-Signature); valide sempre antes de processar. Falha de entrega tem retentativa automática (5 tentativas, backoff até 24h); esgotadas, o evento cai na Dead Letter Queue (GET /v1/webhooks/dlq), reenviável manualmente. Só JWT do dashboard ou chave ek_live_; ek_test_ recebe 403 (o secret é único por parceiro, não por ambiente). Ver Webhooks.
curl --request PATCH \
--url https://api.engineapi.com.br/v1/webhooks/config \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"webhookUrl": "<string>",
"events": []
}
'import requests
url = "https://api.engineapi.com.br/v1/webhooks/config"
payload = {
"webhookUrl": "<string>",
"events": []
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({webhookUrl: '<string>', events: []})
};
fetch('https://api.engineapi.com.br/v1/webhooks/config', 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.engineapi.com.br/v1/webhooks/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'webhookUrl' => '<string>',
'events' => [
]
]),
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.engineapi.com.br/v1/webhooks/config"
payload := strings.NewReader("{\n \"webhookUrl\": \"<string>\",\n \"events\": []\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.engineapi.com.br/v1/webhooks/config")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"webhookUrl\": \"<string>\",\n \"events\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engineapi.com.br/v1/webhooks/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"webhookUrl\": \"<string>\",\n \"events\": []\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key do Partner (formato: ek_live_UUID)
Body
Response
Configuração atualizada. webhookSecret vem completo (revealedOnce: true) só quando este PATCH acabou de gerar o secret pela primeira vez; do contrário vem mascarado.