Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
webhooks

Create a webhook

Create a Webhook for notification in the CallFire system. Use the webhooks API to receive notifications of important CallFire events. Select the resource to listen to, and then choose the resource events to receive notifications on. When an event triggers, a POST will be made to the callback URL with a payload of notification information. Available resources and their events 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']. Webhooks support secret token which is used as signing key to HmacSHA256 hash of json payload which is returned in 'X-CallFire-Signature-256' header. This header can be used to verify callback POST is coming from CallFire. See security guide

post/webhooks

Request body

idinteger

An id of a webhook

enabledboolean

A parameter which allows the webhook to send requests to unknown ssl endpoints (ssl certificate verification is disabled)

nonStrictSslboolean

A parameter which allows the webhook to send requests to unknown ssl endpoints (ssl certificate verification is disabled)

namestring

A name of a webhook

resourcestring

A resource name that webhook is watching events on. Use GET /webhooks/resources to determine resources and events available (ex: InboundCall, OutboundCall, InboundText, OutboundText, CallBroadcast, TextBroadcast, etc...)

eventsstring[]

Comma separated list of events on resource that will trigger callbacks (ex: STARTED, STOPPED, FINISHED, etc...).

fieldsstring

A limit callback response to a particular fields

callbackstring

URL that webhook will send POST to on resource event trigger

secretstring

Webhook secret token which is used as a signing key to HmacSHA256 hash of json payload which is returned in 'X-CallFire-Signature-256' header. This header can be used to verify callback POST is coming from CallFire. See security guide

singleUseboolean

If true is set then webhook triggers only once. Afterwards the webhook will be deleted

createdAtinteger

A time when the given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000

updatedAtinteger

A time when the given resource was updated, formatted in unix time milliseconds (read only). Example: 1473781817000

expiresAtinteger

~

Response

successful operation

idinteger

An id of a resource