Skip to main content

Using Webhooks to Launch Wrkflows

Overview​

Webhooks allow you to automatically trigger a Wrkflow launch based on an event in a third-party system, allowing you to fully automate your business processes.

In order to use Webhooks, the only thing you need is a Webhook URL for a Wrkflow that can be configured in your system with an event. When it happens it will trigger the Wrkflow launch and send the data, which will be processed by your Wrkflow to generate the desired results.

For example: You can configure a Webhook URL in your system which should trigger the “Lead Enrichment” Wrkflow as soon as an entry has been made in your Hubspot account. Once triggered, your Wrkflow can take the information sent from Hubspot about the contact, search the missing information, and update the entry in Hubspot with all the necessary information, amplifying your lead intelligence.

Accessing Webhook URL in Platform​

By default, each Wrkflow in the account (either custom or downloaded from Wrkflow Library) does not have a Webhook URL.

To generate a webhook URL:

  • Expand Wrkflow card -> Click on “Generate URL” button beside Webhook. Once done, the system will generate a webhook URL for that particular Wrkflow:

  • Once generated, copy the URL and configure it in your system.

  • For a custom designed Wrkflow, you will see that option within the Wrkflow card on your Wrkflow Management page once you “Save” your designed Wrkflow.

Regenerate Webhook URL in Platform​

  • In the event of a security breach or for any reason you need to update the Webhook URL, you can do so by clicking on the “Regenerate” button within that Wrkflow card. This will replace the existing Webhook URL into a new URL.
  • After doing so, you will need to update any place where you may have configured it to your new Webhook URL in order for a successful launch of that Wrkflow using a Webhook.

Configuring Wrkflows to Work with Webhook​

For the Wrkflow to utilize and parse the required data from all the data being sent by the third-party system, your Wrkflow will need to be configured properly.

POST WebhookCreate a launch parameter with the name body using data type "text (long)". The launch parameter will receive the content posted by the third-party system and pass it to the Wrkflow. You can capture the method, headers, and params using the same method.

Watch this video that demonstrates the steps you can take to configure the Wrkflow to use the webhook feature.

Configuring a Wrkflow as a Sync Webhook​

If you want to configure your Wrkflow that that you can make an API call and get a response from your Wrkflow you can configure it as a Sync Webhook. To do this you will call the Wrkflow using the same webhook UUID and the below Endpoint. To specify the data that is returned from your Wrkflow you will use the "Respond to Wrkflow Sync API" Wrk Action. In this Wrk Action you can configure the Data and the headers that are returned as the webhook response.

Endpoint:

https://account.wrk.com/api/v1/webhook/{webhook\_uuid}/execute-sync

FAQ:​

Q: How will I determine which launch has happened from the Webhook on the launch details page?

A: Once the launch has happened, the launch name will be automatically generated and will have the launch type as API in the table.

Q: Will my Webhook URL change when I make structural changes to Wrkflow that already has a Webhook URL generated?

A: No. When you make structural changes to your Wrkflow with a generated Webhook URL and save the changes, the url gets transferred to the new version of Wrkflow. Hence, you do not need to generate/regenerate new urls.

Q. Will my Webhook URL get copied over when I clone an existing Wrkflow?

A. No. Webhook URLs are unique per Wrkflow, so you will have to generate a new Webhook URL for the cloned Wrkflow (i.e. Copy Wrkflow).

Q: How can I get help when needed on Webhook?

A: There are multiple ways you can get help on Webhook

  • Clicking on the info icon besides Webhook URL will take you to the help article page in the new tab.
  • Also, you can always reach out to us using the Intercom chat for any questions or help.