Webhook management

    Webhooks enable the product to send real-time data to external applications when specific events occur, allowing seamless integration with third-party systems. With webhook management, you can create reusable webhook templates that define REST API endpoints, authorization, headers, parameters, HTTP methods, and message payloads. These templates can then be added as blocks to your orchestration templates to automate cross-platform workflows.

    The webhook history feature provides visibility into all webhook executions, helping you track activity, identify anomalies, and troubleshoot issues across your automated processes.

    How webhooks work

    When an orchestration template containing a webhook block is triggered, the product executes the webhook by sending an HTTP request to the configured REST API endpoint of the external application. The request carries the defined headers, parameters, and message payload, with macros dynamically replaced by real-time values from Active Directory, Microsoft 365, environment variables, action details, or third-party applications.

    The external application processes the request based on the chosen HTTP method (GET, PUT, POST, DELETE, or PATCH) and returns a response. The product logs every webhook execution in the webhook history, capturing details such as the associated webhook template, module used, object name, and timestamp.

    Prerequisites

    • Administrator privileges or a delegated role with permissions to manage orchestration templates and webhooks.
    • The target application must be integrated with ADManager Plus as a custom application under directory application settings, if its API requires authorization. custom application
    • A valid REST API endpoint URL from the target third-party application, along with any required authentication credentials, headers, and parameters.
    • The product server must have network connectivity to the target API endpoint.

    Note: Macros referencing Microsoft 365 attributes require an active Microsoft 365 tenant configuration in the product.

    Steps to create a new webhook template

    1. Navigate to Automation > Configuration > Orchestration Template.
    2. On the top-right corner of the page, click Configure Webhook.
    3. To configure a new webhook, click + New Webhook Template.
    4. Enter a name for the webhook template by clicking the edit icon.
    5. In the URL field, enter the API endpoint. Refer to the macros below to use dynamic values. Also select one of the following HTTP methods:
      • GET: To read data
      • PUT: To update or replace data
      • POST: To create data
      • PATCH: To partially update data
      • DELETE: To delete data
    6. In the Authorization field, select the custom application. The custom application must already be set up under directory application settings before it can be selected here. If the endpoint does not require authorization, leave this empty.
    7. In the Headers field, add the required API headers and map them to suitable header values.
    8. In the Parameters field, add the required API parameters and map them to their values.
    9. Choose the required message type option and configure the message payload.
    10. Click Save as Draft to save the template, or click Test and Save to verify the webhook implementation in real time for specific users and groups before saving.

    To modify a webhook: On the Webhook Template page, locate the template you want to modify and click the Edit icon under the Actions column. Update the required fields and click Save, or click Test and Save to verify the updated configuration before saving.

    Note: Modifications to a webhook template will be reflected in all orchestration templates that use it. Review the impact on dependent orchestration workflows before saving changes.

    To delete a webhook: On the Webhook Template page, locate the template you want to remove, click the Delete icon under the Actions column, and confirm the deletion in the prompt that appears.

    Note: A webhook template that is currently associated with one or more orchestration templates cannot be deleted until it is removed from those templates.

    To view webhook history: On the Webhook Template page, click Webhook History in the top-right corner. The Webhook History page displays webhook execution records with the following columns:

    • Date & Time: The timestamp of the webhook execution.
    • Webhook Template Name: The name of the webhook template that was executed.
    • Module Used: The product module that triggered the webhook (for example, Test Connection).
    • Object Name: The name of the AD object associated with the execution.
    • Object Category: The category of the object (for example, Users).

    Use the Period filter in the top-right corner to narrow down the history. Available options include Today, Yesterday, Last 7 days, Last 30 days (default), This Month, Last Month, and Custom Range.

    Macros

    Macros allow you to retrieve object-based data dynamically. Type % in any supported field (URL, Headers, Parameters, Message) to search for an attribute, or click the macro icon to browse and select one.

    Source Format Example
    Active Directory (including custom LDAP attributes) %ad.attribute_name% %ad.SamAccountName%
    Microsoft 365 %m365.attribute_name% %m365.UserPrincipalName%
    Environment variables %env.attribute_name% %env.ticketingtoolAuthToken%
    Action details %act.attribute_name% %act.timestamp_dd-MM-yy_current time%
    Third-party applications %tp.attribute_name% %tp.SamAccountName%

    To represent the % symbol literally in a value field, enter %%.

    For more information on macros, refer to the macros help page.

    Tips

    • Store reusable or sensitive values, such as API tokens, as environment variables instead of hard-coding them in webhook fields.