Install the app
The app is installed via HubSpot's standard OAuth flow. No developer credentials or API keys on your side are required — authentication to your external APIs is configured per workflow step, not at install time.
- Find the app on the HubSpot App Marketplace.
- Click Install app on the listing page.
- You will be redirected to the King Henry authorisation page.
- Review the requested permissions and click Connect app.
- HubSpot will ask you to approve the scopes the app requires. Click Connect app on the HubSpot scope approval screen to grant access.
- After approving, you are redirected back to HubSpot. The app will appear in Settings → Integrations → Connected Apps
.webp?width=462&height=380&name=image%20(4).webp)
.webp?width=536&height=440&name=image%20(2).webp)
.webp?width=536&height=250&name=image%20(3).webp)
Connect your HubSpot account
The OAuth authorisation step above connects your HubSpot account. No additional connection steps are needed after install — the app is immediately ready for use in workflows.
The app requests the automation scope only. This scope allows the app to register and execute workflow actions on your behalf. It does not grant access to your contacts, deals, or any other HubSpot data objects.
One installation covers your whole portal. You only need to install and authorise the app once. All users in your HubSpot portal can immediately add Custom API Call actions to their workflows — no per-user setup is required.
Add the action to a workflow
Once installed, the Custom API Call action is available in every workflow, regardless of enrolled object type (contacts, companies, deals, tickets, custom objects).
- Go to Automation → Workflows and open an existing workflow, or create a new one.
- Click the + button to add a new action at the desired position in the workflow.
- In the action panel that opens, type Custom API in the search box — or scroll down to the Connected apps section.
- Click Custom API Call to open the configuration panel.
.webp?width=462&height=326&name=image%20(1).webp)
Configure the action fields
Once installed, the Custom API Call action is available in every workflow, regardless of enrolled object type (contacts, companies, deals, tickets, custom objects).
A label shown on the workflow canvas to identify this action. Use something descriptive, for example Notify Slack or Create lead in CRM. This name is displayed on the workflow card and in the enrolment history, making it easy to identify each step at a glance. It is not sent to the external API.
The full HTTPS URL of the endpoint to call. The URL must begin with https://. You can embed HubSpot workflow tokens to build a dynamic URL at runtime:
The HTTP method for the request. Choose one of:
- GET: retrieve data; no request body is sent
- POST: create a resource or trigger an action
- PUT: replace an existing resource
- PATCH: partially update an existing resource
- DELETE: remove a resource
Controls how the request is authenticated. Selecting a type reveals the relevant credential fields:
Option |
What it does |
Extra fields shown |
|---|---|---|
None |
No authentication header is added | None |
Bearer token |
Adds Authorization: Bearer <token> | Bearer token |
API key (header) |
Adds a custom header with your key | Header name, Header value |
Basic auth |
Adds HTTP Basic authentication | Username, Password |
A JSON object of key-value pairs appended to the URL as query string parameters. Example:
{
"format": "json",
"source": "hubspot"
}
A JSON object of additional HTTP headers to include in the request. Example:
{
"X-Custom-Header": "my-value",
"Content-Type": "application/json"
}
A JSON object sent as the request body. Used for POST, PUT, and PATCH requests. Embed HubSpot workflow tokens to include live record data at the time the workflow runs. Example:
{
"email": "",
"dealName": "{{deal.dealname}}",
"stage": "{{deal.dealstage}}"
}
The maximum number of seconds the action will wait for a response before failing. Defaults to 10 seconds. Maximum allowed value is 60 seconds. If the API does not respond within this time, the workflow step is marked as failed and the error_message output field will contain a timeout description.
Use output fields in subsequent steps
After the Custom API Call action runs, four output fields are available to reference in downstream workflow steps, such as If/then branches, Set property value actions, or additional API calls.
Output field |
Type |
Description |
|---|---|---|
| status_code | Number | The HTTP status code returned by the API, for example 200, 201, 400, 404, 500. |
| response_body | String | The full response body as a string. If the API returns JSON, this is the raw JSON string. |
| success | Boolean | True if the status code was in the 2xx range; false otherwise. |
| error_message | String | A description of the error if the request failed. Empty on success. |
Add an If/then branch immediately after the Custom API Call step. Set the condition to Custom API Call, success is equal to true to route enrolled records differently depending on whether the API call succeeded.
Add a Set property value action after the API call. Use the response_body output token as the value to store the API's response in a HubSpot contact or deal property for later reference or reporting.
Disconnect the app
Disconnecting the app revokes the OAuth authorisation token between your HubSpot portal and King Henry. After disconnecting, any workflow that runs a Custom API Call step will fail because the action can no longer be executed.
To disconnect:
- Go to Settings → Integrations → Connected Apps.
- Find Custom API Workflow Action in the list.
- Click Actions → Disconnect (or Uninstall, depending on your HubSpot version).
- Confirm the disconnection in the dialog that appears.
What happens to your data: Disconnecting does not delete any HubSpot properties, workflow configurations, or enrolment history. No data stored in HubSpot is removed. King Henry does not retain any of your HubSpot data after disconnection. The app proxies API requests in real time and stores nothing.
Uninstall the app
Uninstalling fully removes the app from your HubSpot portal, including the OAuth connection and the registered workflow action type.
To uninstall:
- Go to Settings → Integrations → Connected Apps.
- Find Custom API Workflow Action in the list.
- Click Actions → Uninstall.
- Read the confirmation message and click Uninstall to confirm.
Workflows using this action will stop executing that step. Any workflow containing a Custom API Call step will continue to run, but the Custom API Call step will be skipped or marked as failed after uninstallation. To restore full functionality, reinstall the app and reconnect via OAuth.
What happens to your data: Disconnecting does not delete any HubSpot properties, workflow configurations, or enrolment history. No data stored in HubSpot is removed. King Henry does not retain any of your HubSpot data after disconnection. The app proxies API requests in real time and stores nothing.
- No HubSpot contacts, companies, deals, or other records are deleted.
- No HubSpot properties are deleted.
- Existing workflow steps that referenced the Custom API Call action remain in the workflow editor but are marked as inactive.
- Workflow enrolment history is preserved and still visible in HubSpot.
- King Henry does not store any of your HubSpot data, so there is nothing on King Henry’s side to delete.
You can reinstall the app at any time from the HubSpot App Marketplace. After reinstalling, existing workflow steps that referenced the action will become active again without reconfiguration.
Stuck on a step? Reach out.
Email support@kinghenry.au with your portal ID, the workflow and step name, and the error message from the action history. We'll come back right away.
