Skip to content

Webhooks

Andre edited this page Oct 15, 2022 · 35 revisions

Properties

Step properties related to webhooks:

  • EnableWebhook: Set this to true to make the step wait for a reply HTTP call.
  • WebhookId: This value uniquely identifies the webhook and is present in the webhook URL. This can be pre-set during the workflow editing phase or it can be omitted and Microflow will generate a webhook guid during runtime.
  • WebhookTimeoutSeconds: How long the webhook will wait for before timing out and continuing.
  • StopOnWebhookTimeout: When this is set to true then the entire workflow will stop if the webhook times out.
  • SubStepsToRunForWebhookTimeout: This indicates which steps to run if the webhook receives no reply within the timespan set by WebhookTimeoutSeconds. If this is not set, then the normal workflow defined child steps will run.
  • WebhookSubStepsMapping: This can be set to have a list of webhook actions that maps to other steps to run for the specific action.

API

Route Method Description
webhooks/{webhookId}{action?} GET,POST Reply URL of the webhook
  • {webhookId} : uniquely identifies the webhook and can be set before-, or be auto set during workflow runtime
  • {action?} : optional action associated with the webhook

Clone this wiki locally