The Wait for Webhook step pauses a workflow until it receives a webhook request, making it ideal for processes that require external input before moving forward.
Imagine your workflow needs to integrate with an external system—such as a third-party application for identity verification. With Wait for Webhook, the workflow stops at this step until the external system sends a webhook response. Once received, the task resumes and takes action based on the provided data.
Examples
Identity Verification: Pause the workflow until a third-party service confirms a user's identity.
Payment Confirmation: Wait for a webhook from your payment provider to confirm a transaction before proceeding.
Order Fulfillment: Pause until your inventory system sends an update about stock availability.
Approval Processes: Hold the workflow until a third-party tool sends an approval or rejection status.
This feature ensures your workflows are seamless and synchronized with external systems, reducing manual intervention and keeping things efficient!
Add Wait for Webhook to a workflow
To add a Wait for Webhook step to your workflow:
Go to your relevant deploy step and open up the your workflow.
Then click Add step and select Wait for Webhook.
Select the Wait for Webhook block to configure it.
Set the workflow live.
Wait for Webhook best practices
Add a clear name to the step to make it easy to identify temporary variables created for the step.
Configure the Example request properly by including all the fields you expect to receive in the webhook callback within the data object.
Ensure the webhook returns a JSON body that matches the structure in the step. If the JSON structure is updated, no data will be received. Missing fields in the configuration will also make those fields inaccessible in the task.
Click the "Copy" button to copy the webhook URL to your clipboard. On the third-party site where the webhook is triggered, ensure the
conversationIdis passed as expected.
Note: The webhook endpoint supports idempotency to safely retry requests and prevent the same operation from being performed more than once. When sending a request, include an "Idempotency-Key" header with a unique value. We recommend using UUIDs. Idempotency keys expire after 24 hours.