Articles on: Workflow Premium Triggers and Actions

Premium Triggers and Actions: Custom Webhook

In this article, you will learn how to use the Custom Webhook Premium Action. This feature enables the exchange of real-time data between HUXLEY and a third-party service. It can be useful for businesses and individuals in marketing, developers, and IT professionals.



What is the Custom Webhook Premium Workflow Action?


The Custom Webhook - Premium Action is a powerful and flexible feature that enables real-time communication between HUXLEY and third-party services. It allows you to configure and send custom data requests to specified URLs using different HTTP and authorization methods. This feature also supports adding headers, query parameters, and mapping custom values to create a tailored request structure that meets your needs. With autocomplete suggestions and user-friendly interfaces, the Custom Webhook streamlines data exchange and ensures accuracy in your workflows. However, it is crucial to consider API response success and server limitations when using this feature to prevent errors and disruptions in workflow execution.


Benefits:


  • Seamless integration: Enables accessible communication between your CRM system and third-party services, improving data exchange and overall efficiency.
  • Flexibility: Supports various HTTP methods, authorization methods, headers, and query parameters, allowing you to create custom requests that suit your needs.
  • Time-saving: The user-friendly interface with autocomplete suggestions simplifies the data mapping and reduces manual effort.
  • Improved accuracy: Helps ensure data consistency and accuracy across different platforms, reducing errors and inconsistencies.
  • Real-time updates: Facilitates real-time notifications and updates, enhancing responsiveness and decision-making.
  • Workflow automation: Streamlines workflows by automating system data exchange, increasing productivity, and reducing manual tasks.
  • Scalability: Adaptable to various applications and industries, making it a valuable tool for businesses of different sizes and sectors.


Note: When using this feature, it is crucial to consider API response success and server limitations to prevent errors and disruptions in workflow execution.


Step 1: Create your Workflow


  • Go to Automation - Workflows
  • Click on Create New Workflow - Start From Scratch or click on the three dots next to a Workflow to edit an existing workflow



  • Select your trigger
  • Add the Custom Webhook action



Step 2: Fill URL


  • You can send data requests to any URL of your choice without the need for coding or server operation.



Step 3: Select a Method


  • You can choose any HTTP method that suits your needs, such as POST, GET, DELETE, or PUT



Step 4: Select Authorization Method


  • We support various types, allowing you to choose the one that suits your needs when accessing the webhook.



Oauth2 in Custom Webhook


****


HUXLEY also provides OAuth2 as an authorization option in the Custom Webhook action. OAuth2 allows users to securely integrate with a wide range of APIs, such as Google, Facebook, and LinkedIn.


How it works


  • Select OAuth2 in the Custom Webhook action as the authorization method.
  • Choose an existing token or request a new one.




  • To manage tokens, navigate to "Global Workflow Settings" and locate the "Manage Tokens" section. Clicking on "Manage Tokens" will open a new pop-up window displaying a list of all tokens. From this screen, you can update or delete tokens as needed.





Step 5: Headers & Query Parameters:


  • In addition to sending a request body, our system allows you to include headers and query parameters when sending requests to a webhook.
  • Headers can be used to provide additional information about the request, such as authentication credentials, content type, and cache control.
  • Query parameters, conversely, can be used to pass parameters to the webhook endpoint, allowing you to filter or modify the response data you receive.



Step 6: Content-Type:


Implemented a variable body entry system to support both JSON and x-www-form-urlencoded data formats, enhancing flexibility and functionality.



Step 7: Configure the data to be sent in the Custom Webhook


  • The Custom Webhook premium feature allows you to map custom values in any structure that suits your requirements. Our user-friendly textbox provides autocomplete suggestions for all custom values, including inbound webhook variables.
  • This feature simplifies the mapping process and saves time by suggesting potential values that match your input. Additionally, it helps ensure accuracy and consistency in your data mapping.



Step 8: Save the Response From the Custom Webhook


Save the response from the custom webhook and use it in custom variables


  • Enable "Save response from this Webhook"




  • Select a contact and send a test request


The test request response should have a valid success status(200) to proceed further and save the action.




By completing the above steps, you can now use the headers, status and response that you have received from Custom Webhook as custom values in email, sms, if/else, etc.



Notes:


  • Successful execution of the Custom Webhook Action depends on the successful response of the referenced API. Therefore, if errors are sent back, those will reflect on the Contact's Workflow execution and cause the action to fail (and then skipped) or Retry with exponential backoffs.


  • In addition to what was stated above, make sure that the receiving server can handle the number of Executions that you are targeting, or else you might end up with errors due to limits being reached for server issues. The Custom Webhook Action will get fired as soon as the Contact reaches the step, so make sure to add Contacts into the Workflow with the receiving server's limits in mind.


  • If you are enabling save response, the test request response should have a valid success status(200) to proceed further and save the action.


FAQ


1. What types of HTTP methods can I use with the Custom Webhook Premium Action?****You can use various HTTP methods, including POST, GET, DELETE, and PUT, depending on your needs for data requests.


2. How do I include headers and query parameters in my webhook request?****You can add headers and query parameters in the Custom Webhook action settings. Headers provide additional information like authentication credentials, while query parameters allow you to pass specific data to the webhook endpoint.


3. What should I do if the Custom Webhook action fails?****If the Custom Webhook action fails, it could be due to an unsuccessful API response or server limitations. Check the response status and ensure the receiving server can handle the volume of requests. The action may retry with exponential backoffs if errors occur.


4. How can I ensure that my webhook request is configured correctly before going live?****Use the "Send Test Request" feature to verify that your webhook request is set up correctly. Ensure the test request receives a valid success status (200) before saving and using the action in your workflow.


5. How can I select OAuth2 as an authorization method in my workflow?


You can select OAuth2 as an authorization option by going to the Custom Webhook action in your workflow. Once selected, you can either use an existing token or request a new one to connect with external APIs.


6. How do I manage my OAuth2 tokens?


To manage OAuth2 tokens, navigate to the "Global Workflow Settings" and select "Manage Tokens." From there, you can update or delete tokens as needed. This ensures you have control over your API integrations and token management.

Updated on: 21/11/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!