Get All WebHooks

The Get All WebHooks API returns every WebHook registration visible to the calling account. Use it to reconcile your own records against what Events Bridge actually has stored — for example to find hooks left behind by an integration that generated a fresh hookId on each run.

Visibility

What comes back depends on the role in your JWT:

• Standard accounts receive only the WebHooks they own, matched on hookOwnerUserName.
• Administrator accounts receive every WebHook on the server, across all accounts.

API Endpoint

• HTTP Method: GET
• Endpoint: /api/v1/settings/web-hooks
• Private Server Base URL: https://10.0.0.123:5022
• Cloud Server Base URL: https://customername.econnectcloud.com/eventsbridge

Authentication

This API call requires authentication with a JWT token, which must be passed in the header of the request.

Code Examples

C#

using eConnect.EventsBridge.Sdk;
using eConnect.EventsBridge.Sdk.Client;

// Assuming sdk is already initialized with authentication

// Returns your own WebHooks. If the account is an Administrator,
// it returns every WebHook on the server instead.
var webHooks = await sdk.WebHooksGetAllAsync();

foreach (var hook in webHooks)
{
    Console.WriteLine($"{hook.HookId}  {hook.WebHookName}");
    Console.WriteLine($"  Address:  {hook.PostbackAddress}");
    Console.WriteLine($"  Owner:    {hook.HookOwnerUserName}");
    Console.WriteLine($"  Disabled: {hook.Disabled}");
    Console.WriteLine($"  Events:   FaceRec={hook.WebHookFaceRec} Lpr={hook.WebHookLpr}");
    Console.WriteLine($"  Filter:   {hook.FilterRules}");
}

Curl

# Define variables
API_URL="https://your-domain.com/eventsbridge"
TOKEN="your_token"

# Retrieve every WebHook visible to this account
curl -X GET "$API_URL/api/v1/settings/web-hooks" \
  -H "Authorization: Bearer $TOKEN"

# Or list just the id and name of each one
curl -s -X GET "$API_URL/api/v1/settings/web-hooks" \
  -H "Authorization: Bearer $TOKEN" | jq -r '.[] | "\(.hookId)  \(.webHookName)"'

PowerShell

# Define variables
$API_URL = "https://your-domain.com/eventsbridge"
$TOKEN = "your_token"

# Retrieve every WebHook visible to this account
$webHooks = Invoke-RestMethod -Uri "$API_URL/api/v1/settings/web-hooks" -Method Get -Headers @{ "Authorization" = "Bearer $TOKEN" }

$webHooks | ForEach-Object {
    Write-Output "$($_.hookId)  $($_.webHookName)"
    Write-Output "  Address:  $($_.postbackAddress)"
    Write-Output "  Owner:    $($_.hookOwnerUserName)"
    Write-Output "  Disabled: $($_.disabled)"
    Write-Output "  Events:   FaceRec=$($_.webHookFaceRec) Lpr=$($_.webHookLpr)"
    Write-Output "  Filter:   $($_.filterRules)"
}

Raw Sample

Here's an example of how to use the GET method to retrieve all WebHooks:

Request

GET https://10.0.0.123:5022/api/v1/settings/web-hooks
Authorization: Bearer <your_jwt_token>

Response

• 200 OK: The list was retrieved. An account with no WebHooks receives an empty array.
• 401 Unauthorized: Missing or invalid JWT token.
• 500 Internal Server Error: An issue occurred on the server side.

Example Response

[
  {
    "webHookName": "PartnerServer1",
    "disabled": false,
    "filterRules": "SpecificTags",
    "specificTags": ["VIP", "Employee"],
    "hookId": "e1bce9b4-5589-4d6e-b765-8f446a8a5c10",
    "hookOwnerUserName": "partner-user",
    "postbackAddress": "https://myserver.com/webhook/callback",
    "resilient": true,
    "authBasicPasswordEncrypted": "AQAAAA...",
    "authBasicPasswordDecrypted": "",
    "serverPermitSelfSignedCerts": true,
    "authBasicUserName": "user123",
    "headerKey": "Authorization",
    "headerValue": "Bearer xxx.yyy.zzz",
    "webHookFaceRec": true,
    "webHookLpr": false,
    "maxRetryAttempts": 60,
    "retryIntervalMs": 1000,
    "useExponentialBackoff": false
  },
  {
    "webHookName": "PartnerServer2",
    "disabled": false,
    "filterRules": "All",
    "specificTags": [],
    "hookId": "d3fce2a6-b7ed-4239-b985-c287a9f56421",
    "hookOwnerUserName": "partner-user",
    "postbackAddress": "https://another-server.com/webhook",
    "resilient": false,
    "authBasicPasswordEncrypted": "",
    "authBasicPasswordDecrypted": "",
    "serverPermitSelfSignedCerts": false,
    "authBasicUserName": "",
    "headerKey": null,
    "headerValue": null,
    "webHookFaceRec": true,
    "webHookLpr": true,
    "maxRetryAttempts": 0,
    "retryIntervalMs": 1000,
    "useExponentialBackoff": false
  }
]

Field Descriptions

Each array element is a complete WebHookInfoItem. Every field is documented on the Create or Update a WebHook page.

Two fields are worth calling out when reading rather than writing:

• hookOwnerUserName: The account that owns the hook. On an administrator's list this is the only way to tell whose hook is whose.
• authBasicPasswordEncrypted: The Basic auth password in encrypted form. It is never returned in plain text, and authBasicPasswordDecrypted is always empty or null on a read.

Additional Notes

Responses contain credentials

headerValue is returned verbatim, so a bearer token you configured comes back in the clear. Treat this response as sensitive: avoid logging it whole, and be deliberate about who holds an administrator token, since that role can read every account's hooks.

• The response is not paginated and has no ordering guarantee. Match entries by hookId, not by position.
• To read a single hook you already have an id for, use Get a WebHook by ID instead of filtering this list client-side.