Web Hooks

Want to keep your systems up to date with ours? See every time 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, updated 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

  • id
  • lnp_request_id
  • number
  • state
  • ratecenter

lnp_requests

  • id
  • user_id
  • btn
  • location_type
  • business_contact
  • business_name
  • first_name
  • last_name
  • account_number
  • service_address
  • service_state
  • service_zip
  • partial_port
  • partial_port_details
  • wireless_number
  • wireless_pin
  • caller_id
  • request_status
  • foc_date

sip_accounts

  • id
  • user_id
  • account_type
  • username
  • domain
  • sbc_number

monthly_charges

  • id
  • user_id
  • product_type
  • product_id
  • bill_day_of_month
  • last_billed_dt

sub_users

  • id
  • parent_id
  • username
  • email
  • first_name
  • last_name
  • phone_number
  • address
  • city
  • state
  • zip

transaction_items

  • id
  • transaction_id
  • product_description
  • product_price
  • product_mrc
  • processing_flags
  • fail_reason

transactions

  • id
  • user_id
  • child_id
  • referenced_transaction_id
  • total
  • summary
  • transaction_type
  • transaction_status

users

  • id
  • reseller_id
  • user_type
  • username
  • email
  • first_name
  • last_name
  • phone_number
  • address
  • city
  • state
  • zip
  • brand
  • domain
  • using_custom_css
  • using_custom_logo
  • support_phone
  • support_email
  • support_link
  • user_status
  • credit_line
  • chanlimit_outbound
  • chanlimit_inbound
  • max_international
  • sms_post_url
  • web_hook_url
  • sbc

call_flows

  • id
  • user_id
  • flow_name
  • flow_data
  • default_route

channel_groups

  • id
  • user_id
  • name
  • channels
  • status

did_notes

  • id
  • did_id
  • note

dids

  • id
  • user_id
  • call_flow_id
  • channel_group_id
  • voicemail_inbox_id
  • number
  • number_type
  • state
  • ratecenter
  • sms_enabled
  • xmpp_enabled
  • inbound_cnam

directory_listings

  • id
  • did_id
  • listing_type
  • business_name
  • first_name
  • last_name
  • address1
  • address2
  • city
  • state
  • zip
  • email
  • contact_number

e911

  • id
  • did_id
  • did_number
  • full_name
  • address
  • city
  • state
  • zip
  • unit_type
  • unit_number

fax_emails

  • id
  • did_id
  • email_address

faxes

  • id
  • did_id
  • fax_status
  • direction
  • source_did
  • destination_did
  • recipient
  • pages

ip_endpoints

  • id
  • user_id
  • ip_address
  • ip_name
  • sbc

voicemail_emails

  • id
  • voicemail_inbox_id
  • email_address

voicemail_inboxes

  • id
  • user_id
  • inbox_number
  • inbox_name
  • inbox_pin
  • transcribe

results matching ""

    No results matching ""