v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
webhooks

Find webhooks

Searches all webhooks available for a current user. Searches by name, resource, event, callback URL, or whether they are enabled. Returns a paged list of Webhooks

get/webhooks

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

limitinteger

To set the maximum number of records to return in a paged list response. The default is 100

offsetinteger

Offset to the start of a given page. The default is 0. Check pagination page for more information about pagination in CallFire API.

namestring

A name of a webhook

resourcestring

A name of a resource, available values: 'CccCampaign', 'CallBroadcast', 'TextBroadcast', 'OutboundCall', 'OutboundText', 'InboundCall', 'InboundText', 'ContactList'

eventstring

A name of event, available values: 'started', 'stopped', 'finished'

callbackstring

A callback URL

enabledboolean

Specifies whether webhook is enabled

Response

successful operation

limitinteger

A maximum number of returned items. If items.size() < limit assume no more items

offsetinteger

An offset from a start of paging source

totalCountinteger

Total count of available results. -1 if unknown