Skip to main content

CallBackEventInfo

Returns full details for a single callback event record, including its type, trigger conditions, and associated object identifiers.

:::caution Established API The SOAP API is in maintenance mode. For new integrations use the REST equivalent. :::

Method Signature

CallBackEvent CallBackEventInfo(string SessionID, int CallBackEventID)

Parameters

ParameterTypeRequiredDescription
SessionIDstringYesActive session token from Login()
CallBackEventIDintYesUnique identifier of the callback event to retrieve

Response Object — CallBackEvent

FieldTypeDescription
CallBackEventIDintUnique identifier for this callback event definition
CallBackIDintIdentifier of the parent callback configuration
NetworkIDintNetwork associated with this event
MailboxIDintMailbox associated with this event
EventObjectsObject type that triggered the event
EventDatedatetimeTimestamp when the event was raised
ParcelIDlongParcel identifier if the event was parcel-related; 0 otherwise
InterchangeIDlongInterchange identifier if the event was interchange-related; 0 otherwise
UserIDintUser identifier if the event was user-related; 0 otherwise
StatusstringCurrent status of the event (e.g., Pending, Delivered, Failed)
URLstringCallback endpoint URL that was notified
HTTPResponseintHTTP status code returned by your endpoint
<!-- Example response XML -->
<CallBackEventResult>
<CallBackEventID>55001</CallBackEventID>
<CallBackID>42</CallBackID>
<NetworkID>1</NetworkID>
<MailboxID>100</MailboxID>
<Event>Parcel</Event>
<EventDate>2026-05-07T09:30:00</EventDate>
<ParcelID>7890123</ParcelID>
<InterchangeID>0</InterchangeID>
<UserID>0</UserID>
<Status>Delivered</Status>
<URL>https://your-app.example.com/ecgrid/callback</URL>
<HTTPResponse>200</HTTPResponse>
</CallBackEventResult>

Code Examples

// .NET 10 — dotnet-svcutil generated proxy
// Retrieve details for a specific callback event
var callBackEvent = await client.CallBackEventInfoAsync(sessionID, callBackEventID: 55001);

Console.WriteLine($"Event ID: {callBackEvent.CallBackEventID}");
Console.WriteLine($"Object Type: {callBackEvent.Event}");
Console.WriteLine($"Status: {callBackEvent.Status}");
Console.WriteLine($"HTTP Code: {callBackEvent.HTTPResponse}");
Console.WriteLine($"Event Date: {callBackEvent.EventDate:O}");

REST Equivalent

See Get Event by IDPOST /v2/callbacks/get-event-by-id.