Get a WebHook by ID

The Get WebHook by ID API returns a single WebHook registration. Use it when your system has already persisted a hookId and wants to read back the current configuration without pulling the full list.

The most common reason to call it is a read-modify-write: fetch the stored item, change one field, and send the whole object back with Create or Update a WebHook.

API Endpoint

• HTTP Method: GET
• Endpoint: /api/v1/settings/web-hooks/{hookId}
• 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.

Path Parameter

• hookId: The unique ID of the WebHook to retrieve, in GUID/UUID format. A value that is not a valid GUID does not match this route at all and returns 404.

Code Examples

C#

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

// Assuming sdk is already initialized with authentication
// Requires eConnect.EventsBridgeSdk 1.2.0 or later.

var hookId = Guid.Parse("e1bce9b4-5589-4d6e-b765-8f446a8a5c10");

try
{
    var webHook = await sdk.WebHookGetAsync(hookId);

    Console.WriteLine($"Name:     {webHook.WebHookName}");
    Console.WriteLine($"Address:  {webHook.PostbackAddress}");
    Console.WriteLine($"Disabled: {webHook.Disabled}");
}
catch (EventsBridgeSdkException ex) when (ex.StatusCode == 404)
{
    // A missing hook is signalled by an exception, not a null return.
    // Either the hook does not exist, or it belongs to another account -
    // the server returns the same 404 for both cases on purpose.
    Console.WriteLine("No WebHook with that id is visible to this account.");
}

Curl

# Define variables
API_URL="https://your-domain.com/eventsbridge"
TOKEN="your_token"
HOOK_ID="e1bce9b4-5589-4d6e-b765-8f446a8a5c10"

# Retrieve a single WebHook by its id
curl -X GET "$API_URL/api/v1/settings/web-hooks/$HOOK_ID" \
  -H "Authorization: Bearer $TOKEN"

# Separate a missing hook from a real failure by checking the status code
STATUS=$(curl -s -o /dev/null -w "%{http_code}" \
  -X GET "$API_URL/api/v1/settings/web-hooks/$HOOK_ID" \
  -H "Authorization: Bearer $TOKEN")

if [ "$STATUS" = "404" ]; then
  echo "No WebHook with that id is visible to this account."
fi

PowerShell

# Define variables
$API_URL = "https://your-domain.com/eventsbridge"
$TOKEN = "your_token"
$HOOK_ID = "e1bce9b4-5589-4d6e-b765-8f446a8a5c10"

try {
    $webHook = Invoke-RestMethod -Uri "$API_URL/api/v1/settings/web-hooks/$HOOK_ID" -Method Get -Headers @{ "Authorization" = "Bearer $TOKEN" }

    Write-Output "Name:     $($webHook.webHookName)"
    Write-Output "Address:  $($webHook.postbackAddress)"
    Write-Output "Disabled: $($webHook.disabled)"
}
catch [System.Net.WebException], [Microsoft.PowerShell.Commands.HttpResponseException] {
    if ($_.Exception.Response.StatusCode -eq 404) {
        # Either the hook does not exist, or it belongs to another account.
        Write-Output "No WebHook with that id is visible to this account."
    }
    else {
        throw
    }
}

Raw Sample

Here's an example of how to use the GET method to retrieve a single WebHook:

Request

GET https://10.0.0.123:5022/api/v1/settings/web-hooks/e1bce9b4-5589-4d6e-b765-8f446a8a5c10
Authorization: Bearer <your_jwt_token>

Response

• 200 OK: The WebHook was found and is returned.
• 404 Not Found: No WebHook with that hookId is visible to you — see the note below.
• 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
}

Field Descriptions

The response is a complete WebHookInfoItem. Every field is documented on the Create or Update a WebHook page.

Additional Notes

You can only read your own WebHooks

A hookId that belongs to another account returns exactly the same 404 as a hookId that was never used, so this endpoint cannot be used to discover whether someone else's WebHook exists. Administrators can read any WebHook.

If you get a 404 for an id you believe you created, confirm you are authenticating as the account that created it.

Preserve authBasicPasswordEncrypted on read-modify-write

The response returns the Basic auth password in its encrypted form as authBasicPasswordEncrypted, never in plain text. If you GET a WebHook, change a field and PUT it back, send that value back unchanged — dropping it clears the stored credential. To set a new password, put the plain text in authBasicPasswordDecrypted instead and the server encrypts it on save.

The .NET SDK signals 404 with an exception, not a null return

WebHookGetAsync was added in eConnect.EventsBridgeSdk 1.2.0. On a 404 it throws EventsBridgeSdkException with StatusCode set to 404 rather than returning null, so a "does this hook exist?" check has to be written as a catch, as in the C# example above. Earlier SDK versions do not expose this call at all.