Custom Webhooks

Send Apono access request data to your internal systems with event-triggered HTTP messages

Suggest Edits

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.


Create the webhook

Follow these steps to configure an Apono webhook:

  1. On the Webhooks page, click Add Webhook. The Add Webhook page appears.
  2. Enter a unique, alphanumeric, user-friendly Name for identifying this webhook.
  3. Click the Status toggle to Active.
  4. From the Method dropdown menu, select a REST method. Apono supports POST, PUT, and DELETE.
  5. 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

  1. 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.


  1. Under Headers, use the following Key and Value to set the headers required by the target system, such as an authorization header.
  2. 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
  3. Under Filters, define one or several filter from the listed dropdown menus.
  4. 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.


  1. 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.

Updated about 2 months ago

What’s Next