Web Hooks

Table of Contents

Want to keep your systems up to date with ours? See everytime someone on your account buys a number? Adds a sip account? Yeah. Just set up your web hook url and you can.

The high level overview of what is happening here is that whenever something happens on your account, we send a web call with the pertinent data. All calls will have the basic format:

{
  "type": "update",
  "schema": "dids",
  "data": "{ dids object }"
}

type

The type will be one of three things: insert, update, delete. Insert for a new record, update if we've modified an existing record, delete if that record has been removed.

schema

Basically, just the object type. What was it that was insert, udpated or deleted.

data

This is the meat of the hook. Every different schema type will have different data here, but in short it is a JSON string (will need a parse on your end) that has all the associated information for a record.

Schemas

List of the fields available for each schema type. Always do do diligence and check if a field is in the object before using it, rather than just assuming.

lnp_numbers

lnp_requests

sip_accounts

monthly_charges

sub_users

transaction_items

transactions

users

call_flows

channel_groups

did_notes

dids

directory_listings

e911

fax_emails

faxes

ip_endpoints

voicemail_emails

voicemail_inboxes