v1

latestSwagger 2.02026-08-06114161439.7 KB
webhook

Returns specific webhook records referenced matching the given filter criteria and matching the given filter criteria

Retrieves webhook configurations for a specific organizational unit. Returns webhook endpoint URLs, trigger events, authentication settings, and delivery status. Supports pagination and filtering.

get/webhook

Query parameters

ouIdinteger required

Organization unit (group) ID. Required integer. Scopes the request to this org unit.

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

URL-encoded comma-separated list of filter conditions in the form '<field> <op> <value>' where op is one of =, !=, <=, >=, >, <, like (spaces required around 'like'). Example: 'call_started > 2024-01-01'. Max 10 conditions. Filterable fields vary by endpoint.

Response

Webhook configurations with endpoints, events, and settings

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

errstring

Error message when result='error'. String. Empty/null on success.