<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><style>
p {
margin: 0;
}
span.fr-emoticon.fr-emoticon-img {
background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle;
}
span.fr-emoticon {
font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0;
}
blockquote {
border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px;
}
blockquote blockquote {
border-color: #00bcd4; color: #00bcd4;
}
blockquote blockquote blockquote {
border-color: #43a047; color: #43a047;
}
table.grid {
border-collapse: collapse;
}
table.grid td,
table.grid th {
border: 1px solid #ddd;
}
.fr-fic.fr-dib {
display: block; margin: 5px auto;
}
.fr-fic.fr-dib.fr-fir {
text-align: right; margin: 5px 0 5px auto;
}
.fr-fic.fr-dib.fr-fil {
text-align: left; margin: 5px auto 5px 0;
}
</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Cisco Meraki Integration?</strong></p><p><strong>- Connecting to Cisco Meraki</strong></p><p><strong>- Importing Customers</strong></p><p><strong>- Importing Assets</strong></p><p><strong>- Alerting</strong></p><p><br></p><p><br></p><p><strong><span style="font-size: 14pt;">What is the Cisco Meraki Integration?</span></strong></p><p>The Cisco Meraki integration allows you to import customers and assets from Cisco Meraki into Halo. Alerting can also be configured using webhooks, allowing you to have any alerts triggered by events in Cisco Meraki log a ticket in your Halo instance. </p><p><br></p><p><strong><span style="font-size: 14pt;">Connecting to Cisco Meraki</span></strong></p><p>First you will need to enable the integration by heading to configuration > integrations. Use the '+' symbol to enable the integration. </p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjlmMTczOTg1LTVjOWUtNDIxZS04M2MzLWY3NzA3MjkxZjMwNiJ9.9XF8K7CQ-Ve1d9y1qlGUyvrU0b8ltzn6RQlMOqyPuO4" class="fr-fic fr-fil fr-dib" width="274" height="136"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enable Cisco Meraki integration</span></strong></p><p><br></p><p>Once enabled click into the integration module to begin configuration. </p><p><br></p><p>To connect to the integration you will need to enter your Meraki URL and API key. To obtain an API key head to your 'My profile' page in Cisco Meraki (accessed via the avatar icon in the top RHS corner of dashboard). Here you can generate an API key. Ensure you copy your key once generating as you will not be able to retrieve it later. The key will inherit the permissions of the account you generate the key from, so ensure you are generating the key using an administrator account. Once you have the key paste it into the relevant fields in Halo. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjE0MGEyNWU4LWM0NGQtNDA3Ny04NGE0LTkwNTYyMWE2MjViOSJ9.ErYv8dqHj4ghItCh1mCSPj_8Lx_VNIR1ZR9X-7P6mRs" class="fr-fic fr-fil fr-dib" width="898" height="412"></p><p><strong><span style="font-size: 10pt;">Fig 2. Meraki URL and API key fields</span></strong></p><p><br></p><p>Now you are connected you can begin importing assets and customers.</p><p><br></p><p><strong><span style="font-size: 14pt;">Importing Customers</span></strong></p><p>Head to the 'Organisations' tab under the integration configuration. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQ0ZDQ2ZDliLTg5YTktNDJlNC05N2FkLWY2Mzk1MGFiNmQwYiJ9.71woD2ae44YL5r0BmYwxIhfQaOk66D-tnJVOPsJYC0o" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 534.237px;" height="534"></p><p><strong><span style="font-size: 10pt;">Fig 3. Organisations tab</span></strong></p><p><br></p><p>Here you will need to configure mappings to map a Cisco Meraki organisation to a Halo customer, this will ensure data from this organisation in Cisco Meraki will be imported into the mapped Halo customer. </p><p><br></p><p>Mappings can be automatically generated using the 'Generate Mappings' button if your Halo customer and Cisco Meraki organisation has the exact same name. If a Cisco Meraki organisation is imported without a mapping a new customer will be created for this organisation in Halo. </p><p><br></p><p>The field 'Top Level for New Customers' can be used to assign a top level to any customers that are created from the integration.</p><p><br></p><p>Once you have added all the mappings you require hit the 'Import Organisations' button to bring up the import preview screen, then hit 'start' to begin the import. </p><p><br></p><p><strong><span style="font-size: 14pt;">Importing Assets</span></strong></p><p>Head to the 'Assets' tab to begin the asset import configuration. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZjM2RjYWZlLWQ3MDgtNGIyMi1iMzdiLTZhNTBkNDVjZjBiYyJ9.n8S4ordOamN0yImvrfxTJfkfDVoz7RhVbtjh7evPILE" class="fr-fic fr-fil fr-dib" width="1212" style="width: 1214px; height: 597.676px;" height="598"></p><p><strong><span style="font-size: 10pt;">Fig 4. Asset tab</span></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Asset Field Mappings</span></strong></p><p id="isPasted">Mappings can be configured to ensure data from Cisco Meraki fields are imported into a chosen Halo field. Create a mapping by adding to the 'Field mappings' table.</p><p><br></p><p><strong>Field Type</strong> - This will be the type of Halo field the data will be imported into. See our guide on <a data-fr-linked="true" href="https://usehalo.com/haloitsm/guides/1785/" id="isPasted" target="_blank" rel="noopener noreferrer"><strong>Asset Fields</strong></a> if you are unsure on the difference between asset fields and custom fields in Halo. </p><p><br></p><p>Now choose the Cisco Meraki and Halo field you would like to map together. If you would like data from the Cisco Meraki field to create a new field in Halo select '*Create new field during the next import*' under 'HaloPSA Field'. </p><p><br></p><p><strong>Only apply this mapping to new Assets and Assets where the Asset field does not currently have a value</strong> - When this is enabled if the Halo field already has data within it, different to the data in the mapped Cisco Meraki field, the field data will not change. Fields will only be populated when they contain no data or when new assets are being created. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYzZDkyMDhhLTZlNDQtNDljYy05MjI4LWMzMzVhZjYwYzdlMyJ9.JJmYMTbHFBs13gOv8GAVkT0NqqIeV8CTrTuS7urHSq0" class="fr-fic fr-fil fr-dib" width="495" style="width: 497px; height: 360.97px;" height="361"></p><p><strong><span style="font-size: 10pt;">Fig 5. Field mapping example</span></strong></p><p><br></p><p>In the figure 5 example data from the 'serial' field in Meraki will be imported into the 'Serial number' field in Halo. </p><p><br></p><p><strong><em>Note: Ensure the field selected as the 'Asset Matching field' is mapped.</em></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Determine an Asset's type</span></strong></p><p>When assets are imported from Cisco Meraki a new asset in Halo will be created, as Cisco Meraki does not have a concept of 'asset types' like Halo we will need to configure how the type of new assets created from Cisco Meraki are determined. This is done using the 'Determining an Asset's type' field. </p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjQxOWNjZTBkLTFiM2QtNDM5Mi04MjcwLWRkMjYzMjdhNzc2MiJ9.M46_OZ2BkagHPaqtj-dF_-Di_V0fpy6aseBNVQAgNdM" class="fr-fic fr-fil fr-dib" width="323" height="132"></p><p><strong><span style="font-size: 10pt;">Fig 6. 'Determining an Asset's type' field</span></strong></p><p><br></p><p><strong>Use the same type for all Assets<br></strong></p><p>If you would like all imported assets to have the same asset type when imported set the 'Determining an Asset's type' field to be 'use the same type for all Assets' then set the 'Default Asset Type' field to be the asset type you would like assets from Cisco Meraki to be.</p><p><br></p><p><strong>Use a field to determine each Asset's type</strong></p><p>If you would like all imported assets' types to be determined by a particular field, set the set the 'Determining an Asset's type' field to be 'Use a field to determine each Asset's type'. Then in 'Field for determining an Asset's type' choose the field you would like the type to depend on. The field you choose must contain the name of the desired asset type, if this name can be matched to an existing asset type in Halo, it will be assigned this asset type. If the name is not the same as an asset type in Halo, a new asset type will be created. Note that the names must be identical in order to match. This setting is used if you have a field in Cisco Meraki that already determines an asset's type and you would like the types to be consistent between Halo and Cisco Meraki. You will still need to populate the default asset type and group fields as assets that do not have the selected field populated will be imported as the default asset type. </p><p><br></p><p>In the figure 7 example new assets will be assigned to an asset type in Halo based on their 'productType' field. If the data in the productType field matches the name of an asset type in Halo this asset will be created under the matched asset type. If a match cannot be made a new asset type will be created, under the asset group 'Network Equipment'. If the asset does not have the 'productType' field populated the asset will be created under the default asset type, 'Workstation'. </p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjdkYWI0OWQ3LThhMWQtNGQwZi05OTE4LTA0MzU3NWVlZDJkYyJ9.V9JQqiZSijB6fBUJXgS2POWlPVoj0K3OcOj8A_5DFCU" class="fr-fic fr-fil fr-dib" width="1046" height="203"></p><p><strong><span style="font-size: 10pt;">Fig 7. Using field to determine asset's type example</span></strong></p><p><br></p><p><strong>Determine Asset type using rules<br></strong></p><p id="isPasted">If you would like asset types to be determined by asset rules set the set the 'Determining an Asset's type' field to be 'Determine asset type using rules'. Now you will be able to set asset's types based on rules, These rules are based on field values, and if matched will assign an asset to the chosen asset type. When creating a rule first add criteria for the rule, select the Halo field that you would like to base the criteria on, then set the rule type and the outcome needed in the field to match the rule. If an asset matches this rule it will be imported as this asset type.</p><p><br></p><p id="isPasted">If an asset is imported that does not match any of these rules, it will be created under the default asset type. Alternatively, if you would like to not import assets that do not match these rules, set the 'Default Asset type' to 'Don't import assets that do not match any rules'.</p><p><br></p><p><strong><span style="font-size: 12pt;">Asset Matching field</span></strong></p><p id="isPasted">Use the 'Asset Matching Field' field to set an asset matching field, this is the asset field in Halo that will be matched on during the import. If the field value in Halo matches the value of the mapped Cisco Meraki field, an existing asset will be updated, if no match can be made a new asset will be created.</p><p><br></p><p><strong><span style="font-size: 12pt;">Asset Sites</span></strong></p><p>When assets are imported from Cisco Meraki they will be imported to the main site of the customer they are assigned to. If you would like certain assets to stored under a different site the assets will need to be moved to the desired site in Halo after the import has taken place. Then you can enable the setting 'Do not update an Asset's Site if the Asset already exists' on the integration configuration page. This setting will then ensure the assets are updated when a sync/import takes place but the asset's site will not change. </p><p><br></p><p><strong><span style="font-size: 12pt;">Import Assets</span></strong></p><p>Once your asset configuration is complete use the 'Import Devices' button to pull up the import preview screen. You can then start the import. Assets can either be imported manually using this button, or they can be imported/updated on a scheduled basis using the Halo integrator (see the 'Importing on a schedule' section of this guide). </p><p><br></p><p><strong><span style="font-size: 14pt;">Import Organisations and Assets on a schedule</span></strong></p><p>Head to the 'Halo Integrator' tab within the integration setup page. Here you can enable the Halo integrator for each Organisations and Assets to have these entities import/update automatically on a schedule. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjAxZWQ3ZjRlLTAxODUtNDRkMC1hY2Q0LTUzMmUxNjAzZjFiYSJ9.oRVJWhknmbpXQVvP4DY4VO8YB8kurjdJF4GZT4rb28w" class="fr-fic fr-fil fr-dib" width="927" height="380"></p><p><strong><span style="font-size: 10pt;">Fig 8. Halo integrator for integration</span></strong></p><p><br></p><p>Check 'Enable the Halo Integrator for the Meraki integration' and add 'Organisations' and/or 'Devices' into the 'Entities to sync' field, to enable the sync. Once enabled organisations and assets will be imported/updated on a daily basis. </p><p><br></p><p><strong><span style="font-size: 14pt;">Alerting</span></strong></p><p id="isPasted">Navigate to the 'Alerting' tab and make sure all three defaults are set (asset matching field, ticket type and default user) else the integration will error. These defaults will determine the defaults used for tickets logged from Cisco Meraki alerts. </p><p><br></p><p>You can choose how webhooks from Cisco Meraki are processed, either the default method, or using the <a data-fr-linked="true" href="https://usehalo.com/haloitsm/guides/2305" id="isPasted" target="_blank" rel="noopener noreferrer">Event Management</a> module. This is done using the 'Webhook Processing Type' field. When using the event management module you can create rules to determine which events log tickets and control the fields/configuration on the ticket that gets logged for a specific event. Using the event management module to process webhooks also provides you with additional authentication options for the webhooks, allowing for increased security. This gives you more control over the alert/ management tickets that are created. For more information on <a data-fr-linked="true" href="https://usehalo.com/haloitsm/guides/2305" id="isPasted" target="_blank" rel="noopener noreferrer">Event Management</a> check out our dedicated guide. </p><ul><li>Processing using Event Management: Gives more control over how alerts/webhooks are processed into tickets and provides more authentication options for the webhook.</li><li>Processing using the default method: Provides less options around how alerts are logged but uses a quicker/more straightforward setup.</li></ul><p><br></p><p><strong><em>Note: When using event management to process webhooks the webhook is setup in the same way as when using the default method, including posting the webhook to the same URL. However, you will need to set the webhook up in line with your chosen authentication method. </em></strong></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU2ZWRlMzVhLTBkNzEtNGE1MC04MmZkLWEzMTVlMzM5ZmIwNSJ9.2vhfeJROl9HwIHSaXtkiCWi87RfG1jel_75gUZxAMLQ" class="fr-fic fr-fil fr-dib" width="1426" style="width: 1428px; height: 465.422px;" height="465"></p><p><strong><span style="font-size: 10pt;">Fig 9. Alerting tab</span></strong></p><p><br></p><p>Next Copy the URL from the integration page in Halo and use the 'generate' button to generate and copy the shared secret, do not lose the secret as you will have to regenerate a new one if it's lost.</p><p><br></p><p>Now head into Cisco Meraki and navigate to Network-wide > Alerts in Meraki and scroll to the very bottom or until you find the "Webhooks" section:</p><p><br></p><p><img src="http://halo.haloservicedesk.com/api/attachment/image/7c6b4790-36cd-4a7d-97b5-7cfc94ed3b07" width="575" height="258" class="fr-fic fr-dii"></p><p><strong><span style="font-size: 10pt;">Fig 10. Alerts in Cisco Meraki</span></strong></p><p><br></p><p>Add a new webhook with an appropriate name, enter the URL and secret from earlier, you can also choose a template to use for the webhook, the Meraki template will pull through standard information. Now save. </p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM1NTUzYTRiLTFhZTktNGU5Ni04MjQyLTdlYWYwOGZlMDBkMyJ9.2_-EJRYgW8oX34MOPz-8L8tfV_fNjTpfy8XGRaDGoQw" class="fr-fic fr-fil fr-dib" width="1191" height="349"></p><p><strong><span style="font-size: 10pt;">Fig 11. Webhook creation in Meraki</span></strong></p><p><span style="font-size: 11pt;"><br></span></p><p><span style="font-size: 11pt;">If you are using the Event Management module to process webhooks you will now need to head to the Event Management module in Halo (configuration > event management) and configure event rules in order for the webhook to be processed. For information on how to do this checkout </span><a data-fr-linked="true" href="https://usehalo.com/haloitsm/guides/2305" id="isPasted" target="_blank" rel="noopener noreferrer"><span style="font-size: 11pt;">Event Management.</span></a></p><p><br></p><p>When a webhook is triggered a ticket will be created in your Halo instance containing the alert type id, network name, organisation name, alert data, device serial, device name and network tags.</p><p><br></p><p>If the alert has come from a device in Cisco Meraki this will match onto the asset in Halo. If the alert is not associated with a device this will match on the Organisation/customer name, so the ticket will be assigned to the customer it is associated to (overriding the default end user).</p><p><br></p><p>Try sending a test webhook, this should generate a new ticket in Halo, if it does this your Meraki is now setup correctly going forward.</p>
