Versions Compared

Version Old Version 1 New Version Current
Changes made by

PIPEFORCE

PIPEFORCE

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • PIPEFORCE Enterprise 7.0 or higher.

  • You have a valid PIPEFORCE Developer account.

  • You have executed tutorial Tutorial: Create a new app.

Introduction

Webhooks are an essential part for connecting with external systems. A webhook is a unique URL external systems can call. In PIPEFORCE when a webhook URL is called, it is linked to a pipeline internally which gets executed then.

...

Note

Since a webhook could potentially trigger any kind of logic, double check who can create webhooks, what exactly webhooks are doing and which external systems can call it!

Tip: You can restrict who can create and manage webhooks by removing the roles CAN_PIPE_webhook_* from the developers and groups not allowed to do so. By default any developer can create and manage webhooks.

1 - Create the webhook pipeline

In this step we gonna create the pipeline which will be executed whenever the webhook is called from external. To do so, follow these steps:

...

Info

Note: You can define as webhook event key any string you want. As best practise we suggest you to use always lower case letters and prefix the key with webhook.. Furthermore use the period . as separator, for example webhook.sendmail, webhook.order.create and so on.

2- Create the webhook

Now you will link the external caller with your pipeline by creating a webhook object. To do so, follow these steps:

  1. Navigate to LOW CODE → Commands.

  2. Search for webhook.put here and click it.

  3. In the form set the field key to webhook.tutorial and click submit. The result should look similar to this screenshot:

  4. Now a new webhook was created and linked using the event key webhook.tutorial. Every pipeline which listens to this event key will be executed when the webhook is called.

  5. Copy the webhook url for the next step.

3 - Execute the webhook

  1. Copy the webhook url from the result of the previous step.

  2. Open your browser, paste this url and open it.

  3. You should see a blank page without any error message.

  4. After a few seconds you should receive an email to your inbox.

  5. The webhook url is the url you can register in external systems to call your pipeline from external. Since this url calls your system, make sure that only you and the external system knows it.

...