Send Apono access request data to your internal systems with event-triggered HTTP messages
If you cannot find a guide for your specific tool, you can create a custom Apono outbound webhook.
This guide shows you how to create and test a custom webhook.
| Item | Description |
|---|---|
Follow these steps to configure a webhook:
On the Webhooks page, click Add Webhook. The Add Webhook page appears.
Enter a unique, alphanumeric, user-friendly Name for identifying this webhook.
Click the Status toggle to Active.
From the Method dropdown menu, select a REST method. Apono supports POST, PUT, and DELETE.
In the URL field, enter the URL of the target system that will receive the webhook.
The webhook URL must adhere to the following requirements:
Uses the HTTPS protocol
Does not specify any custom ports
In the Body Template field, construct a JSON body for the webhook payload.
Click View event's payload schema to reveal the payload schema and available data fields. You can also refer to the Webhook Payload Schema Reference to read the descriptions of each data field.
Enter the authentication information required by the target system.
Follow this step to add Bearer Token authentication:
Under Headers, use the Key and Value fields to set the access token.
Follow these steps to add OAuth authentication:
From the Authentication Type dropdown menu, select OAuth. The OAuth settings appear.
Define the OAuth settings.
Follow these steps to add custom authentication:
Under Headers, use the Key and Value fields to set the credential information.
If your tool or service has several values, enter each key-value pair in a separate row.
The following example uses Datadog as an example.
From the Triggers dropdown menu, select one or more of the following event triggers, which correspond to Apono access request statuses:
RequestCreated
RequestApproved
RequestRejected
RequestGranted
RequestExpired
RequestFailed
Manual
Under Filters, define one or several filters from the listed dropdown menus.
Filters empower admins to control the data transmitted via webhooks, minimizing the amount of data third-party tools receive and reducing unnecessary clutter.
Examples:
Send only production requests to your admins' Slack channel.
Trigger Okta workflows for events from specific integrations or resource types.
Open a ticket in Jira or ServiceNow for manually approved requests.
Click Test to generate a test event to trigger your webhook. A Test successful or Test failed response status will appear at the bottom of the page. A successful test will send mock data to the target system.
For more information about the test, click View Invocation Data. A panel opens revealing the request, response, and other relevant details.
Should your test fail, view these tips to troubleshoot your webhook.
Click Save Webhook.
The new webhook appears in the Webhooks table. Active webhooks are preceded by a green dot. Inactive webhooks are preceded by a white dot.
Apono access request logs will be sent to the target system based on the triggers you have selected.
| Key | Value |
|---|---|
| Setting | Description |
|---|---|
| Key | Value |
|---|---|
Target System API Credentials
Authentication information used when making requests to the target system
Apono supports the following authentication:
Bearer Token
OAuth
Custom (key-value pairs passed in the header)
Target System Webhook URL
URL of the target system that will receive the webhook
Example: https://<SUBDOMAIN>.freshdesk.com/api/v2/tickets
Authorization
Bearer <API_TOKEN>
Client ID
Unique identifier assigned by the authorization server
Client Secret
Secret key issued by the authorization server
Token Endpoint URL
URL where the authorization code or refresh token is exchanged for an access token
Scopes
(Optional) Set of permissions requested to access specific resources or APIs
DD-API-KEY
<API KEY>
DD-APPLICATION-KEY
<KEY ID>