Accessing reports via Webhooks

Jet has a webhooks system that is available for a custom build to push data out to an API endpoint. This can be used for custom integrations with CRMs, Phone Systems, Reporting software & databases. 

Contents

Overview

Authentication

Webhook Push Timing

Available Fields

Overview

Our webhooks feature is built custom to your needs, and a consultation with a Jet specialist is required for setup.

If you would like to arrange a setup consultation for this feature, please Contact Support.

Webhook Authentication Methods

If you choose to secure your endpoint, we support the following authentication methods

OAuth 2.0

OAuth is Jet's preferred method of authentication with our webhooks. The requirements for authenticating via OAuth are as follows;

• Authentication URL required
• Client ID required
• Client Secret required
• Scope optional
• Redirect URL optional
• Access Token URL required
• Refresh Token optional

Header

A simpler method of authentication can be achieved by specifying a hardcoded value in the Header object of the webhook request. Jet supports the option to add a key:value pair to the request header which can be used to authenticate against.

For example, including a static access token using the Authorization header.

Webhook Push Timing

Webhooks are available to be pushed at various stages throughout a call event. Different information is available at the various push stages. The available fields in each push can be viewed here.
The available pushes are;

Call Start (Inbound)

The call start push is triggered as soon as the Jet phone number has been dialled by the calling party. This trigger is typically used for live push integrations where agents are required to view the caller information.

An example of typical call start data is below

Call Answered (Inbound)

The call answered push is triggered once Jet's system receives an answered status. This can be triggered either from an agent answering the phone call, or from a phone systems IVR or Queue sending back and answered signal.

An example of typical call answered data is below

Call End (Inbound)

The call end push is triggered once a call has been terminated either by the calling party or the answering party. The call end push is typically used in addition to the call start or answered in order to provide more information on call duration & handling, or if there is no live push required & the webhook is primarily being used for reporting. 

Call End (Outbound)

The outbound webhook is triggered after an outbound call has been made through a Jetphone or Cloud Mobile phone user. This is typically used by customers who need to log calls in a CRM system.

Available Fields