Zapier
On this page
The Zapier integration is a Zapier app that works with the Alloy Navigator REST API. Alloy Navigator itself ships nothing for this integration: no workflow parameters, workflow items, or scheduled tasks.
Prerequisites
- A Zapier account.
- An Alloy Navigator API instance, installed and using access-token authentication. See Install the API and Authentication. The API is not a separate item of the Alloy Navigator license.
- Your Alloy Navigator API endpoint URL. The Admin Center shows it in the URL field on the API instance's General tab; the Web Configuration tool shows it on the URL: line in the Web category of the instance's page. See API Settings and API Overview. Use an HTTPS address: a call that reads data, runs a workflow action, or handles attachments is refused over plain HTTP.
- The user name and password of an Alloy Navigator account that has permissions for the actions
your zap performs. We recommend a dedicated technician account with Standard or Windows
authentication. An account with Windows authentication signs in with a user name in the form
DOMAIN\name, which is checked against the directory of that domain's Domain Credentials record. See Authentication. A Self Service Portal customer account cannot be used. - Password authentication allowed for the API instance: the Allow password authentication check box under Password Authentication on the instance's Authentication tab in the Admin Center, saved with Save and Restart. See API Settings. For an account that signs in with its Alloy Navigator password, the account's own Allow password authentication check box must also be selected. See Create and Maintain Technician Accounts.
The zap works as that technician. The technician's role permissions decide which records the zap can see, and the workflow decides which actions it can run: the API creates and changes records only by running workflow actions.
In Zapier
In Zapier, a zap links a trigger event in one app to an action in another app. A single zap can chain several actions in different apps.
The Zapier app offers six triggers and five actions over Incidents, Change Requests, and Persons.
Create a zap
You build a zap in Zapier's Zap editor: you set up the trigger, add one or more actions, test each step, and publish the zap. For the editor itself, see Zapier's What is a Zap?.
- Sign in to Zapier and create a zap.
- Set up the trigger: select the app and the trigger event. To start the zap from Alloy Navigator, select the Alloy Navigator app and one of its triggers.
- When Zapier asks you to connect Alloy Navigator, enter your Alloy Navigator API endpoint URL, and the user name and password of the account described under Prerequisites. Zapier keeps this connection, and you can select it again in later steps and other zaps.
- Test the trigger. Zapier looks for a matching record; if Alloy Navigator has none yet, create one in the Web App and test again. The fields of the record Zapier finds are then available to the later steps.
- Add an action: select the app and the action event, sign in to that app when Zapier asks, and fill in the action's fields. You can insert fields of the trigger record into them.
- Test the action.
- Give the zap a distinctive name and publish it. Zapier processes only data created after the zap is published.
Example zaps
The following zaps combine the Alloy Navigator triggers and actions with other apps. Build each one as described under Create a zap. The other app's triggers, actions, and sign-in belong to Zapier and that app; each example links the Zapier page that lists that app's triggers and actions beside those of Alloy Navigator.
Post a Slack message when an Incident is created
You need a Slack workspace and a Slack account that can post to the channel. See Alloy Navigator + Slack.
- Set up the trigger: Alloy Navigator, New Incident. Test it with an Incident created in the Web App.
- Add the action: Slack, Send Channel Message. When Zapier asks for a Slack account, sign in to your Slack workspace.
- Select the channel and write the message text. Insert the Incident's fields, such as its ID and summary, from the trigger.
- Test the action, name the zap, and publish it.
Zapier then posts a message to the channel for each new Incident.
Create an Incident when an Amazon CloudWatch alarm changes state
Zapier connects to Amazon CloudWatch with an AWS access key ID and secret access key. AWS recommends a key restricted to the resources you want to use: create a new AWS user for the integration, give it access only to those resources, and create an access key for it. The IAM console shows the access key ID and the secret access key on the page where you create the key, and the secret access key cannot be viewed again later: copy both values from that page. See AWS's How an IAM administrator can manage IAM user access keys and Alloy Navigator + Amazon CloudWatch.
- Set up the trigger: Amazon CloudWatch, Alarm State Change. When Zapier asks for an account, enter the access key ID and the secret access key you copied for the integration user.
- Select your region and the alarm to monitor, and test the trigger.
- Add the action: Alloy Navigator, Create Incident. Select your Alloy Navigator connection, or connect as described under Create a zap.
- Fill in the fields of the new Incident. The zap creates each Incident from these values.
- Test the action, name the zap, and publish it.
Zapier then creates an Incident when the state of the alarm changes.
Create a Trello card when a Change Request is approved
You need a Trello account with access to the board. See Alloy Navigator + Trello.
- Set up the trigger: Alloy Navigator, Change Request status change. In the trigger's Status field, select the status that starts the zap, in this example Approved, and test the trigger.
- Add the action: Trello, Create Card. When Zapier asks for a Trello account, sign in to Trello.
- Select the board and the list. Fill in the card's name and other properties, and insert the Change Request's fields from the trigger.
- Test the action, name the zap, and publish it.
Zapier then creates a Trello card for each approved Change Request.
Create an Incident from a Microsoft Teams channel message
The Microsoft Teams trigger requires the Zapier app, installed from the Teams Store, and signing in to Teams from Zapier may need approval from your Teams administrator. See Alloy Navigator + Microsoft Teams. To post a card about new Incidents into a Teams channel without Zapier, see Microsoft Teams: Incoming Webhook.
- Set up the trigger: Microsoft Teams, New Channel Message. When Zapier asks, sign in to your Teams account.
- Select the team and the channel.
- Test the trigger: post a test message to the channel. Zapier shows the message's fields, such as the sender's display name, the subject, and the message body.
- Add the action: Alloy Navigator, Create Incident. Select your Alloy Navigator connection, or connect as described under Create a zap.
- Map the message fields to the fields of the new Incident.
- Test the action: a new Incident appears in Alloy Navigator. Name the zap and publish it.
Zapier then creates an Incident for each new message in the channel.
Triggers
The Alloy Navigator API offers no webhooks or subscriptions that Zapier could register, so the triggers do not fire at the moment of a change. A trigger picks up new records, activities, and status changes when Zapier checks the API.
| Trigger | Event |
|---|---|
| New Incident | An Incident is created. |
| New Incident activity | A new activity is added to any Incident. |
| Incident status change | The status of an Incident is changed. |
| New Change Request | A Change Request is created. |
| New Change Request activity | A new activity is added to any Change Request. |
| Change Request status change | The status of a Change Request is changed. |
Actions
An action either creates something in Alloy Navigator or searches for something there.
| Action | What the action does |
|---|---|
| Create Incident | Creates a new Incident in Alloy Navigator. |
| Lookup Incident | Retrieves an Incident record by its ID or OID. |
| Lookup Change Request | Retrieves a Change Request record by its ID or OID. |
| Search Person | Searches for a Person by primary e-mail address. |
| Lookup Person | Retrieves a Person record by its ID or OID. |