Skip to main content

list-callback-events

List the callback (webhook) registrations under a specific (networkId, mailboxId) pair. A callback is a rule that makes ECGrid POST a notification to a configured URL when a parcel or interchange event occurs on the mailbox. Use to enumerate which callbacks a mailbox has and review their config and status. Both networkId and mailboxId must be known — discover them via list-mailboxes or connectivity_network_get-network-by-id. An empty result (count = 0) means no callbacks match — this is a successful outcome, not an error.

Tool Name​

connectivity_callback_list-callback-events

Auth Level Required​

Any (scoped to caller's APIKey)

Parameters​

ParameterTypeRequiredDescription
request.networkIdintegerYesInternal numeric network ID that scopes the listing. Positive integer >= 1. Example: 7. Combine with mailboxId to identify exactly one mailbox — both are required. Values of 0 or below are rejected as VALIDATION_ERROR.
request.mailboxIdintegerYesInternal numeric mailbox ID within networkId. Non-negative integer >= 0. Example: 142. 0 is a valid value referring to the network's root mailbox. Values below 0 are rejected as VALIDATION_ERROR.
request.showInactivebooleanNoWhen true, include inactive (Suspended, Terminated) callback registrations. Defaults to false — only Active, Development, and Preproduction registrations are returned.

Response​

Returns count plus an events array of registration config records. The per-event queue array is empty by design — call get-callback-event-by-id to retrieve a registration with its embedded delivery queue. HTTP auth credentials are never returned.

{
  "count": 2,
  "events": [
    {
      "callBackEventId": 4821,
      "networkId": 7,
      "mailboxId": 142,
      "systemObject": "Parcel",
      "direction": "InBox",
      "frequency": 5,
      "maxCalls": 10,
      "status": "Active",
      "url": "https://example.com/ecgrid-webhook",
      "httpAuthType": "Basic",
      "queue": []
    },
    {
      "callBackEventId": 4822,
      "networkId": 7,
      "mailboxId": 142,
      "systemObject": "Interchange",
      "direction": "OutBox",
      "frequency": 10,
      "maxCalls": 5,
      "status": "Active",
      "url": "https://example.com/ecgrid-webhook-out",
      "httpAuthType": "None",
      "queue": []
    }
  ]
}

Response Fields​

FieldTypeDescription
countintegerNumber of callback registrations returned. 0 means no callbacks match — not an error.
eventsarrayArray of callback registration records
events[].callBackEventIdintegerUnique numeric ID of this callback registration. Pass to get-callback-event-by-id to retrieve its delivery queue.
events[].networkIdintegerECGrid network ID that owns this callback
events[].mailboxIdintegerECGrid mailbox ID that owns this callback
events[].systemObjectstringECGrid object type that triggers the callback (e.g. Parcel, Interchange)
events[].directionstringTraffic direction that triggers the callback: InBox, OutBox, or NoDir
events[].frequencyintegerRetry frequency in minutes between delivery attempts
events[].maxCallsintegerMaximum number of delivery attempts before a queue entry is marked failed
events[].statusstringRegistration status: Active, Development, Preproduction, Suspended, or Terminated
events[].urlstringWebhook target URL that ECGrid POSTs to
events[].httpAuthTypestringHTTP authentication type: None, Basic, or Digest. Credentials are never returned.
events[].queuearrayAlways empty in this listing response — call get-callback-event-by-id to retrieve a registration's queue

Example Call​

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "connectivity_callback_list-callback-events",
    "arguments": {
      "request": {
        "networkId": 7,
        "mailboxId": 142
      }
    }
  }
}

Example Prompts​

  • List all callbacks configured for mailbox 142
  • Show me every webhook registration on mailbox 142, including inactive ones

See Also​