{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21590,"path":"integrate-applications/integration-hub/setup-vonage-spoke.md","title":"Set up the Vonage spoke","bundle":null,"doc_type":null,"release":"australia","body":"\n# Set up the Vonage spoke\n\nIntegrate 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.\n\n## Before you begin\n\n- Request an Integration Hub subscription.\n- Activate the Vonage spoke plugin on your ServiceNow instance.\n- Role required: admin.\n- Vonage developer instance account.\n\n## Configure the Vonage developer instance\n\nGenerate essential credentials, such as API keys, secrets, and signature secrets, to set up your Vonage developer instance. Your ServiceNow instance uses these credentials in the connection record to connect to the Vonage developer instance.\n\n### Before you begin\n\nRole required: admin\n\nAccess to a Vonage developer account.\n\n### Procedure\n\n1. Log in to [https://developer.vonage.com/en/home](https://developer.vonage.com/en/home).\n\n2. On the Vonage Developer Center page, select My dashboard.\\[Omitted image \"Vonage-spoke-my-dashboard-link.png\"\\] Alt text: My dashboard page.\n\n3. On the Vonage API Dashboard page, use the default API key and the API secret or create your custom API key and API secret.\n\n 1. To use the default API key and the API secret, copy the default API key and the API secret values.\\[Omitted image \"Vonage-spoke-copy-API-key-secret.png\"\\] Alt text: Copy button for API key and API secret.\n\n 2. To generate a custom API key and API secret, on the left panel, select API Settings.\\[Omitted image \"Vonage-spoke-api-settings-link.png\"\\] Alt text: API settings link.\n\n 3. Select **Request more API keys**.\n\n 4. Fill and submit the form.\n\n 5. Select **Create new secret**.\n\n 6. In the Add a new secret window, enter your custom secret.\n\n 7. Select **Save**.\n\n4. From the Signature secret field, copy the signature secret.\n\n\n## Configure connection record for Vonage connection and credential alias\n\nConfigure a connection record that enables your ServiceNow instance to connect with the Vonage instance and automate various actions on the Vonage instance. For example, create a flow on Workflow Studio that gets your Vonage account balance.\n\n### Before you begin\n\nRole required: admin\n\n**Note:** Ensure that you are in the **Vonage spoke** scope.\n\n\\[Omitted image \"vonage-spoke-scope.png\"\\] Alt text:\n\n### Procedure\n\n1. Navigate to **All** > **Process Automation** > **Flow Designer**.\n\n2. Select Connections.\n\n3. In the Search all connections field, enter `Vonage`.\\[Omitted image \"search-all-conections.png\"\\] Alt text: Search all connections field.\n\n4. On the Vonage card, select **View Details**.\n\n5. Select **Configure**.\n\n6. Fill the form.\n\n |Field|Description|\n |-----|-----------|\n |Connection Name|The default and read-only name of the connection record. To provide a custom name to the connection record, create a connection record by selecting **Add Connection**.|\n |Connection URL|The URL to connect to the Vonage API.|\n |Messages API Version|The version of APIs the connection record requests for using the SMS feature in the Vonage instance.|\n |Voice API Version|The version of APIs the connection record requests for using the Voice feature in the Vonage instance.|\n |Credential Name|Name of the credential record. The default name os Vonage credential which you can update.|\n |Application Name|Name of the account that you had entered in the Settings page of the Vonage developers account.\\[Omitted image \"Vonage-spoke-conn-record-account-name.png\"\\] Alt text: Account name field on Vonage instance.|\n |API Key|API key you had acquired in the Vonage developer instance.|\n |API Secret|API secret you had acquired in the Vonage developer instance.|\n |Signature Secret|Signature secret key you had acquired in the Vonage developer instance.|\n\n7. Select **Create Connection**.\n\n\n## Configure connection record for Vonage Primary alias\n\nConfigure a connection record that enables your ServiceNow instance to connect with the Vonage instance and automate various actions on the Vonage instance. For example, create a flow on Workflow Studio that gets your Vonage account balance.\n\n### Before you begin\n\nRole required: admin\n\n**Note:** Ensure that you are in the **Vonage spoke** scope.\n\n\\[Omitted image \"vonage-spoke-scope.png\"\\] Alt text:\n\n### Procedure\n\n1. Navigate to **All** > **Process Automation** > **Flow Designer**.\n\n2. Select Connections.\n\n3. In the Search all connections field, enter `Vonage`.\\[Omitted image \"search-all-conections.png\"\\] Alt text: Search all connections field.\n\n4. On the VonagePrimary card, select **View Details**.\n\n5. Select **Configure**.\n\n6. Fill the form.\n\n |Field|Description|\n |-----|-----------|\n |Connection Name|The default and read-only name of the connection record. To provide a custom name to the connection record, create a connection record by selecting **Add Connection**.|\n |Connection URL|The URL to connect to the Vonage API. Enter [https://rest.nexmo.com](https://rest.nexmo.com).|\n |API Key|API key you had acquired in the Vonage developer instance.|\n |API Secret|API secret you had acquired in the Vonage developer instance.|\n\n7. Select **Create Connection**.\n\n\n## Create a webhook to receive data from Vonage\n\nSet up webhooks for SMS to enable the Vonage API platform to send data to your ServiceNow instance. For instance, if a flow in your ServiceNow instance sends an API request for call details to the Vonage API but the request fails initially, the webhook ensures that the Vonage API sends the data later.\n\n### Before you begin\n\nRole required: admin.\n\n### Procedure\n\n1. Navigate to **All** > **Vonage spoke** > **Vonage webhook Registries**.\n\n2. Select **New**.\n\n3. On the form, fill in these fields.\n\n |Field|Description|\n |-----|-----------|\n |Name|Name to uniquely identify the webhook record.|\n |Description|Description of the webhook record.|\n |Event Type|Type of event for which the webhook is set up. Select **SMS**.|\n |Secret Key|Secret key to authenticate the webhook requests. Enter your custom secret key.|\n\n4. Right-click the form header and select **Save**.\n\n5. Select **Callback URL**.\n\n The system displays the webhook callback URL.\n\n6. Copy and record the webhook callback URL.\n\n7. Log in to [https://developer.vonage.com/en/home](https://developer.vonage.com/en/home).\n\n8. On the left panel, under Build & Manage, select Applications.\\[Omitted image \"Vonage-spoke-dashboard-applications.png\"\\] Alt text: Applications link under Build & Manage.\n\n9. On the Your applications page, select the menu icon \\(\\[Omitted image \"Vonage-spoke-three-dots.png\"\\] Alt text: Menu icon.\\) for your application.\\[Omitted image \"Vonage-spoke-my-applications.png\"\\] Alt text: My application.\n\n10. Select **Edit**.\n\n11. Under the Messages heading, enter the callback URL in the Inbound URL and the Status URL fields.\\[Omitted image \"Vonage-spoke-messages.png\"\\] Alt text: Messages settings.\n\n12. On the left panel, select API Settings.\n\n13. On the Settings page, under SMS Settings heading, make sure that you've selected **SMS API**.\n\n14. Fill the values.\n\n |Field|Value|\n |-----|-----|\n |Delivery receipts \\(DLR\\) webhooks|Webhook callback URL|\n |Inbound SMS webhooks|Webhook callback URL|\n\n15. Select **Save changes**.\n\n SMS settings for the application are saved.\n\n\n## Customize webhooks and routing policies\n\nCustomise the webhook routing policy and subflow as per your requirement.\n\n### Before you begin\n\nRole required: admin\n\n### Procedure\n\n1. Navigate to **All** > **Flow Designer** > **Designer**.\n\n2. Click **Subflows**.\n\n3. Create a copy of the required default subflow.\n\n4. Customize the subflow as per your requirement and publish it.\n\n See [Building subflows](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/build-workflows/subflows.md) for more information about creating and using subflows and [Vonage Spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/vonage-spoke.md) for information about the fields that the default routing policy and subflows support.\n\n5. Navigate to **Vonage Spoke** > **Vonage WebHook Routing Policy**.\n\n6. Click **New**.\n\n7. On the form, fill in the fields.\n\n\n
\n\nField\n\n\n\nDescription\n\n
\n\nLabel\n\n\n\nUnique label to identify the routing policy.\n\n
\n\nDefault answer\n\n\n\nOption to specify if this is the default answer. The default answer is applicable when the conditions are not met.1. Click the lookup icon \\(\\[Omitted image \"lookup-icon.png\"\\] Alt text: Lookup icon\\).\n2. Select the required subflow from the Document list.\n\n**Note:** Ensure that the **Table name** is `Flow [sys_hub_flow]`.\n\n
\n\nCondition\n\n\n\nConditions to be met when the required events occur in Vonage. The supported Vonage fields are:- Keywords\n- Call Direction\n- Call Status\n- Event Type\n- From\n- SMS Status\n- SMS Text\n- To\n- WhatsApp Message Status\n- WhatsApp Text\n- Show Related Fields\n\n\n
\n\nAnswer\n\n\n\nSubflow that must be triggered when the specified conditions are met.\n\n
8. Click **Submit**.\n\n **Note:** These routing policies are saved in the Decision tables. Users are cautioned against directly updating or modifying data in these tables.\n\n\n"}}