How to Use the URL Field in Webhook Block | Bot Builder

URL Field in Webhook Block


Where it knows to go!
You’ll need to enter the exact REST API endpoint of the third-party app you want to interact with in the URL field; whether you’re sending data, fetching it, updating something, or deleting it. Think of this field as the destination address for your webhook request.  


Learn more about webhooks: Introduction to Webhook Block in GC 

Enter the correct URL

If the URL is incorrect, the webhook can’t deliver your data, just like a letter with the wrong address. So double-check the API documentation of the service you’re integrating with, and make sure:
  1. The endpoint is accurate
  2. The base domain is secure (https://)
  3. Any dynamic parameters (like /customer/{id}) are correctly replaced with actual values in your flow
 
You can also insert variables inside the URL.

For example, if the target organization ID, customer ID, or any query parameter depends on user input, you can use dynamic variables (written as @user.input, @org.id, etc.) right in the URL. This makes the request more flexible and personalized.
 

Example
Example
Let’s say you want to fetch subscription info for a customer from your billing system. The API provided by your billing platform might look something like this:

https://api.billingplatform.com/v1/subscriptions?email=jane@example.com

In this example:
  1. https://api.billingplatform.com is the domain of the third-party app
  2. /v1/subscriptions is the resource you’re accessing
  3. ?email=jane@example.com is the query parameter that filters the result based on the user’s email
 Make sure you have permission to access the URL and that your authentication, set under Connections, is correctly configured. 
 Learn more about webhooks: Introduction to Webhook Block in GC