Get WebHooks List

Get the list of all configured WebHooks under the account. Supports filtering by url (exact match on a complete http(s) URL), categoryName (an existing API_USER or the special value all), and event (event type codes). All matching WebHooks are returned in a single response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Where to Find WebHook Event Codes

For the list of supported WebHook event codes and their corresponding event types, see Supported Event Codes.

Query Params
string
length ≤ 1024
^https?://.*

Callback URL. Exact-match filter: must be a valid, complete http(s) URL. A partial string (e.g. a hostname fragment) is rejected with WEBHOOK_URL_INCORRECT (40706) before reaching the query; when valid, the query matches the full URL string exactly (t.url = #url#). Maximum 1024 characters (inclusive; 1024 accepted, 1025 rejected).

string

Associated API_USER name, or the special value all (matches WebHooks whose category is -1). If omitted, only the caller's own API_USER WebHooks are returned.

string

Event type codes (comma-separated valid codes; defaults to all if not filled). Valid codes: 1, 3, 4, 5, 7, 10, 11, 12, 18, 81, 83. Same format rules as add-webhook: a leading comma or empty token returns WEBHOOK_EVENTTYPELIST_INCORRECT (40704); a trailing comma is tolerated; whitespace around tokens is trimmed. Code 25 (Inbound Route) is a default event and not subscribable. The parameter narrows the result set to WebHooks whose event types include any of the specified codes.

string

WebHook group id (groupSeqNo, returned as id in add/update/list responses). When provided, the query matches only that WebHook after verifying it belongs to the caller; the url/categoryName/event filters no longer take part in matching, though they must still be valid if present (for categoryName, an existing API_USER owned by the caller). Must be a positive integer string: non-numeric or <= 0 returns WEBHOOK_WEBHOOKID_INCORRECT (40702); an id that does not belong to the caller returns WEBHOOK_GROUPID_NOT_FOUND (40709). When omitted, the url/categoryName/event filters apply as documented above.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json