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.
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.
   

Step 2: Add the Webhook Action

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

Step 3: Configure the Webhook

Method and URL

1. Set the Method to POST.
2. Enter the following URL in the URL field, replacing YOUR_API_KEY with your Stannp API key:

   https://api-us1.stannp.com/v1/letters/create?api_key=YOUR_API_KEY

Body

Construct the request body. First you must select customise request body, this will allow you to enter keys. Each of these keys will should match the parameters shown below. Depending on your use case, include either the template or, the file parameter.

Example Body with 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 Body with File Parameter:

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 4: Customize with HubSpot Tokens

• To make the request dynamic, replace static values in the body with HubSpot property tokens. For example:

  • Replace the property of recipient.firstname with Contact: First Name by clicking Insert token.
    

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.