Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Service Hooks

After deploying to the Conga Advantage Platform a custom code project with business logic to be executed on a data change event, you must set a mechanism to execute the custom code. Service hooks allow you to define data change rules to execute any custom code for a given object. Data change rules are like post-action triggers that can be configured in events like creating, updating, or deleting a record for a given object. This section describes the steps for creating a service hook.

Creating a Service Hook

Custom code is deployed onto Conga Advantage Platform and mapped with Callback.

  1. Log in to the Conga Advantage Platform as an admin user.
  2. Click the App Launcher () icon from the top-left corner and go to Admin Console > Service Hooks.
  3. Click Create Service Hook.
  4. Enter values in the following fields.

    Fields

    Description

    Name

    Enter a name for the service hook.

    Event Types

    Select the event to trigger the service hook on: create, update, or delete.

    Object Name

    Search and select the object name for the event to happen with.

    Condition

    Specify the condition you want the selected object to meet to trigger the service hook.

    Project Name

    Enter the name of the custom code project to execute when a service hook is triggered.

    Class Name

    Enter the name of the class where your desired custom code method is stored.

    Is Active

    Enable this toggle to activate the service hook.

  5. Click Save to exit, or click Save & New to save your entry and create a new one.
The newly created service hook entry is now available on the Service Hooks listing page. You can edit or delete service hooks directly from this page.