Third Party Intergration
      Back to home
      1. US Knowledge base
      2. API
      3. Third Party Intergration

      How to Set Up a Webhook in a HubSpot Workflow to Create a Letter Using Stannp API

      This article explains how to configure a webhook in a HubSpot workflow to create a letter using the Stannp API.

      Prerequisites

      1. API Key: Obtain your Stannp API key from your Stannp account within settings > API settings section.
      2. API Endpoint: Use the following endpoint for the webhook:
        https://api-us1.stannp.com/v1/letters/create
      3. Plan Requirements: Webhooks are available on HubSpot’s Professional or Enterprise plans.
      4. Permissions: You must have Super Admin permissions or sufficient access to workflows.

      Steps to Create the Webhook

      Step 1: Create or Open a Workflow

      1. Log in to your HubSpot account.
      2. Navigate to Automation > Workflows in the top menu.
      3. Create a new workflow or open an existing one.
      4. Select the type of workflow (e.g., contact-based, deal-based) and set enrollment triggers as needed.
        Hubspot_integration_1-png

      Step 2: Add the Webhook Action

      1. Click the + button to add a new action in the workflow editor.
      2. Select Trigger a webhook.

      Hubspot_integration_2-png

      Step 3: Configure the Webhook URL

      1. Set the Method to POST.
      2. Enter the following URL in the URL field: 
        https://api-us1.stannp.com/v1/letters/create
      3. Configure Authentication type to API Key. This will require you to create a secret with your Stannp API key. You can find your Stannp API key on your Stannp account by going to the settings and looking at API settings. Give your Stannp API key secret a name and add the API key itself as the value. 
      4. Once you have selected your secret, within the configuration of the webhook, change your API key name to "api_key".
      5. Finally set the API key location to Query parameters.

      Step 4: Configure the Webhook Request Body

      To make a Stannp API request we require certain parameters to included within the request. These are added within this section. 

      First, Select Customize request body. There are two types of parameters. "Property" & "static value". 

      A Property, is a dynamic value. This is taken from Hubspot You would use this to add any recipient detail as you're taking this from your Hubspot database.

      A static value will stay consistent throughout each request. This is where you can add the test parameter or template when you want your design to stay consistent for every send. 

      Each of the following parameters can be added as either property or static value depending on whether you require them to be dynamic. 

      Example available parameters using Template:

      test: true
      template: 12345
      recipient__title: Mr.
      recipient__company: ABC Corp
      recipient__firstname: John
      recipient__lastname: Doe
      recipient__address1: 123 Main Street
      recipient__address2:
      recipient__city: New York
      recipient__postcode: 10001
      recipient__country: US
      tags: invoice,priority
      addons: FIRST_CLASS
      duplex: true
      clearzone: true
      post_unverified: false

      Example available parameters using File:

      test: false
      file: https://example.com/sample_document.pdf
      recipient__firstname: Jane
      recipient__lastname: Smith
      recipient__address1: 456 Elm Street
      recipient__city: Los Angeles
      recipient__postcode: 90001
      recipient__country: US
      tags: contract,premium
      duplex: false
      addons: FIRST_CLASS

      Step 5: Test the Webhook

      1. Click the Test button in the webhook configuration panel.
      2. Send a test request using sample data.
      3. Review the response from the Stannp API to confirm that the request was successful.

      Step 6: Save and Activate the Workflow

      1. Once you’ve configured and tested the webhook, click Save.
      2. Turn the workflow ON to start automating letter creation.

      Additional Notes

      • Error Handling: If the webhook fails, check the response error in the workflow log. Common issues include missing required parameters or incorrect formatting.
      • Testing Mode: Use the test parameter set to true for testing without actually sending a letter.
      • Dynamic Tokens: Use HubSpot tokens for personalized and dynamic content.

      By following these steps, you can automate letter creation with the Stannp API directly from HubSpot workflows. For further assistance, contact your administrator or the Stannp support team.