Creating a REST API Hook

  1. In the Hooks Inventory :: Add window, under Hooks Type, select the REST option.
  2. Enter a description for the selected hook.
  3. Under API Details, enter or select the field information.
    • Using REST API

    • Using Internal API

    The following table describes field description in this section:
    Field Description
    API name Enter a valid name for the API.
    Select type You can select between REST API and Internal.
    • REST API: Use this to select external API and enter the URL.
    • Internal: Use this to select an internal API and select a URI (Uniform Resources Identifier) from the dropdown menu.
    Path params Parameters that are used to identify a specific resource(s).
    Query params Parameters that are used to filter resources.
    All asterisk (*) marked fields are mandatory.
  4. Under Request Body, enter the payload and response mapping details.
    The following table describes field description in this section:
    Field Description
    Payload Payload is the actual data that needs to be passed for the API.
    Response mapping Mapping an integration response from the backend.
  5. To add this new REST API hook to the hook inventory, click Save.