--- sourceDocument: Australia Workflow Data Fabric sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications Release : - australia ft:locale : - en-US ft:publication_title : - Australia Workflow Data Fabric ft:clusterId : - crint bundleId : - crint workflow : - Creator --- # Vonage Spoke # Vonage Spoke {#ariaid-title1} * Release version: Australia * * Updated March 12, 2026 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 minutes to read Manage communications through calls, SMS, and WhatsApp by using the Vonage account from your ServiceNow instance. ## Request apps on the Store {#vonage-spoke__section_sz5_jv3_z3b} Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the [ServiceNow Store version history release notes](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).{#vonage-spoke__inline-send-to-store} ## Integration Hub subscription {#vonage-spoke__section_rsf_yvb_l3b} This spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf). ## Spoke version {#vonage-spoke__section_mxx_ndy_bsb} Vonage spoke v2.1.0 is the latest version.{#vonage-spoke__vonagespk-vr} ## Supported versions {#vonage-spoke__section_sv2_1n2_pmb} This spoke was built for Vonage for these versions, but may be compatible with later versions: * Messages API version v1 * Voice API version v1 {#vonage-spoke__ul_usd_grf_pmb} ## Spoke requirements {#vonage-spoke__section_vv2_1n2_pmb} * Admin access to Vonage account and [Vonage API Dashboard](https://dashboard.nexmo.com/). * Record the values of API key and API Secret. You can access these values from the Vonage API Dashboard. For more information, see the [Authentication](https://developer.nexmo.com/concepts/guides/authentication) page in the [Vonage API Developer](https://developer.nexmo.com/documentation) documentation site.{#vonage-spoke__vonage-api-key} * Record and save the value of the Signature Secret. You can access this value in the [Account Settings in Vonage API Dashboard](https://dashboard.nexmo.com/settings). For more information, see the [Authentication](https://developer.nexmo.com/concepts/guides/authentication) page in the [Vonage API Developer](https://developer.nexmo.com/documentation) documentation site. {#vonage-spoke__ul_wv2_1n2_pmb} ## Spoke dependencies {#vonage-spoke__section_xv2_1n2_pmb} If you're having trouble installing the app, ensure that these dependent plugins are installed: * ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest) * ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime) * Complex Object (com.glide.cobject) * ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs) {#vonage-spoke__ul_yv2_1n2_pmb} Note: Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation. ## Spoke subflows {#vonage-spoke__section_uxx_tgf_kfb} The Vonage spoke provides sample subflows to demonstrate automating Vonage tasks. To customize a sample subflow, copy it to a new application scope. Available sample subflows include: {#vonage-spoke__table_hbd_qty_qfb__entry__2} | Subflow | Description | |-|-| | Vonage SMS Webhook | Processes the SMS requests from Vonage. | | Vonage Voice Webhook | Processes the voice requests from Vonage. | | Vonage WhatsApp Webhook | Processes the WhatsApp requests from Vonage. | [ ] {#vonage-spoke__table_hbd_qty_qfb}To customize the default subflow, you must a create a copy of the sample subflow and customize the subflow as per your requirement. While customizing subflows, you must ensure that the subflows are configured to avoid infinite loops. ## Spoke triggers {#vonage-spoke__section_kvw_1mn_nhc} Use triggers in the Vonage spoke to subscribe to the required events. The endpoint enables webhooks to connect with your ServiceNow instance. You can configure the flows to execute only when the specified trigger conditions are met. The supported events are:{#vonage-spoke__table_chb_5mn_nhc__entry__3} | Category | Trigger | Description | |-|-|-| | Call Management | Voice Ringing | Trigger is initiated when a call is made from Vonage and the number is Ringing. | | Call Management | Voice Answered | Trigger is initiated when a call is made from Vonage and the call is Answered. | | Call Management | Voice Completed | Trigger is initiated when a call is made from Vonage and the call is Completed. | | SMS Management | SMS Delivered | Trigger is initiated when an SMS is sent from Vonage to a number. | | SMS Management | SMS Failed | Trigger is initiated when an SMS is sent from Vonage and it fails. | | SMS Management | SMS Accepted | Trigger is initiated when a message has been accepted for delivery, but has not yet delivered. | [ ] {#vonage-spoke__table_chb_5mn_nhc}For information about setting up the triggers for the Vonage spoke, see Setup the trigger for vonage spoke. ## Spoke actions {#vonage-spoke__section_b43_3h2_hfb} The Vonage spoke provides actions to automate Vonage tasks when events occurs in your ServiceNow instance. Available actions include: {#vonage-spoke__table_u1p_kh2_hfb__entry__3}{#vonage-spoke__vonage}{#vonage-spoke__whatsapp} | Category | Action | Description | |-|-|-| | Account Management | Get Account Balance | Retrieves the current balance of the Vonage account. | | Call Management | Play DTMF tone into Call | Plays DTMF (Dual-tone multi-frequency) tones into an active call | | Call Management | Attach Recording To ServiceNow Record | Attaches a call recording to the target ServiceNow record. | | Call Management | Create Outbound Call | Creates an outbound call to a phone number. | | Call Management | Generate NCCO | Constructs a Nexmo Call Control Objects (NCCO) that is used in Create an Outbound Call action. | | Call Management | Generate Connect NCCO | Generates a Nexmo Call Control Object (NCCO) that defines how to connect an outbound call to endpoints such as a phone number or WebSocket. | | Call Management | Generate Notify NCCO | Generates a Nexmo Call Control Object (NCCO) that defines a notify action for an outbound call. | | Call Management | Generate Transfer NCCO | Generates a Nexmo Call Control Object (NCCO) that defines how to transfer an active call. | | Call Management | Look Up Call Details | Retrieves the details of the specified call. | | Call Management | Look up Calls | Retrieves details of the specified calls. | | Call Management | Play Audio into Call | Plays an audio file into an active call. | | Call Management | Play Text to Speech into Call | Plays text-to-speech into an active call. | | Call Management | Stop Playing Audio into Call | Stops playing an audio file into an active call. | | Call Management | Stop Text to Speech In Call | Stops text-to-speech into an active call. | | Call Management | Update Call | Updates the status of an active call. | | Number Management | Look up Numbers | Retrieves all the inbound numbers associated with the Vonage account. | | RCS Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send RCS Card Message | Sends an RCS (Rich Communication Services) card message to a specified phone number. | | RCS Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send RCS Media Message | Sends an RCS (Rich Communication Services) media message to a specified phone number. | | RCS Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send RCS Text Message | Sends an RCS (Rich Communication Services) text message to a specified phone number. | | SMS Management | Send SMS | Sends an SMS (Short Message Service) to a phone number. | | WhatsApp Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send Contacts | Sends contacts to a WhatsApp number. | | WhatsApp Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send Location | Sends geographic coordinates of a location to a WhatsApp number. | | WhatsApp Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send Media Message | Sends a media message to a WhatsApp number. | | WhatsApp Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send Text Message | Sends a text message to a WhatsApp number. | | WhatsApp Management Note: If you are upgrading from an earlier version of the spoke, make sure to generate a new JWT token in your existing credential record before using this category actions. | Send Text Message Using Template | Sends a text message using the template to a WhatsApp number. | [ ] {#vonage-spoke__table_u1p_kh2_hfb} ## Spoke module {#vonage-spoke__section_w2k_lyx_qlb} Bi-directional webhooks can be set up to be notified about the required events. Routing policy defines conditions that must be met to notify the ServiceNow instance. These conditions are based on the events in Vonage that you want to be notified about. When the conditions are met, routing policy triggers the associated subflow, which in turn automates the Vonage tasks. By default, the Vonage Spoke application is available and has the following modules: * Vonage Webhook Registries * Vonage WebHook Routing Policies {#vonage-spoke__ul_qzt_2h4_z3b} Use the Vonage Webhook Registries module to assign a token and provide the API path. You must generate a Callback URL here and provide this URL in Vonage. Default routing policies are provided as a reference in the Vonage WebHook Routing Policies module. Customize these routing policies as per your requirement. The routing policy supports these fields: * Keywords * Call Direction * Call Status * Event Type * From * SMS Status * SMS Text * To * WhatsApp Message Status * WhatsApp Text * Show Related Fields {#vonage-spoke__supp-fields-vonage} ## Connection and credential alias requirements {#vonage-spoke__section_ibn_pj2_hfb} Integration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see [Connections and Credentials](https://www.servicenow.com/docs/access?context=r-credentials&version=australia&pubname=australia-platform-security&ft:locale=en-US). Two connection and credential aliases are available along with the Vonage spoke:{#vonage-spoke__table_gtq_d52_pmb__entry__2} | Vonage alias | Description | |-|-| | VonagePrimary | Required for the actions that manage SMS, number, and account. | | Vonage | Required for the actions that manage calls and WhatsApp. | [ ] {#vonage-spoke__table_gtq_d52_pmb} For information about setting up the spoke, see [Set up the Vonage spoke](https://www.servicenow.com/docs/VUr2Ur5TWBbuRytEnkTtdQ#setup-vonage-spoke "Integrate your ServiceNow instance with the Vonage instance to enable communication between them. With this integration, your ServiceNow instance can automate actions on the Vonage instance, while the Vonage instance can send payloads to your ServiceNow instance.").