Customize your webhooks (BETA)

If you're using webhooks in workflows to send POST or GET requests from your workflows, you can customize your webhooks to control the data sent and received.

In your POST requests, you can specify the properties sent to any external systems, such as a CRM. Similarly, in your GET requests, you can specify the properties requested through query parameters.  

Learn more about webhooks in the developers webhooks documentation. If you have questions about your specific implementation of webhooks with HubSpot, reach out on the HubSpot Developers Forums.

Please note: HubSpot will retry failed webhooks for up to three days, starting one minute after failure. Subsequent failures will be retried at increasing intervals, with a maximum gap of eight hours between tries. Learn about specific error code exceptions in HubSpot's developer documentation.

Set up your webhook

To create and customize your webhooks:

• In your HubSpot account, navigate to Automation > Workflows.
• Click the name of the workflow.
• Click the + icon to add an action.
• In the right panel, select Send a webhook.
• Click the Method dropdown menu, then select POST or GET. 
• Enter the webhook URL. Webhook URLs are restricted to a secure protocol and must begin with HTTPS. To request specific information,  you can add query parameters such as ?queryparameter=abc to the Webhook URL. If no query parameters have been added, a generic POST or GET request will be sent.  
• Set up your authentication type to authenticate requests to your webhook: 
  • To use a request signature in your webhook header: 
    • Click the Authentication type dropdown menu. Then, select Include request signature in header.
    • Then, enter your HubSpot App ID. Learn how to verify request signatures.

• • You can also use an API key for authentication. When using an API key for authentication, the API key name and API key location used are dependent on how the webhook is configured. For security reasons, the API key will not display in any test requests. To use an API key: 
    • Click the Authentication type dropdown menu. Then, select API key. 

• • • Enter your API key name.
    • Click the API key location dropdown menu. Then, select either Query parameters or Request header. Learn more about using API keys in HubSpot.
      
      

Customize your POST request

• To include all properties, under the Customize request body section, select Include all properties.  
• To include only specific properties: 
  
  • Under the Customize request body section, select Choose specific properties.
  • Click the Choose property dropdown menu. Then, click [object] in this workflow and select a property.
  • To change a property's name in the webhook, edit the Property name text field. This will only update the property name in the POST request, it will not update the property name or internal name in HubSpot.  
  • To add another property, click Add property.
  • To remove a property, click the delete trash can icon. 
       

Customize your GET requests

• Under the Query parameters section, click the Choose property dropdown menu. Then, click [object] in this workflow and select a property.
• To change a property's name in the query parameter, edit the Property name text field. This will only update the property name in the GET request, it will not update the property name or internal name in HubSpot.  

• To add another property, click Add query parameter.
• To remove a property, click the delete trash can icon.     
• Click Save.