Get webhook
curl --request GET \
--url https://developer.encrata.com/api/webhooks/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.encrata.com/api/webhooks/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://developer.encrata.com/api/webhooks/{id}', 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://developer.encrata.com/api/webhooks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://developer.encrata.com/api/webhooks/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://developer.encrata.com/api/webhooks/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.encrata.com/api/webhooks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"id": "<string>",
"workspace_id": "<string>",
"kind": "<string>",
"url": "<string>",
"secret": "<string>",
"events": [
"<string>"
],
"is_active": true,
"description": "<string>",
"config": {},
"created_by": {},
"created_at": "<string>",
"updated_at": "<string>"
},
"message": "<string>"
}Webhooks
Get webhook
Fetch one webhook, including its signing secret.
GET
/
api
/
webhooks
/
{id}
Get webhook
curl --request GET \
--url https://developer.encrata.com/api/webhooks/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.encrata.com/api/webhooks/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://developer.encrata.com/api/webhooks/{id}', 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://developer.encrata.com/api/webhooks/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://developer.encrata.com/api/webhooks/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://developer.encrata.com/api/webhooks/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.encrata.com/api/webhooks/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"id": "<string>",
"workspace_id": "<string>",
"kind": "<string>",
"url": "<string>",
"secret": "<string>",
"events": [
"<string>"
],
"is_active": true,
"description": "<string>",
"config": {},
"created_by": {},
"created_at": "<string>",
"updated_at": "<string>"
},
"message": "<string>"
}Returns a single webhook. This is the only endpoint that returns a
Any workspace role can read a webhook:
generic webhook’s signing secret after creation.
Authentication
Send your API key as a bearer token.Authorization: Bearer enc_xxxxxxxxxxxx
admin, tech, or readonly. The secret field is returned only for admin.
Request
string
required
The webhook ID to fetch.
curl https://developer.encrata.com/api/webhooks/360cb300-d885-4c18-af2c-d259f936bb38 \
-H "Authorization: Bearer enc_xxxxxxxxxxxx"
import requests
webhook_id = "360cb300-d885-4c18-af2c-d259f936bb38"
response = requests.get(
f"https://developer.encrata.com/api/webhooks/{webhook_id}",
headers={"Authorization": "Bearer enc_xxxxxxxxxxxx"},
)
webhook = response.json()["result"]
print(webhook["url"], webhook.get("secret"))
const webhookId = "360cb300-d885-4c18-af2c-d259f936bb38";
const response = await fetch(
`https://developer.encrata.com/api/webhooks/${webhookId}`,
{ headers: { Authorization: "Bearer enc_xxxxxxxxxxxx" } },
);
const { result } = await response.json();
console.log(result.url, result.secret);
Response
boolean
true when the request succeeded.object
The webhook.
Hide webhook
Hide webhook
string
Webhook identifier (UUID).
string
The workspace this webhook belongs to.
string
Destination type:
generic, slack, discord, or telegram.string
The HTTPS URL that receives deliveries. Empty for
telegram.string
The HMAC-SHA256 signing secret, used to verify
X-Encrata-Signature.Returned only when both conditions hold: your role is admin, and kind is generic. A Telegram bot token is never returned.string[]
The subscribed event types.
boolean
Whether Encrata currently delivers to this endpoint.
string
Your label for the webhook. Empty string when unset.
object
Destination-specific settings. Present only for
telegram, carrying chat_id.string | null
User ID of the creator, or
null when unknown.string
ISO 8601 creation timestamp.
string
ISO 8601 last-updated timestamp.
string
A human-readable summary.
Example response
{
"success": true,
"result": {
"id": "360cb300-d885-4c18-af2c-d259f936bb38",
"workspace_id": "51cdc9d9-203c-4345-b06d-222b560460aa",
"kind": "generic",
"url": "https://example.com/webhooks/encrata",
"secret": "6cce5d5445b12e649ce9e715a2ef4addc9117d6bf3013a0f388997ed20711b1c",
"events": ["lookup.completed", "credits.low"],
"is_active": true,
"description": "Production webhook",
"created_by": "e861d7cb-1d7f-48d9-ab13-9af06a4055cf",
"created_at": "2026-05-02T12:00:00Z",
"updated_at": "2026-05-02T12:00:00Z"
},
"message": "Webhook loaded."
}
Treat the
secret like a password. Anyone holding it can forge a delivery that passes your signature check. If it leaks, delete the webhook and create a new one: secrets cannot be rotated in place.Errors
| Status | Code | When |
|---|---|---|
400 | bad_request | No ID was supplied in the path. |
401 | unauthorized | The API key is missing, revoked, or disabled. |
403 | forbidden | Your key resolves to no workspace membership. |
404 | not_found | No webhook with that ID exists in your workspace. |
500 | internal | Encrata could not load the webhook. Retry. |
Example error
{
"success": false,
"result": { "code": "not_found" },
"message": "That webhook no longer exists. It may have been deleted."
}
Next steps
Verify signatures
Use the secret to validate every delivery.
List webhooks
See every endpoint in the workspace.
Send a test event
Confirm the endpoint is reachable.
Inspect deliveries
Review attempts and retries.
Was this page helpful?