Freshworks Developer Docs | Building webhook

Now that you have understood about App Setup Events and External Events, let's get ahead with the app.

Webhook endpoint is generated whenenver the app is installed, so defining onAppInstall and onAppUninstall event along with the onAppInstallHandler and onAppUninstallHandler respectively in the manifest.json.
To generate the webhook in onAppInstallHandler with generateTargetUrl(). And registering the webhook endpoint on Pipedream via request method .
And also when the app is uninstalled, webhook should be deregistered so in onAppUninstallHandler using request method invoke Pipedream API to deregister the webhook endpoint.
Now that webhook is registered, we would have to define onExternalEvents in manifest.json and the onExternalEventsHandler handler in server.js that would be triggered whenever the URL from generateTargetUrl().

Simulation

Now to locally test the app, use fdk run command in your app's directory.

fdk run
Starting local testing server at http://*:10001/    
Append 'dev=true' to your current host URL to start testing    
     
e.g:     
  https://domain.freshdesk.com/a/tickets/1?dev=true

Quit the server with Control-C.

To simulate product, app setup, and external events, visit - http://localhost:10001/web/test

Navigate to http://localhost:10001/web/test, choose the events -

onAppInstall to test the app installation and webhook registration on Pipedream .
onExternalEvent to test the events that would be invoked from the third party as a webhook.
onAppUninstall to test the app's uninstallation event to de-register the webhook on Pipedream .

server.js

requests.json

manifest.json

iparams.json

server/server.js file

onAppInstallHandler: async function (payload) {
    try {
      const webhook = await generateTargetUrl();
      const options = {
        body: `{'webhook': ${webhook}}`,
        action: 'register'
      };
      const { response } = await $request.invokeTemplate("thirdPartyEndpoint", {
        body: JSON.stringify(options)
      });

      console.info('\n Webhook creation successful \n', webhook);
      console.info('\n Webhook Registration Successful \n', response);
      console.info('\n Hander received following payload when app is installed \n\n', payload);

      renderData();
    } catch (error) {
      console.error('Something went wrong. Webhook Registration has failed');
    }
  },
  onAppUninstallHandler: async function (payload) {
    try {
      const options = {
        action: 'de-register'
      };
      const { response } = await $request.invokeTemplate("thirdPartyEndpoint", {
        body: JSON.stringify(options)
      });
      console.info('\n Webhook De-Registration Successful \n', response);
      console.info('\n Hander received following payload when app is uninstalled \n\n', payload);
    } catch (error) {
      console.error('Something went wrong. Webhook De-Registration has failed', error);
    }
    renderData();
  },
  onExternalEventHandler: function (payload) {
    const { data } = payload;
    console.info('\n Desired action occurred within 3rd party');
    console.info(' onExternalEventHandler invoked with following data: \n', data);
  }

Tutorials

Sample apps

Guides

Blogs

Assist catalog

Events

Building webhook

Simulation