This is a high-level overview of how and when to use the different hooks to access data outside Kazoo using our Pivot, Webhooks, or Websocket developer tools.

<aside> 💡 Note: These tools can be accessed directly through an API, or by using the application available in Monster UI and comm.land. The applications allow you to track your different assignments and troubleshoot/debug your code in a single view.

</aside>

In Short:

Pivot is for when you want to fully hand over call control to a 3rd party server.

Webhooks is a read-only notification tool, that will inform you of an event.

Websockets are a peristent connection

• Fully hand over call control to a third party server. Pivot reaches out and literally says "what do I do now"

• expect a response as XML or JSON for next steps

• Configured as part of a callflow | Webhooks is a notification … saying this happened

• Request events to be sent to your server • Read-only • AMQP->HTTP bridge • Custom webhooks via callflows • Simple HTTP request is sent from Kazoo to your server ◦ Respond with 200 only (auto-disabled otherwise) ◦ If possible, relay data to separate process for use • Update rows in a database or spreadsheet • Screen pops • Use with Pivot to build reactive routing logic

Of the three options, only webhooks can cascade down child accounts

NOTE: This refers to the webhooks are set on an account level. There is also a webhook callflow item. | Websockets are peristent

• Persistent connection • Lower overhead (no polling) • Get events and issue commands to Kazoo • Richer UI interactions with Kazoo (operator console)

Typically for real-time communication with an end-users client software (like monster-ui or comm.land). Can technically be used for server-to-server, but is difficult because a server would need to monitor and keep alive the connection even through disconnects during maintenance events | | API Description | **Pivot API documentation**

The Pivot gives developers greater control over callflows than what comes natively in Kazoo. Pivot attempts to corral the salient data and send it, via HTTP to the developer's web server. Pivot expects a response with appropriate XML or JSON, and will execute the callflow returned on behalf of the developer. | **Webhooks API documentation**

Webhooks allow Kazoo to send HTTP requests to a third-party web server, alerting that server of events occurring within Kazoo. Typically, events would be fired for new calls, when a call is answered, and when a call is finished, though other events will be added in the future. Actually there are a great number of webhooks that are really useful. For example some folks will use the “object” webhook to monitor for when their users make new billable items such as devices and users. They use this to automatically update their billing systems. SMS and MMS webhooks are also used extensively! | Websockets API documentation

Blackhole creates a point of contact between KAZOO and your system, using websockets, to stream events occurring in KAZOO to your connected session(s). Blackhole is effectively an AMQP->Websocket bridge, providing you with real-time event streams about calls, API changes, and more. | | Use Case | Problem: - voicemail redirect

I want to redirect all support to voicemail when a status page it is up. Solution: Use Pivot. It'll contact a third party server that'll look up the status page status. And it can inform the callflow to proceed to ringing support or to go to voicemail depending on if a status page is up or not. Problem: - SMS Options in Virtual Receptionist The pivot is the key component that will take code from our system and send it to the phone number that has called in as a text message with or without a link. See example below | Problem

I want my CRM to know about any calls that are made to the sales group. Solution: Use the webhook callflow item right before the sales group is run to inform the CRM that a sales call has been received. | | | Examples | See **this example** from Simple VOIP, showing use of Pivot inside Callflows | | | | Known Issues | Pivot actions created in Callflows do NOT save in the Pivot app. | | |