- 31 Jan 2025
- 2 Minutes to read
- Print
- DarkLight
- PDF
External API Request
- Updated on 31 Jan 2025
- 2 Minutes to read
- Print
- DarkLight
- PDF
Clarity allows you to attach customizable api requests to any workflow. This allows you to integrate Clarity into any external application, such as your SIEM, ticketing system, or collaboration tools. For instance, you could attach this action to the Identity Modified workflow to send a message to your company Slack channel any time an identity is modified.
Configuring the Action
Like any other workflow action in Clarity, start by choosing the workflow you would like to attach this action to.
For more info on workflows, triggers, and actions check out these articles
After selecting your workflow, navigate to Add Step to Workflow and click Add Action
Then select the "Send Configurable API Request" action.
To configure the API request, fill out the form as necessary.
API endpoint: Fill in the url of where you would like the request to go. For instance, to send a request to ServiceNow you might use a url like "https://yourInstance.service-now.com/api/snc/identity-modified".
API method: Choose the appropriate HTTP method for your endpoint. In the ServiceNow example that might be a POST request.
Secret: Fill in any token or key that may be necessary. This is not a required field, but depending on what API you are sending the data to, it may be necessary. This secret will be included as the bearer token of the request.
Body: Please refer to the API documentation of the desired service to know how to format the body and what fields you'd like to use.
Available Context Parameters
Each API request action has certain parameters available to it, depending on which workflow trigger it is attached to. For instance, if you are attaching the action to the Identity Modified trigger, Clarity will provide you with the following context parameters:
identity_id, auto_or_manual, action_initiating_trigger, internal_or_external, attribute_changes, creator_id, notification_id
Example
In our example below, any time an Identity in Clarity is modified, we would send a POST request to a ServiceNow endpoint using a bearer token for authentication. The request body would be formatted JSON, and would include context around the Identity that was modified, as well as the initiating action and whatever attributes were changed. Your request body can reference any of these parameters available in the Available Context, using [[double bracket syntax]].
Once you have configured the action appropriately, click Save Action Step and be sure to Save the workflow as well after making any other desired changes.
Need help?
If you have any problems, contact your customer success team. You can also get in touch with our general support via email, open a support ticket. Our general support team is available Monday - Friday from 8:00 AM - 6:30 PM CST.