Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

REST Webhook can be used as a source in a template. The WSDL (Web Services Description Language) file bundled with Adeptia Connect is generally used to define a SOAP Webhook acting as a source in a template. However, there can be a situation when you may want to use your own WSDL file to create a SOAP Webhook and define the request and response parameters based on your requirement.In Adeptia Connect, you While you have a pre-bundled set of REST providers to be used as a Simple Webhook type, you also have an option to create and use a SOAP Webhook REST provider as an Advanced REST Webhook type in a template according to your need. You can use your own WSDL file to create a SOAP Webhook before or during the creation of a template. If you have already created one using your WSDL file and published it

If you have published a REST Provider as a Template, you will be able to select it from the designated drop-down box (Select Web Service Provider). You can also create a new one by uploading your WSDL file and clicking Image Added and use that as a source even when you are in the middle of creating a template.

Follow the steps below to create and use a SOAP REST Webhook as a source in a template. 

Info

For steps previous to the step 1 being discussed below, refer to Creating a Template.

  1. Select SOAP WebHook REST Webhook as a source application.
    Image Removed
    Image Added

  2. Select the Webhook type as Simple or Advanced.
    Image Removed
    Image Added
    • Simple Webhook type will work as it was working before. 
    • Advance Webhook type allows you to use a predefined Webhook or define a new one by using your own WSDL file.

  3. When Advance configuration is selected:When Simple configuration is selected:
    1. Select Enable SSL check box if you want the REST Provider service to offer a SSL security. 
    2. Select a port in the Select Port field.

      Tip
      If you want to publish the REST Webhook to a custom port instead of the default port, refer to this document.


      Note
      These two fields are available only when you have selected the Simple as a Webhook type.


  4. When Advanced configuration is selected:

    Image Added

    1. Select a pre-defined

      SOAP

      REST Provider in the Select Web Service Provider field.

    2. You can

      also

      also create a new provider

      by

       by clicking 

      Image Removed

      Image Added

      Select the SOAP operation corresponding to the selected provider.

      Info
      The list displays all the available operations corresponding to the selected provider. The operations which have already been used in other templates will be grayed out.
      Click Next
      Note

      When you create a new REST Provider from Template wizard:

      • The field Publish as will not be available and by default, the REST Provider will always be published as a Template
      • By default, the REST provider will be created in a published state.


  5. Click Next.
  6. Select the Apply Security Policy check box.

    Note
    This screen appears only when you have selected Webhook type as Simple.


  7. Select a pre-defined security policy in the Select Security Policy to apply field. You can also create a new security policy by clicking Image Added.
  8. Click Next to proceed to the next step of template creation.

Info

Once the Template is created, you can get the Webhook URL by clicking Copy URL (in case of Simple Webhook type) and Endpoint URL (in case of Advanced Webhook type)under the Action menu on the Templates manage page.

Note
This option is available only when the template is in active state.

The format of the copied URL for an Advanced Webhook type will be as follows:

<selected Scheme in Provider>://<Server>:<Selected Port>/wsapi/apiVersion/resource end path

The table below explains the components of this URL for different cases:

CaseEndpoint
SchemeHostPortContext path
No PortGUI SchemeGUI HostGUI Port/wsapi/resource end path
Non SSL PorthttpGUI HostSelected Port/wsapi/resource end path
SSL PorthttpsGUI HostSelected Port/wsapi/resource end path

The format of the copied URL for a Simple Webhook type will be as follows:

<selected Scheme in Provider>://<Server>:<Selected Port>/rest/triggerprocess/<templateId>

The table below explains the components of this URL for different cases:

Case

Endpoint


SchemeHostPortContext path
No PortGUI SchemeGUI HostGUI Port/rest/triggerprocess/<templateId>
Non SSL PorthttpGUI HostSelected Port/rest/triggerprocess/<templateId>
SSL PorthttpsGUI HostSelected Port/rest/triggerprocess/<templateId>