Integration Webhook

Send integration failure notifications to your internal systems with event-triggered HTTP messages

An integration webhook delivers immediate notifications to your internal systems when an integration enters a Warning or Error state. This enables timely detection and response to issues, helping prevent downstream impact.


Prerequisites

Item
Description

Target System API

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)

This is required only if the system receiving the webhook notifications requires authentication.

Target System Webhook URL

URL of the target system that will receive the webhook


Configure a webhook

Integration webhook setup

Follow these steps to configure an Apono webhook:

  1. On the Webhooks page, click Add Webhook. The Add Webhook page appears.

  2. Click Integration.

  3. Enter a unique, alphanumeric, user-friendly Integration Webhook Name for identifying this webhook.

  4. Click the Status toggle to Active.

  5. From the Type dropdown menu, select HTTP Webhook.

  6. From the Method dropdown menu, select the POST method.

  7. For the URL field, enter the URL of the target system that will receive the webhook.

  1. In the Body Template field, construct a JSON body for the webhook payload. The following is an example webhook payload.

{
  "event_type": "{{event_type}}",
  "event_time": "{{event_time}}",
  "data": {
    "id": "{{data.id}}",
    "name": "{{data.name}}",
    "type": "{{data.type}}",
    "status": "{{data.status}}",
    "issues": [
      {
        "status": "{{data.issues.status}}",
        "message": "{{data.issues.message}}"
      }
    ]
  }
}
  1. (Optional) If applicable, enter the authentication information required by the target system.

Follow this step to add Bearer Token authentication:

  1. Under Headers, use the Key and Value fields to set the access token.

Key
Value

Authorization

Bearer <API_TOKEN>

  1. Under Filters, define one or several filters from the Integration, Type, and Status 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.

Use these filters to scope notifications to specific integrations, integration types, or status changes, such as Error, Warning, or Active.

  1. (Optional) In the Timeout in seconds field, enter the duration in seconds to wait before marking the request as failed.

  2. (Optional) Define Response Validators to verify that the response from the webhook meets specified criteria:

    1. Click + Add. A row of settings appears.

    2. Starting with $.data., enter the Json Path of the JSON parameter.

    3. In the Expected Values field, enter a value and press the Enter key on your keyboard.

    4. Repeat step c to add several expected values.

    5. Repeat steps a-d to add multiple response validators.

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

  1. Click Save Webhook.

The new webhook appears in the Webhooks table. Active webhooks are marked with a green dot. Inactive webhooks are marked with a white dot.

Apono notifications will be sent to your target system when the status of an integration has changed to a warning or error state.

Last updated

Was this helpful?