v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
webhooks

Find specific webhook resource

Returns information about supported events for a given webhook resource

get/webhooks/resources/{resource}

Path parameters

resourcestring required

A name of a webhook resource. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed'], 'MonthlyRenewal': ['failed', 'finished'], 'LowBalance': ['failed', 'finished']

Query parameters

fieldsstring

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

Response

successful operation

resourcestring

A name of a webhook resource (ex: InboundCall, OutboundCall, InboundText, OutboundText, CallBroadcast, TextBroadcast, etc...)

supportedEventsstring[]

A list of event names which are supported by webhook resource (ex: Started, Stopped, Finished, etc.)